Navis N4
EDI, Billing, and Services
Management
Administrator and User Guide
3.8.6
CONFIDENTIAL INFORMATION OF Navis LLC
UNAUTHORIZED USE IS STRICTLY PROHIBITED.
N4 is a trademark of Navis LLC.
© Navis LLC 1988 - 2020. 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 EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.1 EDI Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.1 Using EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.1.1.1 Setting up EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1.1.2 Creating EDI Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.1.1.3 Reviewing the EDI Interchange and Posting the EDI Batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.1.1.4 Initiating EDI Batch Posting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
1.1.1.5 Reviewing the EDI Batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.2 How EDI works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.2.1 Supported Message Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
1.2.2 What is an EDI interchange and segment?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.2.3 What is an EDI batch?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.2.4 What is an EDI transaction?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.2.5 EDI processes in more detail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.2.5.1 Inbound EDI processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
1.2.5.2 Outbound EDI processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.3 Setting up EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.3.1 How to set up EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
1.3.1.1 Setting up supported EDI message types and message maps. . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.3.1.2 Adding a new EDI message type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.3.1.3 Creating and importing a message map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.3.1.4 Adding a trading partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.3.1.5 Adding a mailbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
47
1.3.1.6 Adding an EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.3.2 Posting Rules: Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
1.3.2.1 Define a posting rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.3.2.2 Define the General Rule for a class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
1.3.2.3 How do the posting rules work?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
1.3.3 Scheduling an EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
1.3.4 Configure EDI for US Customs Holds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
1.3.4.1 Configure Customs holds for a BL through EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
1.3.4.2 Configuring a default hold for a BL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
1.3.4.3 Configuring Map Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
1.4 EDI Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
1.4.1 EDI Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
1.4.2 XPS Privileges for EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
1.4.2.1 BAPISO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
98
3
Contents
1.4.2.2 EDIMEN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
1.4.2.3 MOVSTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
1.4.3 XPS Settings for EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
1.4.3.1 EDFHST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
1.4.3.2 STIFEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
1.4.3.3 COATRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
1.4.4 EDI Message Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
ARGOACTIVITY006 (EXTRACT_ACTIVITY_FORMAT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ARGOEDI001 (AUTO_CREATION_OF_COMMODITY_CODE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ARGOEDI002 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_VALUE). . . . . . . . . . . . . . . . . . . . . . . . . 103
ARGOEDI003 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_LINE). . . . . . . . . . . . . . . . . . . . . . . . . .
103
ARGOEDI004 (EDI_INBOUND_TRANSACTION_SIZE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
ARGOEDI005 (USE_FILE_NAME_FOR_SORTING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
104
ARGOEDI006 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_REGEX). . . . . . . . . . . . . . . . . . . . . . . . 104
ARGOEDI007 (EDI_FACILITY_FOR_POSTING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
105
ARGOEDI008 (EDI_POST_NUM_PARALLEL_JOBS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
105
ARGOEDI009 (EDI_EXTRACT_END_TIME_LATENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
107
ARGOEDI010 (EDI_EXTRACT_TRANSACTIONS_ENABLE_FOR_EXPORTER). . . . . . . . . . . . . . . . . 107
ARGOEDI011 (EDI_MANIFEST_BILLOFLADING_DETACH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ARGOEDI012 (EDI_STOWPLAN_REPLACE_CONTAINERS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ARGOEDI013 (EDI_ADHOC_VESSEL_CREATION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
ARGOEDI014 (EDI_ADHOC_ITINERARY_CREATION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
109
ARGOEDI015 (EDI_VESSEL_ID_CONVENTION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
ARGOEDI016 (EDI_UNIQUE_VESSEL_VISIT_ID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
110
ARGOEDI017 (EDI_VERMAS_IDENTIFY_UNITS_BY_CATEGORY). . . . . . . . . . . . . . . . . . . . . . . . . . . 110
ARGOEDI020 (EDI_OVERRIDE_CARRIER_ITINERARY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
111
ARGOEDI_EXTRACT001 (EXTRACT_NEW_LINE_WITH_CARRIAGE_RETURN). . . . . . . . . . . . . . . . 111
ARGOLINE_LOAD_DISCHARGE_LIST001 (EDI_STAGING_LOADLIST). . . . . . . . . . . . . . . . . . . . . . .
111
ARGOLINE_LOAD_DISCHARGE_LIST002 (EDI_STAGING_DISCHARGELIST). . . . . . . . . . . . . . . . . . 111
ARGOLINE_LOAD_DISCHARGE_LIST007 (EDI_LINELOAD_DISCHARGE_LIST). . . . . . . . . . . . . . .
112
ARGOMANIFEST011 (MFT_REEVALUATE_TERMINAL_HOLD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
ARGOMANIFEST012 (MFT_GENERAL_CARGOLOT_AGAINST_VESSEL). . . . . . . . . . . . . . . . . . . . . 112
ARGOPREADVISE006 (CANCEL_PREADVISE_NOT_RETIRE_UNIT). . . . . . . . . . . . . . . . . . . . . . . . . 112
ARGOSAUDILDP001 (SAUDI_LOAD_PERMIT_PERMISSION). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
ARGOEDI024 (CARRIER_SERVICE_VISIBLE_XPS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
EDIEMAIL001 (EMAIL_FROM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
EDIEMAIL002 (EMAIL_REPLY_TO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
EDIFTP001 (FTP_DEFAULT_TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
EDIFTP002 (FTP_READ_WRITE_TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
EDISFTP001 (SFTP_READ_WRITE_TIMEOUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
MSEMAIL_SERVER_CONFIG001 (HOST). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
MSEMAIL_SERVER_CONFIG002 (PORT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
4
Contents
MSEMAIL_SERVER_CONFIG003 (PROTOCOL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
MSEMAIL_SERVER_CONFIG004 (DEFAULT_EMAIL_ATTACHMENT_CONTENT_TYPE). . . . . . . . .
115
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
MSEMAIL_SERVER_CONFIG005 (SMTPS_USER). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
ARGOEDI023 (CREATE_EQUIPMENT_OBS_STATUS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
MSEMAIL_SERVER_CONFIG006 (SMTPS_PASSWORD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
MSEMAIL_SERVER_CONFIG007 (TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
ARGOEDI026 (USE_VESSEL_LINE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
ARGOMANIFEST013 (DELETE_MANIFEST_UPDATE_UNIT_CV). . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
ARGOEDI025 (CHECK_EQUIPMENTTYPE_EQUIVALENT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
ARGOEDI028 (MFT_VESSEL_VISIT_PHASE_WORKING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
1.4.5 EDI Session Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.4.5.1 ACKNOWLEDGEMENT EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
1.4.5.2 APPOINTMENT EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
1.4.5.3 DISCHLIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
1.4.5.4 Inbound INVENTORY UPDATES EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Inbound BOOKING EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Inbound HAZARD EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Inbound MANIFEST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Inbound PREADVISE EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Inbound RAILWAYBILL EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
133
Inbound STOWPLAN EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
1.4.5.5 Outbound STOWPLAN EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
138
1.4.5.6 LOADLIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
1.4.5.7 Outbound ACTIVITY EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
142
1.4.5.8 Outbound VESSELACTIVITY EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
144
1.4.5.9 RAILCONSIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
1.4.5.10 RAILORDER EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
145
1.4.5.11 RELEASE EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
1.5 Using EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
147
1.5.1 EDI Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
1.5.2 Manually extracting an outbound EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
1.5.3 Manually loading an inbound EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
1.5.4 Manually posting the EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
1.5.5 Monitoring EDI processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
1.5.5.1 Reviewing the EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
152
1.5.5.2 Reviewing the EDI interchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
154
1.5.5.3 Reviewing EDI errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
1.5.5.4 View EDI exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
1.5.6 Cancelling an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
5
Contents
1.5.7 Correcting EDI errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
1.5.7.1 Editing an EDI segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
1.5.7.2 Editing an EDI message map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
1.5.7.3 Editing an EDI filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
1.5.7.4 Editing and reposting EDI transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
1.5.7.5 Editing the carrier visit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
159
1.5.7.6 Correcting common EDI errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
1.5.8 Remapping an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
1.5.9 Remapping an EDI interchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
1.5.10 Reposting an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
1.5.11 Re-extracting an ACTIVITY EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
1.5.12 Generate unit level discrepancy reports using I/B or O/B Carrier Visit as a filter criteria. . . . . . . . . . 168
1.6 Using EDI UI Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
1.6.1 Interchanges view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
1.6.1.1 EDI Interchange form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
1.6.2 Batches view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
1.6.2.1 Batch Notes form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
1.6.2.2 EDI Batch Inspector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
1.6.2.3 EDI Batch form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
1.6.3 Transactions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
1.6.4 EDI History view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
1.6.4.1 EDI Event form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
1.6.5 EDI Sessions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
1.6.5.1 EDI Session form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
1.6.6 EDI Mailboxes view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
1.6.6.1 EDI Mailbox form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
202
1.6.7 Trading Partners view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
204
1.6.8 EDI Configuration view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
1.6.8.1 EDI Trading Partner form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
1.6.9 Message Types view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
1.6.9.1 Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
208
1.6.9.2 Recover Obsolete or Inactive records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
208
1.6.9.3 EDI Message Type form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
1.6.10 Filters view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
1.6.10.1 EDI Filter form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
1.6.11 EDI Load form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
225
1.6.12 EDI Jobs view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
227
1.6.12.1 EDI Job form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
1.6.13 EDI Errors view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
6
Contents
1.7 Troubleshooting EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
1.7.1 An inbound EDI batch does not exist in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
243
1.7.2 An EDI batch has an UNKNOWN status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
1.7.3 Transshipment records are being retired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
244
1.7.4 COPARN updates IB and OB Carrier of THROUGH Containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
1.7.5 COPRAR DISCHARGE EDI does not create units if the vessel is departed. . . . . . . . . . . . . . . . . . . . 245
1.7.6 Your trading partner did not receive an outbound EDI file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
245
1.7.7 Error "BL Nbr XXX already exists for the Line XXX" when importing EDI discharge list. . . . . . . . . . . . 246
1.7.8 Upload multiple transactions in one EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
1.7.9 N4 is unable to read EDI file, stops at mapping stage with no errors. . . . . . . . . . . . . . . . . . . . . . . . . . 246
1.7.10 N4 only posts import and transshipment containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
1.7.11 How to remove a job group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
1.7.12 Missing Segments after generating Outbound EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
1.7.13 User can edit the EDI session in the EDI Sessions form without the EDI_MANAGEMENT privilege 247
1.7.14 COPARN Replace message - Incorrect final booking quantity and units associated with different
booking items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
1.7.15 Warning message is displayed on extracting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
1.7.16 Missing Segments after generating Outbound EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
1.7.17 Second UFV created after posting the Loadlist/Dischlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
1.7.18 Posting rules for O/B Carrier not considered for Stowplan EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
248
1.7.19 N4 purge job takes six seconds to locate the unit record to be deleted. . . . . . . . . . . . . . . . . . . . . . . 249
1.7.20 N4 does not evaluate the posting rules to apply or ignore carrier details . . . . . . . . . . . . . . . . . . . . .
249
1.7.21 DischargeList EDI with different POD updates category from Import to Transshipment. . . . . . . . . .
249
1.7.22 Bento server displays 'Job has multiple triggers' error message. . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
1.7.23 EDI batch is sent with error status although the EDI file is sent and archived correctly. . . . . . . . . . . 250
1.8 EDI How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
1.8.1 Set whether a BL is updated or created to match a manifested quantity. . . . . . . . . . . . . . . . . . . . . . . 252
1.8.2 Determine whether N4 updates or creates a new unit when a load list is posted for an existing transship
or export container. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
1.8.3 Post a disposition code as "Information Only". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
1.8.4 Set the facility ID for validation when posting EDI messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
1.8.5 Update a unit’s group code with the value received in the Discharge List EDI. . . . . . . . . . . . . . . . . . . 253
1.8.6 Manually load an EDI message file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
1.8.7 Initiate EDI batch posting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
1.8.8 View EDI exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
1.8.9 Process a BOOKING EDI message that does not have vessel information. . . . . . . . . . . . . . . . . . . . . 254
1.8.10 Add the Marine Pollutant (MP) placard to hazards in an EDI file. . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
1.8.11 Configure EDI to apply a hold multiple times for the same reference ID. . . . . . . . . . . . . . . . . . . . . . . 255
1.8.12 Handle FTX and Hazardous Free Text Segments in built-in BAPLIE file. . . . . . . . . . . . . . . . . . . . . . 256
1.8.13 Determine the line operator for a vessel visit created as a result of an IFTSAI message. . . . . . . . .
256
1.8.14 Difference between ARGOEDI025 and ARGOEDI018. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
1.8.15 Determine whether N4 must update the existing unit's inbound visit as GEN_VESSEL on posting the
Delete message for the 310 Manifest EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
7
Contents
1.8.16 Validate the container weight with the Gross Weight and the VGM Weight. . . . . . . . . . . . . . . . . . . . 257
1.8.17 Determine whether to record the discrepancies for the units posted in the BAPLIE message and
missed in the COPRAR Load list or Discharge list file.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
1.8.18 Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on
extracting the Activity EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
1.9 EDI Message Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
1.9.1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
268
1.9.2 Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
1.9.3 EDI Message Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
1.9.3.1 EDI Inbound BAPLIE Message - BAPLIE 3.1.1 D.13B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
1.9.3.2 EDI Inbound Booking Message - COPARN D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
1.9.3.3 EDI Inbound Booking Message - IFTMBC D 98B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
1.9.3.4 EDI Inbound Booking Message - IFTMCS D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
1.9.3.5 EDI Inbound Cargo Release Message - ANSI 350 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
1.9.3.6 EDI Inbound Container Release Order Message - COREOR D 95B. . . . . . . . . . . . . . . . . . . . . . 293
1.9.3.7 EDI Inbound Customs Cargo Report Message - CUSCAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . 299
1.9.3.8 EDI Inbound Customs Response Message - CUSRES D 96B. . . . . . . . . . . . . . . . . . . . . . . . . . . 304
1.9.3.9 EDI Inbound Discharge List Message - COPRAR D 95A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
1.9.3.10 EDI Inbound LoadList Message - COPRAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
1.9.3.11 EDI Inbound Pre-advise Message - COPINO D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
1.9.3.12 EDI Inbound Rail consist Message - ANSI 418 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
330
1.9.3.13 EDI Inbound Rail Waybill Message - ANSI 417 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
1.9.3.14 EDI Inbound Saudi Load Permit Order Message - SAUDILDP 30. . . . . . . . . . . . . . . . . . . . . . . 347
1.9.3.15 EDI Inbound Saudi Manifest Message - SAUDIMANIFEST30. . . . . . . . . . . . . . . . . . . . . . . . . . 353
1.9.3.16 EDI Inbound Verified Gross Mass Message - VERMAS D.16A. . . . . . . . . . . . . . . . . . . . . . . . . 361
1.9.3.17 EDI Inbound Vessel Schedule Message - IFTSAI D.00B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
1.9.3.18 EDI Outbound Container Discharge/Loading Report Message - COARRI D 95B. . . . . . . . . . . 379
1.9.3.19 EDI Outbound Container Gate-In/Gate-Out Report Message - EDIFACT CODECO D 95B. . . 387
1.9.3.20 EDI Outbound Invoice Message - ANSI 810. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
395
1.9.3.21 EDI Outbound Invoice Message - EDIFACT INVOIC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
1.9.3.22 EDI Outbound LoadList Message - COPRAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
1.9.3.23 EDI Outbound Message - BAPLIE 3.1.1 D.13B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
1.9.3.24 EDI Outbound Rail Consist Message - ANSI 418 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
1.9.3.25 EDI Outbound Terminal Performance Report Message - EDIFACT TPFREP 30 00B. . . . . . . . 434
1.9.3.26 EDI Inbound Inventory Update Message - COHAOR D 04B. . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Part 2 Services Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
2.1 Services Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
453
2.1.1 Setting up Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
2.1.1.1 Adding Event Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
2.1.1.2 Adding Auto Update Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
2.1.1.3 Adding Service Business Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
8
Contents
2.2 Service Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
459
2.2.1 Event Types view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
2.2.1.1 Event Type form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.2.2 Record Service Event form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
2.2.3 N4 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
2.2.3.1 Yard events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
2.2.3.2 Rail Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
2.2.3.3 Road events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
2.2.3.4 Cargo Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.2.3.5 Booking and Booking Item Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.2.3.6 Unit Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
2.2.3.7 Vessel Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
2.2.3.8 EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
2.3 Hold Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
2.3.1 Holds/Permissions Groups view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
487
2.3.1.1 Hold/Permission Groups form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
2.3.2 Holds/Permissions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
2.3.2.1 Hold/Permission Type form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.3.2.2 Determine when to use a permission versus a hold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
2.3.2.3 Payment Holds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
2.3.2.4 Update Hold/Permission form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
2.3.2.5 Add filter criteria to holds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
498
2.3.2.6 Create covert holds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
2.3.2.7 Mark a container with stop signs for manual fetch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
2.3.3 Hold/Release Inbound Unit form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
2.3.4 Service Business Rules view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
2.3.4.1 Service Business Rule form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
2.3.5 Auto Update Rules view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
2.3.5.1 Auto Update Rule form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
2.3.6 Hold Settings in XPS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.3.6.1 OVRCMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.3.6.2 MANMRF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.3.6.3 OVRVST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
2.3.6.4 OVRSTP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
2.4 Service Orders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
512
2.4.1 Maintaining Service Orders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
2.4.2 Vessel Visit Service Orders view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
2.4.2.1 Vessel Visit Service Order form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
2.4.2.2 Carrier Visit Service Order Inspector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
2.4.3 Train Visit Service Orders view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
2.4.3.1 Train Visit Service Order form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
9
Contents
2.5 Related Terminal Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
2.5.1 Related Terminal Services view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
2.5.2 Related Terminal Services form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
2.6 Services Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
2.6.1 Services Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
525
INVSERVICESFLAGS001 (UNIT_FLAG_1). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
INVSERVICESFLAGS002 (UNIT_FLAG_2). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
INVSERVICESFLAGS003 (UNIT_FLAG_3). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
INVSERVICESFLAGS004 (UNIT_FLAG_4). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.6.2 Services Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.7 Services How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
2.7.1 Delete move history from Move History view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
2.7.2 Add or edit an event type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
2.7.3 Add or edit an effect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
2.7.4 Add a Related Terminal Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Part 3 Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
3.1 Billing in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
538
3.1.1 Billing Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
3.1.1.1 Calendar view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
3.1.1.2 Charge retroactively for STORAGE and REEFER events if the Last Free Day has passed. . . . . 543
3.1.1.3 Trigger purging for CUEs that are not billable or invoiced. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
3.1.1.4 Override the configured free days for a line operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
546
3.1.1.5 Chargeable Unit Events view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
3.1.1.6 Chargeable Marine Events view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
3.1.1.7 Chargeable Appointment Events view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
3.1.1.8 Guarantees view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
3.1.1.9 Storage Rule Types view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
3.1.2 Billing Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
3.1.2.1 Billing Settings in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
3.1.2.2 Billing Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
3.1.3 Billing Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
3.1.3.1 Billable events are deleted after being invoiced. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
629
3.1.4 Troubleshooting N4 Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
630
3.1.4.1 N4 Billing skips the invoice final number in random basis resulting in audit issues. . . . . . . . . . . . 631
3.1.4.2 Invoiced CUEs are moved to N4 Billing but are not deleted from N4. . . . . . . . . . . . . . . . . . . . . . 631
3.1.4.3 Prevent updates to the records in the Chargeable Unit Events view. . . . . . . . . . . . . . . . . . . . . . . 631
3.1.4.4 2.The Chargeable Unit Event records are not updated in N4 and N4 Billing for partial invoice. .
632
3.1.4.5 Unable to generate storage invoice in N4 Billing due to webservice connection error. . . . . . . . . 633
3.1.4.6 Invoice created using the generate-invoice-request API for multiple cargo lots, does not consider all
the cargo lots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
10
Contents
3.2 N4 Billing Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Overview and Basics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
3.2.0.1 Process Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
3.2.0.2 Navis N4 Billing How do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
642
Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
3.2.0.1 File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
3.2.0.2 Invoice Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
684
3.2.0.3 Payment Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
3.2.0.4 Credit Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
719
3.2.0.5 Reports Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
3.2.0.6 Events Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
3.2.0.1 Security Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
3.2.0.2 Archive Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
3.2.0.3 EDI Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
3.2.0.4 Customization Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
3.2.0.5 System Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
3.2.0.6 DBA Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
999
3.2.0.7 Settings Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
3.2.0.8 Debug Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
3.2.0.1 Billing Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1100
3.2.0.2 Equipment Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
3.2.0.3 Routing Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
3.2.0.4 Cargo Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
3.2.0.5 Organizations Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
3.2.0.6 Reports Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
3.2.0.7 Other Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
11
Part 1
EDI
In this Section:
EDI Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
How EDI works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Setting up EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
EDI Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Using EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Using EDI UI Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Troubleshooting EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
EDI How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
EDI Message Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
12
1.1 EDI Process Flows
This section contains the following process flows:
In This Section
Using EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
13
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1 Using EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
14
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1.1 Setting up EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
15
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1.2 Creating EDI Session
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
16
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1.3 Reviewing the EDI Interchange and Posting the EDI
Batch
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
17
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1.4 Initiating EDI Batch Posting
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
18
Part 1: EDI
EDI Process Flows
Using EDI
1.1.1.5 Reviewing the EDI Batch
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
19
Part 1: EDI
EDI Process Flows
Using EDI
Troubleshooting EDI Batch
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
20
Part 1: EDI
EDI Process Flows
Using EDI
Extracting EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
21
1.2 How EDI works
An EDI file is a file containing data that is formatted by following an EDI standard. EDI files can be read into or
extracted from a database. Trading partners can send you EDI files to automate the transfer of data, such as bookings,
bills of ladings, vessel load lists, and customs releases or holds. In addition, you can also send EDI to your trading
partners with information about your operations, such as container activity. The EDI message type determines the type
of data in the EDI message. For a list of message types that N4 supports, see Supported Message Types (on page
23), Supported Message Types (on page 211).
N4 processes both inbound and outbound EDI.
The inbound EDI process has the following steps:
• Transformation: N4 uses a transformation map to transform incoming EDI messages of various standards and
formats to a N4 XML based standard defined by Navis.
• Filtering: N4 uses an EDI filter to update specified attributes, such as a port or ISO code, from the value in an
inbound EDI file to a value used by your terminal in N4.
• Post: N4 posts the translated EDI messages into the database as the business entities for which the inbound EDI
messages represent, such as stow plan entries, holds and releases, bookings, and bills of ladings. In addition, N4
ignores specific attributes based on posting rules that you define. This enables you to ignore data that is no longer
relevant or simply incorrect.
The outbound EDI process has the following steps:
• Extract: N4 extracts the business entities from the database for which the outbound messages represent, such as
stow plan entries or service events for activity messages. In the case of activity messages, N4 first extracts events
that occurred between the last extract time and the current time and then filters that data based on the EDI session's
filter criteria.
• Filtering: N4 uses an EDI filter to update specified attributes, such as a port or ISO code, from the value in N4 to a
value used by your trading partners.
• Transformation: N4 uses a transformation map to create outgoing EDI messages from the N4 XML based standard
to the specific type of outbound message.
The Transformation process uses a transformation map or mapping file to convert EDI Interchange data to XML data
and vice versa, depending on the direction (inbound or outbound). N4 provides standard mapping files that you can
customize to your needs.
The Filtering process uses EDI filters that you can configure in N4. For inbound EDI, N4 uses the EDI filter to update
the XML data before saving it in the database. For outbound EDI, N4 uses the EDI filter to update the data from the
database to XML data before mapping it in the Transformation process.
In This Section
Supported Message Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is an EDI interchange and segment?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is an EDI batch?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is an EDI transaction?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI processes in more detail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
23
26
27
27
27
22
Part 1: EDI
How EDI works
Supported Message Types
1.2.1 Supported Message Types
The following table lists the version and release numbers of message types supported by the standard set of mapping
files and data dictionary files provided by Navis:
ID
Description
Class
Standard
Version
Release
Number
Responsible
Agency
301
Inbound 301
message
BOOKING
X.12
00
4020
American
National
Standards
Institute
309
Inbound 309
message
MANIFEST
X.12
00
4020
American
National
Standards
Institute
310
Inbound 310
message
MANIFEST
X.12
00
4020
American
National
Standards
Institute
322
Outbound 322
message
ACTIVITY
X.12
00
4010
American
National
Standards
Institute
322
Outbound 322
message
ACTIVITY
X.12
00
4020
American
National
Standards
Institute
323
Outbound 323
message
VESSELACTIVITY
X.12
00
4020
American
National
Standards
Institute
323
Outbound 323
message
VESSELACTIVITY BY
CARRIER
X.12
00
4020
American
National
Standards
Institute
417
Inbound 417
message
RAILWAYBILL
X.12
00
4020
American
National
Standards
Institute
418
Inbound 418
message
RAILCONSIST
X.12
00
4010
American
National
Standards
Institute
418
Outbound 418
message
RAILCONSIST
X.12
00
4010
American
National
Standards
Institute
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
23
Part 1: EDI
ID
How EDI works
Supported Message Types
Description
Class
Standard
Version
Release
Number
Responsible
Agency
418
Inbound 418
message
RAILCONSIST
X.12
00
4020
American
National
Standards
Institute
418
Outbound 418
message
RAILCONSIST
X.12
00
4020
American
National
Standards
Institute
APERAK
Outbound
APERAK
message
ACKNOWLEDGEMENT
EDIFACT
D
96B
United Nations
APERAK
Inbound
APERAK
message
ACKNOWLEDGEMENT
EDIFACT
D
96B
United Nations
BAPLIE
BAPLIE
message
version 1.5
STOWPLAN
EDIFACT
1.5
95B
United Nations
BAPLIE
BAPLIE
message
version 1.5
STOWPLAN
EDIFACT
1.5
91.1
United Nations
BAPLIE
BAPLIE
message
version 2.0
STOWPLAN
EDIFACT
2.0
95B
United Nations
BAPLIE
BAPLIE
message
version 2.2
STOWPLAN
EDIFACT
2.2
95B
United Nations
COARRI
Outbound
COARRI
message
ACTIVITY
EDIFACT
D
95B
United Nations
COARRI
Outbound
COARRI
message
version 1.6
ACTIVITY
EDIFACT
D
95B
United Nations
CODECO
Inbound
CODECO
message
ACTIVITY
EDIFACT
D
00A
United Nations
CODECO
Inbound
CODECO
message
version 1.6
ACTIVITY
EDIFACT
D
95B
United Nations
COHAOR
Inbound
COHAOR
message
INVENTORY UPDATES
EDIFACT
D
04B
United Nations
COPARN
Inbound
COPARN
message
BOOKING
EDIFACT
D
00B
United Nations
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
24
Part 1: EDI
ID
How EDI works
Supported Message Types
Description
Class
Standard
Version
Release
Number
Responsible
Agency
COPARN
Inbound
COPARN
message
BOOKING
EDIFACT
D
95B
United Nations
COPINO
Inbound
COPINO
message
APPOINTMENT
EDIFACT
D
95A
United Nations
COPINO
Inbound
COPINO
message
PREADVISE
EDIFACT
D
95B
United Nations
COPRAR
Inbound
COPRAR
message
LOADLIST
EDIFACT
D
95B
United Nations
COPRAR
Inbound
COPRAR
message
DISCHLIST
EDIFACT
D
95A
United Nations
COPRAR
Inbound
COPRAR
message
DISCHLIST
EDIFACT
D
00B
United Nations
CUSCAR
Inbound
CUSCAR
message
MANIFEST
EDIFACT
D
95B
United Nations
CUSRES
Inbound
CUSRES
message
RELEASE
EDIFACT
D
96B
United Nations
IFTSAI
Inbound IFTSAI
message
VESSEL SCHEDULE
EDIFACT
D
00B
United Nations
IFTMBC
Inbound
IFTMBC
message
BOOKING
EDIFACT
D
94B
United Nations
IFTMBC
Inbound
IFTMBC
message
BOOKING
EDIFACT
D
98B
United Nations
IFTMCS
Inbound
IFTMCS
message
BOOKING
EDIFACT
D
95B
United Nations
LOADLIST
Inbound
LOADLIST
message
LOADLIST
Misc.
standard or
proprietary
A
A
Nonstandard
LOADLIST
Outbound
LOADLIST
message
LOADLIST
Misc.
standard or
proprietary
A
A
Nonstandard
SAUDILDP
Inbound
SAUDILDP
message
SAUDILDP
Proprietary
Saudi Load
Permit
Order
30
--
Nonstandard
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
25
Part 1: EDI
ID
How EDI works
What is an EDI interchange and segment?
Description
Class
Standard
Version
Release
Number
Responsible
Agency
SAUDIMNFT Inbound
SAUDIMNFT
message
SAUDIMANIFEST
Proprietary
Saudi
Manifest
30
--
Nonstandard
TPFREP
Outbound
TPFREP
message
version 3.0
PERFORMANCE
EDIFACT
30
00B
United Nations
VERMAS
Inbound
VERMAS
message
VERMAS
EDIFACT
D
16A
United Nations
VERMAS
Outbound
VERMAS
message
VERMAS
EDIFACT
D
16A
United Nations
In addition N4 supports the ACTIVITY (inbound), LOADLIST (outbound COPRAR), and RELEASE (COREOR)
message types along with XML posting for HAZARD, RAILORDER, SNX, INVENTORY, INVOICE, and
RELEASE (350 ANSI) message types. However, standard mapping files are not provided for these messages.
1.2.2 What is an EDI interchange and segment?
EDI files are broken up into segments, which are structured parts that make up the header, body, and trailer of the EDI
file. For example, a segment can correspond to the location of a container in a vessel stow plan.
For an inbound EDI session, an interchange can contain mixed message types. For example, U.S. customs
sends manifest messages and customs release messages in the same EDI file or interchange.
An EDI interchange is the database equivalent of an EDI message. An EDI interchange exists in staging tables prior to
being committed to the N4 database.
The following diagram displays the relationship between an EDI file and the EDI interchange for inbound and outbound
EDI:
For each outbound EDI message,
• The data is read from N4.
• Using the mapping file it is organized into EDI segments and saved under one EDI interchange.
• The segment data in the EDI interchange is then written to a file and sent to your EDI partner.
For each inbound EDI message,
• The EDI file segment data is read and saved under one EDI interchange per the EDI load process.
• The segment data in the EDI interchange then goes through the mapping file and is created, updated, or deleted in
N4 per the posting process.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
26
Part 1: EDI
How EDI works
What is an EDI batch?
For example, if an inbound BAPLIE file is loaded successfully an EDI interchange will be created with the segment
data. If the BAPLIE file is also posted successfully the container data will be created in N4.
1.2.3 What is an EDI batch?
The Batches view displays the EDI batches processed by N4 and may be used for troubleshooting purposes. You can
view the details of an EDI batch, resolve processing problems, and then repost the batch.
An EDI Interchange is created for each EDI file loaded. The EDI file and EDI Interchange usually contain one EDI
message type, but sometimes an inbound EDI file may contain multiple EDI message types resulting in multiple EDI
message types in an EDI Interchange.
An EDI batch is created for each message type in an EDI interchange. Therefore, N4 may create one or more EDI
batches based on the number of message types in the EDI interchange. For example, if an EDI interchange from the
US Customs contains a mixture of ANSI 309 manifest messages (Bill of Lading) and ANSI 350 release messages, N4
creates two EDI batches for the EDI interchange.
The following diagram displays the relationship between an EDI file containing two message types, an EDI
Interchange, and the EDI Batches:
1.2.4 What is an EDI transaction?
An EDI transaction is an individual, committable element in an EDI batch, such as each container in a BAPLIE
message, each booking in an IFTMBC message, or each release in a CUSRES message. In other words, each
individual business transaction in an EDI interchange is represented as an EDI transaction in N4. An EDI transaction
can be made up of several EDI segments, such as all of the EDI segments that provide information about an individual
container in a BAPLIE message. The Transactions view displays the EDI transactions processed at the current scope
level.
1.2.5 EDI processes in more detail
The Processes tab displays the processes for the selected EDI batch, including the start and end time, number of
records, and the status of each process. The Processes tab also displays the errors, if any, for each process in the
selected EDI batch.
When N4 processes EDI, it displays each process in the Process column of the Processes tab in the order in which
they were processed.
The following diagram displays the processes for an Inbound EDI message:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
27
Part 1: EDI
How EDI works
EDI processes in more detail
The following diagram displays the processes for an Outbound EDI message:
For inbound EDI, N4 creates the interchange after the Load process and the transactions after the Map process. For
outbound EDI, N4 create the interchange before the Select process and the transactions after the Extract process.
Then finally creates the EDI segments and EDI file after the Unload process.
If EDI errors occur during a process, then N4 stops processing EDI. For example, if errors occur during the Classify
process for inbound EDI, then N4 stops processing and does not create the EDI transactions.
N4 moves the EDI files to the archive sub-directory located in an EDI mailbox after a successful post for
inbound EDI sessions, or a successful delivery for outbound EDI sessions. When archiving, N4 checks for
matching files in the archive folder. If a matching file already exists in the archive folder, N4 changes the EDI file
name to add a counter and an expression (__) before it is archived. For example, if a file ABC.edi already exists
in the archive folder, the next file with the same name will be archived as 1__ABC.edi. If a third ABC.edi is to be
archived, it will be archived as 2__ABC.edi and so on.
1.2.5.1 Inbound EDI processes
When you post an Inbound EDI message, you can post only containers. N4 does not support posting a container on a
chassis through any EDI message. The inbound EDI processes are:
• Load: N4 creates the EDI interchange using the following steps:
▪ If you are using the EDI job schedule and FTP or SFTP, the Scheduler gets the EDI file from the client
communication folder located on the FTP server and places the EDI file in the local EDI mailbox folder for
processing. If you are using the EDI job schedule and email, you must place the inbound EDI file in the local EDI
folder. N4 uses the EDI folder you specify in the EDI Mailbox form (on page 202), EDI Mailbox form (on page
876).
You can also manually load an EDI file using the Administration
information, see EDI Load form (on page 225).
EDI
EDI Load option. For more
▪ N4 parses the UNA or the ISA segments of the incoming EDI file to identify the delimiters for the EDI message.
▪ If N4 does not find a delimiter in the EDI file, N4 uses the delimiter specified for the associated EDI session (on
page 195).
▪ If the EDI session does not specify a delimiter, N4 uses the default delimiter for the EDI Message Standard
(ANSI or UN/EDIFACT) of the EDI message type (on page 209), EDI message type (on page 879).
▪ If N4 does not find a delimiter for the EDI message type, N4 displays an error.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
28
Part 1: EDI
How EDI works
EDI processes in more detail
▪ N4 divides the EDI file into segments using the segment delimiter, and then writes the segments to the Segments
table for an EDI interchange. You can view the segments in an EDI interchange on the Segment tab (on page
171), Segment tab (on page 821).
• Classify: N4 determines the contents of the EDI interchange and segregates the segments into individual batches
based on the message types included in the EDI interchange:
▪ N4 searches the UNH or the ISA header segment to determine the EDI standard, such as UN/EDIFACT or ANSI,
and to identify the EDI trading partner (on page 206), EDI trading partner (on page 844).
▪ N4 determines the EDI message type, version, and release number and then uses the appropriate EDI session.
N4 validates the value in the Version field against the UNH 0052 data element in the EDI file.
Consequently, what appears in the 0052 UNH segment must match what is specified for the EDI message
type for all associated EDI messages. For example, you enter D in the Version field, the EDI file must
include "D" in the 0052 data segment after the message ID as follows: UNH
+32454295-001+COPARN:D:95B:ITG13. If these version values do not match, N4 displays an error. In
earlier versions of N4, the version number was driven off of the 0057 data element, but this is no longer the
case.
• Map: N4 creates the EDI transactions (on page 191), EDI transactions (on page 841) using the following steps:
a. N4 reads the segments from the Segments table, and then translates the segments into XML using the mapping
file. For more information on mapping files, see EDI Message Map form (on page 217), EDI Message Map form
(on page 902).
b. N4 creates the EDI transactions for all of the segments found, and then applies EDI filters (on page 223), EDI
filters (on page 906) to the transactions.
You can now define the transship port in the LOC+13 segment in the COPARN message.
• Post: N4 creates an EDI batch for each EDI message type in an EDI interchange. If you selected the Autopost
option for the EDI session, N4 posts the batches automatically. You can also manually post an EDI interchange
using the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825) Actions Post option.
N4 posts EDI messages in the order that the messages are received.
Also see How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message (on
page 29), How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message (on
page 179), How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message
(on page 829).
For more information on inbound EDI processes, see STOWPLAN (on page 30), STOWPLAN (on page 179),
STOWPLAN (on page 829), BOOKING (on page 31), BOOKING (on page 181), BOOKING (on page 831), or
ACKNOWLEDGEMENT EDI processes (on page 34), ACKNOWLEDGEMENT EDI processes (on page 184),
ACKNOWLEDGEMENT EDI processes (on page 834).
How N4 determines to search the inbound vessel visit when you post the EDI COARRI
activity message?
When you post the EDI Container Loading Discharging Order (COARRI) activity inbound message with
'inOperatorVoyageNbr' value, then N4 searches the inbound vessel visit based on the line voyage number (Inbound),
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
29
Part 1: EDI
How EDI works
EDI processes in more detail
line operator, and other vessel/vessel visit values. When you post the same message with 'inVoyageNbr' value, then
N4 searches the inbound vessel visit based on the voyage number and other vessel/vessel visit values.
When you post the COARRI inbound message with an invalid operator voyage number, N4 does not process
the message and displays errors.
Inbound STOWPLAN EDI processes
An inbound STOWPLAN EDI message, such as a BAPLIE message, describes a vessel visit and lists the containers
arriving on the vessel and their location on the vessel, including the container number, equipment type, line operator,
gross weight, and any seal numbers or hazardous information. The EDI message only contains information for one
vessel visit.
When processing an inbound STOWPLAN EDI message, the following information must exist in N4:
• Vessel visit
In addition, the vessel visit Lloyds ID or call number must exist in N4.
• Port of load and port of discharge
• Container number
• Line operator
• Equipment type (ISO code)
• Stowage position
N4 checks if each container in the BAPLIE contains Stowage position (LOC+147 segment). If not, N4 stops processing
in the classify stage itself and logs error message 'No LOC+147 segment found for the container <ICTR2012140 >' to
indicate the LOC+147 is missing for the container.
If the ARGOBAPLIE004 (on page 134), ARGOBAPLIE004 (on page 865) setting is set to False for the selected EDI
session, N4 uses the following posting logic to determine the category of the container based on the port of discharge.
• If the port of discharge is equal to one of the following, N4 sets the category to Import:
▪ The current facility's routing point
▪ A sub-point in the vessel visit itinerary for current facility's routing point
• If the port of discharge is not equal to the above and the EDI file specifies a transshipment port that is equal to the
current facility's routing point, then N4 sets the category to Transship. Otherwise, N4 sets the category to Through.
You can set the Posting rule (on page 70), Posting rule (on page 908) for Category property group for the
STOWPLAN class. If the Existing Source is Dischargelist, then you can use the posting rule to Ignore the
updates to the category. For example, in the Posting Rules view (on page 70), Posting Rules view (on
page 908), select the Stowplan group and set a posting rule for Category with the existing datasource as
Discharge List EDI, and then ignore the update. After posting the COPRAR Discharge List EDI message
with category as Import, when you set ARGOBAPLIE004 to True and then post the BAPLIE EDI message
with category as Through, N4 retains the import the category since the COPRAR DISCHARGE exists for a
unit.
If the ARGOBAPLIE004 setting is set to False and the EDI file specifies the transshipment port, for the
posting logic to work correctly you may need to map the portid attribute in the transshipPort element in your
mapping file to the segment in the EDI file that specifies the transshipment port.
When successful, N4 creates the units onboard the vessel specified in the BAPLIE file.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
30
Part 1: EDI
How EDI works
EDI processes in more detail
If a unit's port of discharge is not the current facility's routing point but is a sub-point of the facility's routing point in the
vessel visit itinerary, and a facility relay exists from the current facility to the unit's port of discharge, then N4 updates
the:
• Category to import
• Intended outbound carrier to a generic carrier, such as GEN_VESSEL or GEN_TRUCK, based on the Default
Carrier Mode defined in the facility relay
• Declared outbound carrier to GEN_TRUCK
If ARGOBAPLIE004 (on page 134), ARGOBAPLIE004 (on page 865) setting is set to True and you post an EDI
BAPLIE with barge vessel, booking number, and container category set to EXPORT, N4 creates the unit with the
following properties:
• Category: Export (if the container POD that was posted in the EDI is the current port)
• I/B Visit: The vessel visit obtained from the BAPLIE
• O/B Visit: The booking's vessel visit
• OPL: The POL obtained from the BAPLIE
• POL: The current port terminal
• POD: The booking's POD
In the mapping file, if N4 finds a SCAC and BIC code in the EDI file, N4 does not consider the line operator code. For
example, the extracted XML has the below details in the container operator node:
<argo:containerOperator argo:operator="AAA">
<argo:organizationCodes argo:Id="XXX" argo:scacCode="XXX" argo:bicCode="XXX" />
</argo:containerOperator>
N4 first checks for the SCAC code in the mapping (.mgt) file. If the SCAC code is not available, N4 checks for the BIC
code. If both codes are not available, N4 considers the operator value. Because the above example contains both the
SCAC code and the BIC code, N4 does not consider the operator value. To test this, remove the SCAC code and BIC
code for the line operator and then extract the BAPLIE file; N4 displays the operator value from the filter in the EDI file.
Inbound BOOKING EDI processes
An inbound BOOKING EDI message, such as IFTMCS or 301, describes a Booking including the booking number,
outbound vessel visit, load port, discharge port, shipper, and consignee. For each Booking, the EDI message includes
a list of equipment types specifying the number of containers for each type and any commodity or reefer requirements.
In addition, the EDI message can include an optional list of pre-advised containers for each equipment type.
For domestic bookings, the BOOKING EDI message must contain the booking category.
When you post a BOOKING EDI message, N4 validates the information provided in the EDI message against the
current data. N4 displays an error message if any of the following is true:
• The container operator in the EDI message does not exist.
• The Facility in the EDI message does not exist.
• The POL and POD1 in the EDI message are not in the itinerary for the vessel visit.
• The Origin in the EDI message is not in the itinerary for the vessel visit.
• N4 cannot find or create a new trucking company using the details in the EDI message.
• The Hazard Flash Point unit in the EDI message is other than C (Celsius) or F (Fahrenheit) as per the Navis
standard schema.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
31
Part 1: EDI
How EDI works
EDI processes in more detail
• The ISO code for the order or the order item in the EDI message does not exist.
• The container ID is null (not specified) in the EDI message.
• The Dispatch Reserved value in the EDI message is other than FIRST or ONLY as per the Navis standard
schema.
• N4 finds more than one vessel visit using the information in the EDI message.
• The vessel visit in the EDI message is in the wrong visit phase.
• If a temperature value exists in the EDI message, then equipment type must be a reefer equipment type.
N4 also displays an error when pre-advising a container with an ISO group that does not match the ISO group
specified for the booking in the EDI message.
The header of the BOOKING EDI message contains an action code also known as the message function, indicating
whether the line operator sent the EDI message to create a new booking, add details, delete details or change header
in an existing booking.
The most consistently used codes for the possible set of UN/EDIFACT message function codes are:
• O: Creates a new booking.
• A: Add details to an existing booking.
• E: Delete details from an existing booking.
• U: Change header in an existing booking.
• X: Replace the entire existing booking.
• R or D: Cancel the entire existing booking.
Depending on the action codes your EDI trading partner sends, you may need to map the msgFunction
attribute in your mapping file to an action code that Navis N4 recognizes, such as a D for a cancel action.
Because these action codes are typically inconsistent between line operators, N4 determines the appropriate action
based on the existing booking data.
If booking numbers are always unique for a line operator, N4processes the action code as follows:
• New or update: If the booking does not exist already, N4 creates a new booking, otherwise updates the existing
booking. An Update message is typically used to update the booking and item details. Any equipment in an Update
message should already be linked to the booking. If not, N4 displays the error message "Equipment order does not
exist for the unit" and does not process the message further.
• Add details: If the booking already exists, N4 adds details to the existing booking.
• Delete: If no empty, export, or domestic containers are associated with the booking, N4 deletes the existing
booking. This includes empty containers delivered against a booking and export or domestic containers pre-advised
but not yet received against the booking.
• Change: If the booking already exists, N4 changes the header (for example, ,vessel/voyage) or item / container
details (For example, temp setting, OOG).
• Replace: If the booking already exists, N4 compares the booking items in the inbound EDI message with the
booking items in N4 and replaces the booking item quantity and preadvised units as follows:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
32
Part 1: EDI
How EDI works
EDI processes in more detail
Booking
Qty in
Booking
Item form
Pre-advised
units in
Booking Item
form
Booking
Qty
Preadvised
Units
Booking
Qty in
Replace
EDI
message
Units in Replace EDI message
(<edi:ediBookingEquipment>)
Results after
posting
Booking
Replace EDI
message
(Message
Function 'X')
10
10
10
None
8
None
5
5
5
7
8
7
8
8
8
15
15
15
N4 removes all the existing hazards information and adds the hazards information specified in the message at the
booking and order item level.
If a line operator can reuse booking numbers, then booking numbers are not unique for that line operator. To update an
existing booking the line operator must send a delete action code before a new or update action code. N4 processes
the action code as follows:
• New or update: If preceded by a delete action code, N4 updates the existing Booking; otherwise, it creates a new
Booking.
If Booking with the same booking number for the same line operator already exists and the line operator
does not send a delete action code first, N4 creates a new Booking with the same booking number.
• Delete: If no empty, export, or domestic containers are associated with the Booking in N4, it deletes the existing
Booking.
This includes empty containers delivered against the Booking and export or domestic containers pre-advised but not
yet received against the Booking.
To determine if booking numbers are unique for a line operator, N4 checks the Booking Unique setting on
the Booking Rules tab in the Line Operator form.
When successful, N4 creates, updates, or deletes the Booking per the EDI message. To make sure the booking data in
N4 matches the line operator data, N4 always updates the Booking regardless of the phase of the associated vessel
visit. But N4 may or may not update the containers associated with the Booking if a vessel visit is past cutoff or has a
departed phase. This depends on the configuration of the Booking Rules tab for the line operator. For more
information, see Roll a booking in the online help.
When required to replace an existing booking item with a new one, N4 deletes the existing booking item before
creating the new one. However, if the existing booking item has units or truck transactions against it, then N4 does not
delete it. It instead updates the existing booking item quantity to zero and then creates a new booking item. In this
case, during the ingate stage, N4 displays two booking items with one record having the quantity as 0. This scenario is
applicable only if you have selected the Order Item Not Unique option in the Booking Rules tab of the Line Operator
form.
N4 records a UNIT_ROLL event when updating the booking for a pre-advised unit via the Configurable Pre-advise form
or EDI.
When you update a booking, to add more than one booking item for the same booking, make sure the booking
items with subsequent sequence numbers contain the edi:msgFunction="A" attribute in the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
33
Part 1: EDI
How EDI works
EDI processes in more detail
edi:bookingTransaction node. The ‘booking.xsd’ file contains the element
bkgItemEquipmentSeqNbr.You can map the bkgItemEquipmentSeqNbr element to the booking item
sequence number in the mapping file and set the ‘Order Item Not Unique’ option to ‘True’ on the Booking
Rules tab of the Line Operator form. By doing this, N4 links the units to their corresponding equipment order
items when you post an EDI message with sequence numbers.
If a line operator includes a list of containers in the BOOKING EDI message, you can configure N4 to create these preadvised containers and update these containers per the EDI message, or to ignore the containers in the EDI message.
For more information, see ARGOBOOKING002 (on page 123), ARGOBOOKING002 (on page 855). For information on
other BOOKING EDI settings, see Inbound BOOKING EDI settings (on page 123), Inbound BOOKING EDI settings (on
page 854).
If a BOOKING EDI message contains trucking company information, N4 performs the following actions to try to
determine the trucking company:
• N4 searches for an existing trucking company with an ID or SCAC that matches either the trucking company name
or SCAC code in the EDI message.
• If N4 is unable to find an existing trucking company and both the name and SCAC are included in the EDI message,
N4 tries to create the trucking company using the name as the trucking company name and the SCAC as the
trucking company ID and SCAC code.
When successful, N4 records the trucking company for the associated export booking. The trucking company ID
displays in the Booking form. In addition, new trucking companies display in the Trucking Companies view. When
unsuccessful, N4 produces a warning message and continues to post the EDI file.
If the line operator's voyage number provided in the TDT segment for a line sharing a vessel visit is different
than the vessel visit voyage number in N4, you can update your mapping file to use the
outOperatorVoyageNbr attribute in the baseMapping.xsd schema to map the operator voyage number
from the EDI message to the appropriate vessel visit in N4.
In N4, a booking EDI message can specify the following information:
• Whether Owned Only or Leased Only containers must be used for the booking
• The requested equipment grade and equipment feature for each booking item
To use the Owned Only/Leased Only feature, you must set up the equipment prefixes to accurately show the owner of
the containers with a specific prefix. XPS uses this information to construct container ranges, which it then uses to
select an empty container.
The current standard booking maps for IFTMBC, COPARN, and ANSI301 to not support this feature. Since
specifying OWNED or LEASED containers is not a part of the common EDI standards, it is usually implemented
using the free text segment. Therefore, a custom map is required to transform the free text segment into the
Owned only or Leased only indicators in the Navis standard XML.
Inbound ACKNOWLEDGEMENT EDI processes
An inbound ACKNOWLEDGEMENT EDI message is an application error and acknowledgment message that an EDI
trading partner sends to:
• Acknowledge that they received an EDI message you sent.
• Inform you that their application accepted or rejected the EDI message during processing.
The EDI trading partner must include a message function code in the BGM segment of the ACKNOWLEDGEMENT
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
34
Part 1: EDI
How EDI works
EDI processes in more detail
EDI message to indicate whether they accepted or rejected the EDI message. The Navis standard mapping file maps
the following message function codes:
• AP: The trading partner accepted the EDI message
• Any other code or blank: The trading partner rejected the EDI message
The EDI trading partner should also include the following primary key, and any optional information, in the RFF
segment of the ACKNOWLEDGEMENT EDI message based on the class of the inbound EDI message they
processed:
EDI Message Class
Primary Key
Optional Information
STOWPLAN
Container number
Vessel name and container's line operator
ACTIVITY
Container number
Container's line operator and activity type
PERFORMANCE
Vessel name
N4 uses this information to determine the associated outbound EDI transactions.
Depending on the message function codes and the information your EDI trading partner sends, you may need
to edit the mapping file so that N4 will map them correctly.
The Navis supported ACKNOWLEDGEMENT EDI message is the APERAK EDI message.
After processing an ACKNOWLEDGEMENT EDI message, N4 displays the processed EDI data in the Transactions
view and on Transactions tab for the associated EDI transactions. For example, if you receive APERAK messages in
response to outbound ACTIVITY EDI messages, then N4 displays the processed APERAK data in the Transactions
view and on Transactions tab for the associated outbound ACTIVITY EDI transactions. For more information, see
Transactions view (on page 191), Transactions view (on page 841).
To determine if you need to send an outbound EDI message in response to a rejected ACKNOWLEDGEMENT EDI
message, you must monitor the Transactions view or on Transactions tab. For example, if you receive a rejected
APERAK EDI message, you must correct the error and then manually send the associated outbound EDI message to
the EDI trading partner. To resend an outbound ACTIVITY EDI message, see EDI Session form (on page 195). To
resend an outbound EDI message for a vessel visit, such as a STOWPLAN EDI message, see Outbound EDI tab.
For more information on the APERAK EDI message, go to http://www.unece.org/trade/untdid/d00a/trmd/
aperak_c.htm.
1.2.5.2 Outbound EDI processes
The outbound EDI process has the following states in N4:
• Select: N4 selects the events, for a single operator or multiple operators that occurred between the last extract time
and the current date and time. In addition, N4 creates an EDI interchange but does not create the EDI segments yet.
• Extract: N4 creates the EDI transactions (in the XML format) for all the events found, and then applies EDI filters
(on page 223), EDI filters (on page 906) to the transactions.
For BAPLIE EDI messages only, to process the extract faster N4 combines the select process with the
extract process and does not create EDI transactions.
• Mapping: N4 translates the EDI transactions into EDI segments using the mapping file. For more information on
mapping files, see EDI Message Map form (on page 217), EDI Message Map form (on page 902).
• Unload: N4 splits the EDI segments using the delimiter specified for the EDI session and write the segments to the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
35
Part 1: EDI
How EDI works
EDI processes in more detail
Segments table for an EDI interchange. N4 writes the EDI file from the EDI interchange and places the file in the
local EDI mailbox specified for the EDI session.
• Send: N4 sends the EDI file to the associated EDI trading partner through FTP, SFTP, or email. For more
information on defining mailboxes for EDI trading partners, see EDI Trading Partner form (on page 206), EDI
Trading Partner form (on page 844).
If you have configured an EDI job schedule, the Scheduler Task (OutboundSession or Communication Manager)
sweeps the outbound local EDI mailboxes and sends each EDI file found to the associated EDI trading partner.
After the Unit Model Refactor, N4 no longer retires a unit if it is attached to another unit. For example, if you bundle two
or more flat racks or mount a container on a chassis, N4 does not retire the bundled units or the chassis unit.
The Activity and Stowplan EDI Extracts have been modified to ensure that each Primary unit is extracted as a
separate transaction (as before) and any attached equipment, such as a Payload, Carriage, or Accessory units are
extracted under the AttachedEquipment section of the transaction (as before).
Outbound STOWPLAN EDI processes
An outbound STOWPLAN EDI message, such as a BAPLIE message, describes a vessel visit and lists the containers
departing on the vessel and their location on the vessel, including the container number, equipment type, line operator,
gross weight, and any seal numbers or hazardous information.
By default, the extracted EDI message contains data only for the selected vessel visit. In addition, you can define
session criteria (on page ) in the EDI Session form (on page 195) to further restrict the data in the extract. For
example, if you only want to extract containers on the vessel that are owned by a specific line operator you can define
session criteria to limit the extracted data to the specified line operator.
After the Unit Model Refactor, the ACTIVITY and STOWPLAN EDI Extracts have been modified to ensure that each
Primary unit is extracted as a separate transaction and any attached equipment, such as a Payload, Carriage, or
Accessory units are extracted under the AttachedEquipment section of the transaction.
Outbound ACTIVITY EDI processes
An outbound ACTIVITY EDI message, such as a CODECO message, confirms that the units specified have been
delivered or picked up by an inland carrier (road, rail, or barge). In addition, you can use this message to report loading
and discharging, container movements at the facility, or a change in the status of a container while at the facility.
To determine which units N4 includes in the ACTIVITY EDI message based on the events, you must define session
criteria (on page ) in the EDI Session form (on page 195) to restrict the data in the extract to the events specified
for the Event Type attribute. For example, if you only want to report on units with gate activity, you must create session
criteria with the Event Type attribute set to include only the UNIT_DELIVER and UNIT_RECEIVE events. For
examples, see Session Criteria examples (on page 53), Session Criteria examples (on page 200).
After the Unit Model Refactor, the ACTIVITY and STOWPLAN EDI Extracts have been modified to ensure that each
Primary unit is extracted as a separate transaction and any attached equipment, such as a Payload, Carriage, or
Accessory units are extracted under the AttachedEquipment section of the transaction.
You must select only the event types that are supported by the EDI message map (on page 217), EDI message
map (on page 902) associated with the EDI session. Before defining session criteria, we recommend that you
review the event types listed in the mapping file for the selected EDI message map.
In addition, the event types listed in the mapping file use the event type names prior to the N4 1.4 release. For
example, the DELIVER_CONTAINER event in a mapping file is the same as the UNIT_DELIVER event in N4.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
36
Part 1: EDI
How EDI works
EDI processes in more detail
To determine which event codes N4 sends to your trading partner in the EDI message, you must edit the mapping file
for the selected EDI message map.
The following table lists the supported event types that you can use in your mapping file, the associated event types in
N4 that you can use in the session criteria, and the default event codes N4 sends for a CODECO, COARRI, and 322
EDI message:
Mapping File Event Type
Session Criteria Event Type
CODECO
Code
COARRI
Code
322
Code
DELIVER_CONTAINER
UNIT_DELIVER
36
98
OA
DELIVER_GOODS
UNIT_DELIVER
36
98
OA
RECEIVE_CONTAINER
UNIT_RECEIVE
34
270
I
RECEIVE_GOODS
UNIT_RECEIVE
34
270
I
DISCH_CONTAINER
UNIT_DISCH
44
98
UV
DISCH_GOODS
UNIT_DISCH
44
98
UV
LOAD_CONTAINER
UNIT_LOAD
46
270
AE
LOAD_GOODS
UNIT_LOAD
46
270
AE
RAMP_CONTAINER
UNIT_RAMP
AL
RAMP_GOODS
UNIT_RAMP
AL
DERAMP_CONTAINER
UNIT_DERAMP
UR
DERAMP_GOODS
UNIT_DERAMP
UR
BRING_BACK_INTO_YARD
UNIT_BRING_BACK_INTO_YARD
T
T
BRING_BACK_TO_COMMUNITY UNIT_BRING_TO_COMMUNITY
270
AE
SHIFT_ON_CARRIER
UNIT_SHIFT_ON_CARRIER
YARD_MOVE
UNIT_YARD_MOVE
T
POSITION_CORRECTION
UNIT_POSITION_CORRECTION
T
STRIP_CONTAINER
UNIT_STRIP
SA
STUFF_CONTAINER
UNIT_STUFF
SB
STUFF_GOODS
UNIT_STUFF
SB
TRANSLOAD_CONTAINER
UNIT_TRANSLOAD
SA
TRANSLOAD_GOODS
UNIT_TRANSLOAD
SA
SEAL_UNIT
UNIT_SEAL
NT
When processing an outbound ACTIVITY EDI session, N4 first searches for the units that have these events in their
event history with a Created Date between the Last Run Time in the EDI session and the current date and time. Then,
N4 filters this data per the session criteria for the selected EDI session.
When you post the COARRI XML file, N4 extracts the COARRI activity event (UNIT_DISCH) date and time and
displays the same on the History, Events tab in the Unit Inspector. This behavior applies only to EDI activity
messages.
When you post a CODECO XML file, N4 extracts the CODECO activity events (UNIT_RECEIVE and UNIT_IN_GATE)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
37
Part 1: EDI
How EDI works
EDI processes in more detail
date and time and displays the same on the History, Events tab in the Unit Inspector. This behavior applies only to
UNIT_RECEIVE and UNIT_IN_GATE events. For all other events, N4 uses the system date and time.
When searching for events, by default N4 searches based on the event's Created Date. However, you can
configure N4 to instead search based on the event's Apply Date by setting ARGOACTIVITY003
(USE_APPLY_DATE_FOR_EXTRACT) (on page 142), ARGOACTIVITY003
(USE_APPLY_DATE_FOR_EXTRACT) (on page 872) to true.
When successful, the extracted EDI message contains the units and the unit event types that satisfy the session
criteria, and the event codes, as specified in the mapping file, for the unit event types. The event code displays in either
the Q5 segment for the X.12 standard, or the BGM segment for the EDIFACT standard, as specified in the mapping
file.
When you extract a 322 EDI message with equipment that includes accessory or chassis information, that information
will populate the W2 segment.
Outbound ACKNOWLEDGEMENT EDI processes
An outbound ACKNOWLEDGEMENT EDI message is an application error and acknowledgment message that N4 can
send to an EDI trading partner to:
• Acknowledge that N4 received an EDI message.
• Inform the EDI trading partner that N4 accepted or rejected the EDI message during processing.
To determine which inbound EDI messages for an EDI trading partner that you want N4 to send an outbound
ACKNOWLEDGEMENT message, you must add session criteria to the EDI session. You can filter by the class and
status of the inbound EDI messages for an EDI trading partner. For example, you can add session criteria to send
outbound ACKNOWLEDGEMENT messages only when an inbound BOOKING EDI message processes with
ERRORS. For more information, see EDI Session form (on page 195) and Session Criteria examples (on page 53),
Session Criteria examples (on page 200).
After processing an inbound EDI message that satisfies the session criteria for an outbound ACKNOWLEDGEMENT
EDI session, N4 processes the outbound ACKNOWLEDGEMENT EDI message. N4 displays the Interchange Number
with the Message Sequence Number from the EDI Session for the outbound Acknowledgment message and
increments based on the transactions that is in the acknowledged ISA file. N4 includes the following message function
codes in the BGM segment of the ACKNOWLEDGEMENT EDI message per the Navis standard mapping file:
• AP: N4 accepted the inbound EDI message
• RE: N4 rejected the inbound EDI message
The Navis supported ACKNOWLEDGEMENT EDI message is the APERAK EDI message.
Also, per the Navis standard mapping file, N4 includes the following primary key and optional information in the RFF
segment based on the class of the inbound EDI message:
EDI Message Class
Primary Key
Optional Information
STOWPLAN
Container number
Vessel name and container's line operator
PREADVISE
Container number
Vessel name and container's line operator
LOADLIST
Container number
Booking number, vessel name, and container's
line operator
DISCHLIST
Container number
Vessel name and container's line operator
RELEASE
Release number
Vessel name and line operator
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
38
Part 1: EDI
How EDI works
EDI processes in more detail
BOOKING
Export booking number Vessel name and line operator
MANIFEST
Bill of lading number
Vessel name
N4 sends this information so that the EDI partner can determine the associated EDI message.
If N4 rejected the inbound EDI message, N4 also includes an error code in the ERC segment and an error message in
the FTX segment in the ACKNOWLEDGEMENT EDI message.
Depending on the message function and error codes your EDI trading partner requires, you may need to edit
the mapping file so that N4 will send the correct codes.
In addition, N4 displays the processed EDI data in the Transactions view and on Transactions tab for the associated
inbound EDI transactions. For example, if you send APERAK EDI messages in response to inbound BOOKING EDI
messages, N4 displays the processed APERAK data in the Transactions view and on Transactions tab for the
associated inbound BOOKING EDI transactions. For more information, see Transactions view (on page 191),
Transactions view (on page 841).
For more information on the APERAK EDI message, go to http://www.unece.org/trade/untdid/d00a/trmd/
aperak_c.htm.
Outbound INVENTORY EDI processes
An INVENTORY EDI session is an outbound EDI session that uses the INVENTORY EDI class. You can use an
INVENTORY EDI session to extract unit data for all of the units in a complex or facility into an XML file to send to
another system, such as a mainframe system. This enables you to synchronize unit data in N4 with another system.
This is not a standard EDI message, therefore an EDI message type for the INVENTORY EDI class does not exist and
N4 does not require a mapping file in the EDI session. N4 formats the extracted XML file according to the snx.xsd
schema file. For more information on SNX, see SNX Importer form (on page 1003).
By default, the extracted XML file contains each unit facility visit that is visible in XPS for the current complex. In
addition, you can define session criteria (on page ) in the EDI Session form (on page 195) to restrict the data
included in the extract EDI message. For example, if you only want to extract export containers for a specific facility
you can define session criteria to limit the extracted data to the specified facility and category.
N4 does not extract incremental changes; each extract contains all of the unit facility visit data that is visible in XPS for
the current complex and that satisfies the session criteria in the EDI session, if specified. A typical output XML file
contains several thousand records.
To manually extract an INVENTORY EDI session, see EDI Session form (on page 195). In addition, you can add an
EDI job to schedule automatic extracts. For more information, see EDI Job form (on page 229), EDI Job form (on page
912).
When successful, N4 sends the XML file according to the EDI mailbox (on page 202), EDI mailbox (on page 876)
specified in the EDI session.
You can also use the Actions Export SNX File option in some list views to export data into an XML file. For
more information, see Export SNX File (on page 1109).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
39
1.3 Setting up EDI
When setting up EDI, you can start by configuring all of the static EDI entities first, such as your trading partners, and
then configure the dynamic EDI entities later, such as your EDI sessions and schedules. The static entities are typically
setup only once and then rarely change. The dynamic entities may need to be edited on an ongoing basis.
In This Section
How to set up EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Posting Rules: Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Scheduling an EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure EDI for US Customs Holds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
41
70
76
78
40
Part 1: EDI
Setting up EDI
How to set up EDI
1.3.1 How to set up EDI
This section contains process flow diagrams that illustrate how to set up EDI. In addition, the topics that follow include
detailed steps for each box in the process flow.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
41
Part 1: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Setting up EDI
How to set up EDI
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
42
Part 1: EDI
Setting up EDI
How to set up EDI
1.3.1.1 Setting up supported EDI message types and
message maps
N4 provides you with the supported EDI message types and the associated standard EDI message map. The standard
EDI message map contains the standard mapping file and data dictionary file.
• If you are working with a new installation of N4, you need to add the supported EDI message types and respective
Navis standard EDI message maps.
• If you recently upgraded N4 to a version that contains updates to the supported EDI message types or message
maps, you need to update the supported EDI message types and message maps.
To add or update the supported EDI message types and message maps:
1. Open the Administration
DBA
Set-up Database
Set-up Database view.
2. Select the Set-up EDI Message Types and Maps button.
Use this option to initially setup EDI, to add new supported EDI messages, or to update the EDI message maps for the
supported EDI messages. For more information on EDI message types and a list of the supported EDI message types,
see EDI Message Type form (on page 209), EDI Message Type form (on page 879).
1.3.1.2 Adding a new EDI message type
The EDI Message Type form enables you to add and edit EDI message types. The EDI message type defines the type
of information such as activity or booking data, the standard for which the information is organized, such as X.12 or
EDIFACT, and the version of the EDI standard for messages transferred to or from your EDI partner.
You can add the supported EDI message types, or you can define your own. For each new message type you define,
you must specify the EDI message map (on page 216), EDI message map (on page 901) used. The EDI message map
specifies the mapping file and data dictionary file used.
To add an EDI message type:
1. Open the Administration EDI Message Types
209), EDI Message Type form (on page 879).
Message Types view
EDI Message Type form (on page
2. In the Id field, enter a message type ID.
For supported EDI message types, the ID must match the ID in the list of Supported message types (on
page 23), Supported message types (on page 211).
3. Optionally, in the Description field, enter a description of the EDI message type.
4. From the Class drop-down list, select an EDI message class for the message type.
An EDI class specifies the type of information that will be conveyed in the EDI message.
If you are using EDI to perform scheduled SNX imports, select the SNX class.
5. From the Standard drop-down list, select a standard that specifies the set of EDI message definitions for the
message type:
▪ X.12: Specifies the message types in the ST segment as three digit transaction type identifiers.
▪ EDIFACT: Specifies the message types in the UNH segment (the standard starting segment).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
43
Part 1: EDI
Setting up EDI
How to set up EDI
▪ Navis standard XML: Transmits the EDI messages as an XML file based on the Navis standard schema.
This standard does not need a mapping file.
▪ FLATFILE: Transmits the EDI messages as files with fixed field positions and no delimiters.
EDI message types with the FLATFILE standard use a flat text dictionary file instead of an XML data
dictionary file. For more information, see EDI Message Map form (on page 217), EDI Message Map form
(on page 902).
▪ Misc. standard or proprietary: Other EDI standards defined by institutes, such as ACOS (Australian Chamber of
Shipping).
If you are using a custom mapping file to read proprietary XML files, select Misc. standard or proprietary.
6. In the Version field, enter the version of the EDI message type.
For ANSI 301 version C2/9, enter C2.
N4 validates the value in the Version field against the UNH 0052 data element in the EDI file. Consequently,
what appears in the 0052 UNH segment must match what is specified for the EDI message type for all
associated EDI messages. For example, you enter D in the Version field, the EDI file must include "D" in the
0052 data segment after the message ID as follows: UNH+32454295-001+COPARN:D:95B:ITG13. If these
version values do not match, N4 displays an error. In earlier versions of N4, the version number was driven
off of the 0057 data element, but this is no longer the case.
You must enter a value in this field, even for Navis standard XML or proprietary XML from a customer.
7. In the Release Number field, enter a release number for the message type. The release number is a secondary
version issued by the agency responsible for maintaining the EDI standard.
The version and the release number are a part of the EDI message envelope (UNH for EDIFACT):
▪ For an inbound EDI message, the version and release number in the message envelope must match the values
specified in the EDI Message Type form.
▪ For an outbound EDI message, N4 automatically inserts the values specified in the EDI Message Type form into
the message envelope.
For ANSI 301 version C2/9, enter /9.
For a complete list of version and release numbers supported by Navis, see Supported message types (on
page 23), Supported message types (on page 211). If you require a version or release number that is not
supported, see EDI Message Map form (on page 217), EDI Message Map form (on page 902) for more
information on editing EDI message maps.
You must enter a value in this field, even for Navis standard XML or proprietary XML from a customer.
8. From the Responsible Agency drop-down list, select the agency responsible for maintaining the EDI standard.
9. Click Save.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
44
Part 1: EDI
Setting up EDI
How to set up EDI
You must save the EDI message type before you can specify the EDI message maps for the EDI message type.
If you add a supported EDI message, N4 automatically adds the respective standard EDI message map.
1.3.1.3 Creating and importing a message map
In the EDI Message Type form, you can export the schema files to use as a reference when customizing an EDI
message map for the selected EDI message type.
To export the schema files:
1. Open the Administration EDI Message Types
209), EDI Message Type form (on page 879).
Message Types view
EDI Message Type form (on page
2. Click Export XSD File.
N4 displays the Export XSD File button for existing message types only. For a new EDI message type, you
must add the message type before you can export the schema files.
3. In the Export XSD File dialog box, select the location for the schema files and click Open.
When successful, N4 exports the baseMapping.xsd file and the appropriate schema file for the EDI class of the
selected EDI message type, such as the activity.xsd file for an ACTIVITY EDI message.
You can edit a mapping file to receive and send data for unit flex fields in an EDI message. The following schema files
support flex fields:
• stowplan.xsd
• booking.xsd
• activity.xsd
• preadvise.xsd
• release.xsd
• snx.xsd
To create a new custom message map, you first need to export a standard data dictionary file and standard mapping
file for editing.
To export a standard mapping file:
1. In the Administration EDI Message Types
type for the mapping file you want to export.
Message Types view, double-click the standard EDI message
The EDI Message Type form opens.
2. Open the Message Map tab EDI Message Map form (on page 217), EDI Message Map form (on page 902) for
the standard or built-in message map.
3. To export a custom or standard data dictionary file, click Export DIC.
4. In the Export XML Configuration dialog box, specify a name for the data dictionary file and click Save.
To save an XML data dictionary file, you must enter a name and the extension (.dic).
To save a flat text dictionary file for a FLATFILE EDI message, you must enter a name and the extension (.fxd).
5. To export a custom or standard mapping file, click Export MGT.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
45
Part 1: EDI
Setting up EDI
How to set up EDI
6. In the Export XML Configuration dialog box, specify a name for the mapping file and click Save.
To save a mapping file, you must enter a name and the extension (.mgt).
7. Edit and save the mapping file and data dictionary file as needed using the GoXML mapping utility.
If you edited a mapping file for a new message map, you need to add this new message map and then import your
edited file(s). You cannot import an edited mapping file or data dictionary file for a standard or built-in EDI message
map.
To add a message map and import a new custom mapping file:
1. In the Administration EDI Message Types
message map you want to add.
Message Types view, double-click the EDI message type for the
The EDI Message Type form opens.
2. In the Message Map tab add a new message map.
3. Open the EDI Message Map form (on page 217), EDI Message Map form (on page 902) for the new message
map.
4. In the Map Id field, enter a name that uniquely identifies the EDI message map.
You can create multiple maps for an EDI message as trading partners may use different implementations of the EDI
message.
5. From the Direction list, select the direction of the EDI message.
6. To import the data dictionary file that defines the EDI message structure, click Import DIC.
7. In the Import XML Configuration dialog box, select the data dictionary file and click Open.
XML data dictionary files have the extension .dic and flat text dictionary files have the extension .fxd.
The EDI Message Map Dictionary File field displays --loaded-- in the text box to indicate that a data dictionary file
is linked with the EDI message map.
8. To import the mapping file that defines the EDI map, click Import MGT.
9. In the Import XML Configuration dialog box, select the mapping file and click Open.
Mapping files have the extension .mgt.
The EDI Message Map File field displays --loaded-- in the text box to indicate that a mapping file is linked with the
EDI message map.
10. Optionally, in the Description field, enter a description of the map.
11. Click Save.
If you are updating an existing custom message map, then you must export that message map's custom data
dictionary and mapping file for editing. Once you've edited the mapping file, you need to import your edited file(s).
To import an updated custom mapping file:
1. Open the Administration EDI Message Types Message Types view EDI Message Type form
Message Map tab EDI Message Map form (on page 217), EDI Message Map form (on page 902) for the custom
message map.
2. If you edited the data dictionary file, to import your edited data dictionary file, click Import DIC.
If you do not import an edited data dictionary file, N4 uses the standard data dictionary file for the selected EDI
message type, if available.
3. In the Import XML Configuration dialog box, select the edited data dictionary file and click Open.
4. To import the edited mapping file, click Import MGT.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
46
Part 1: EDI
Setting up EDI
How to set up EDI
5. In the Import XML Configuration dialog box, select the edited mapping file and click Open.
6. Click Save.
If you select a standard or built-in EDI message map, N4 does not display the Save button.
1.3.1.4 Adding a trading partner
The EDI Trading Partner form enables you to add and edit an EDI trading partner and assign EDI mailboxes to it.
This form does not display when you login to N4 at a facility or yard scope level.
You must create at least one EDI trading partner and assign it at least one EDI mailbox to send or receive EDI
messages.
To add a trading partner:
1. Open the Administration EDI EDI Configuration
page 206), EDI Trading Partner form (on page 844).
EDI Configuration view
EDI Trading Partner form (on
2. In the Partner Name field, enter a name that uniquely identifies the trading partner.
3. From the Partner Business Unit drop-down list, select the master organization (business) for the trading partner.
4. From the Complex drop-down list, select the complex that defines the scope for the trading partner.
If you are logged in at a complex or a lower scope level, you can add trading partners only for the current complex.
5. Click Save.
You must save the EDI trading partner before you can assign an EDI mailbox to it.
1.3.1.5 Adding a mailbox
The EDI Mailbox form enables you to add and edit an EDI mailbox. Each EDI mailbox corresponds to a trading
partner/message type combination. You must add separate EDI mailboxes for inbound and outbound EDI messages
for each trading partner.
To add an EDI mailbox:
1. Open the Administration EDI
Mailbox form (on page 876).
EDI Mailboxes
EDI Mailboxes view
EDI Mailbox form (on page 202), EDI
2. In the Mailbox Name field, enter a mailbox name.
Use a short and clear name.
3. In the Trading Partner drop-down list, select the trading partner with whom an EDI message will be exchanged
using this mailbox.
If you open this form from the EDI Configuration view, then the Trading Partner drop-down list is not
available since you have already selected the trading partner in the EDI Configuration view.
4. From the Complex drop-down list, select the complex for which the EDI mailbox is set up.
If you are logged in at a complex or a lower scope level, you can add EDI mailboxes only for the current complex.
5. From the Direction drop-down list, select Send if this is a mailbox for an outbound message (meaning, N4 extracts
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
47
Part 1: EDI
Setting up EDI
How to set up EDI
the data, maps it into an EDI message file, and sends it to the selected trading partner) or Receive if this is a
mailbox for an inbound message.
Once saved, you cannot edit the direction for an EDI mailbox.
6. In the Directory field, enter the absolute path of the folder where the EDI messages will be stored locally for your
site.
N4 automatically creates a folder on the local server using the absolute path entered in the Directory field.
You cannot set Directory to a root directory, such as C:/ in Windows.
7. From the Communication Type drop-down list, select a transfer method for the EDI messages sent to or received
by the terminal:
▪ FTP: The message file is transferred using the standard file transfer protocol. To use this method, you specify the
following additional information:
▪ FTP Address: IP address or host name of the FTP server used to transfer EDI files. Also, if you are using a
port other than the default (21) you would specify this at the end of the IP address, preceded by a colon ([IP
address]:[Port Number]
▪ For example, if the file path is 101.101.101.101/home/SPARCSN4/test/TST/IN, the IP address is
101.101.101.101. If you're using port 2001 instead of the default of 21, you would indicate the port as follows:
101.101.101.101:2001.
The port number specified in the FTP Address field must be configured on the FTP/SFTP server.
▪ The FTP server host name is preferred because the host name does not change while the IP address can
change.
The default port for the FTP communication type is 21.
▪ FTP User Id: User ID for the FTP server.
▪ FTP Password: Password for the FTP server. To confirm the FTP password, you must retype the same
password in the second field.
▪ FTP Folder: Absolute path of the folder on the FTP server where EDI message files are placed for
transmission. For example, if the full file path is 101.101.101.101/home/SPARCSN4/test/TST/IN, the absolute
path would be /home/SPARCSN4/test/TST/IN.
▪ SFTP: The message file is transferred using the secure file transfer protocol. To use this method, you must
specify the same additional information, such as the IP address, port, user ID, password, and folder, as for FTP.
To use SFTP, both the terminal and the trading partner must support the technology.
The default port for the SFTP communication type is 22.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
48
Part 1: EDI
Setting up EDI
How to set up EDI
▪ Email: N4 transfers the message file as an email attachment. The email address used is specified in the Email
Address field.
If a scheduled EDI job runs but the mailbox is empty, N4 sends an email message stating that mailbox is
empty.
You can use a comma-separated list to specify multiple email addresses when configuring an EDI mailbox
with the direction Send.
When an EDI message file is sent as an attachment, it is moved to the archive folder on the local file server.
To transfer EDI by email, make sure you have configured the EDI configuration settings. See the EDI
Settings form in the N4 client: Administration EDI EDI Configuration EDI Configuration view
EDI Session form Settings tab EDI Setting form.
▪ SOAP: The message file is transferred using the simple object access protocol. For outgoing messages, N4
provides a Web Service for the EDI partner to dynamically request an outbound EDI extract. N4 returns the
results of the extract in response to the Web Service request.
N4 only supports processing of outbound vessel extract EDI via web services API using SOAP
communication type.
▪ NONE: The file communication is not controlled within N4.
8. Click Save.
1.3.1.6 Adding an EDI session
The following process flow diagram illustrates how to add an EDI session and the associated session details. In
addition, the topics that follow include detailed steps for each box in the process flow.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
49
Part 1: EDI
Setting up EDI
How to set up EDI
Entering EDI session details
The EDI Session form enables you to add and edit an EDI session and add additional mailboxes, EDI settings (on
page 118), EDI settings (on page 850), and EDI filters for the selected EDI session.
For outbound EDI sessions, you can use session criteria to restrict the data included in the extracted EDI message.
This differs from an EDI filter, which you can use to map data from one value to another value. For example, you can
use session criteria to restrict the data to only include units for a specific line operator, such as ABC. For the same EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
50
Part 1: EDI
Setting up EDI
How to set up EDI
session, you can use an EDI filter to map the line operator ID of ABC to ABB in the extracted EDI file. For more
information on EDI filters, see EDI Filter form (on page 223), EDI Filter form (on page 906).
You must define session criteria for outbound ACKNOWLEDGEMENT and ACTIVITY EDI sessions. For more
information, see the steps below.
Before adding an EDI session, you must first define at least one EDI mailbox, a message type, and an EDI message
map for the selected trading partner.
To add EDI session details:
1. Open the Administration
EDI
EDI Sessions
EDI Sessions view
EDI Session form (on page 195).
2. In the Session Details area, in the Name field, enter a name that uniquely identifies the EDI session.
N4 includes the session name as part of the file name, which consists of the system time + session name +
session file extension, for the file that the EDI session creates. Therefore, do not use any special characters
in the Name field that your operating system may not support as part of a file name.
3. Optionally, in the Description field, enter a short description for the EDI session.
4. From the Complex drop-down list, select the complex for which the EDI session will be set up.
If you are logged in at the complex or a lower scope level, you can set up EDI sessions only for the current complex.
5. From the Direction drop-down list, select Receive or Send depending on whether the session is for an inbound or
outbound EDI message.
▪ Receive: The trading partner will send the data as an EDI message file to N4 for posting. Use for an inbound EDI
session.
▪ Send: The data will be extracted from N4, mapped into an EDI message file and sent to the selected trading
partner. Use for an outbound EDI session.
6. From the Message Class drop-down list, select the message class for the EDI session.
7. Optionally, from the Message Map drop-down list, select an EDI message map (on page 217), EDI message map
(on page 902) for the EDI session.
The drop-down list displays all the EDI message maps for the selected EDI message type for the selected EDI
direction (receive/send).
N4 does not require a message map if you select INVENTORY for the message class in step 5, or if you
process inbound EDI messages that contain a one to one mapping of the elements in the schema.
Otherwise, you must select a message map.
8. From the Trading Partner drop-down list, select the trading partner with whom an EDI message will be exchanged
for this session.
If you open this form from the EDI Configuration view, then the Trading Partner drop-down list is not
available since you have already selected the trading partner in the EDI Configuration view.
9. From the Primary Mailbox drop-down list, select the EDI mailbox for the specified trading partner.
The drop-down list displays the mailboxes defined for the EDI trading partner for the selected EDI direction (receive/
send).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
51
Part 1: EDI
Setting up EDI
How to set up EDI
10. Optionally, in the File Extension field, enter a file extension for the EDI session.
▪ For an inbound EDI session, N4 uses this extension to identify the file to use for the EDI session.
▪ For an outbound EDI session, N4 appends the file extension to the name of the file created by the EDI session.
If you do not specify an extension, for an inbound or outbound EDI session, N4 uses .edi as the file
extension.
11. Optionally, in the Delimiters field, enter a character that will be used as a delimiter for all outbound EDI messages.
If the EDI output file type is FLATFILE, you must specify a delimiter for the EDI session.
Some EDI files use apostrophe (‘) as a segment terminator. If the EDI file also contains the apostrophe as
part of the data, you must add an EDI_LOAD_INTERCEPTOR code extension (on page 992) to remove the
apostrophe from the data.
12. Optionally, in the Last Control Number field, enter a number that you want N4 to use as the starting point for the
EDI transaction control number for the EDI session. The EDI transaction control number is used at the UNH - UNT
(EDIFACT) or the SE - ST (ANSI) level and gets incremented for every EDI transaction.
By default, the EDI transaction control number starts at one, but you can use this field to specify a different starting
point for a specific EDI session for a trading partner.
13. Optionally, you can edit the Message Sequence Number automatically generated by N4.
This number is part of the interchange number and increments with each session extraction.
You can map the Message Sequence Number to the UNB segment of your mapping file.
14. Optionally, from the Load Code Extension, Post Code Extension, and Extract Code Extension drop-down lists,
you can select the groovy code extensions of type EDI_LOAD_INTERCEPTOR, EDI_POST_INTERCEPTOR, or
EDI_EXTRACT_INTERCEPTOR respectively for the EDI session.
For more information on code extension types, see Extension Type Registry view and Code Extensions view (on
page 992).
15. For inbound EDI messages, select the Auto Post check box if you want the received EDI messages to be posted
directly to N4.
If you do not select the Auto Post option, a received EDI message will be mapped and loaded but not posted in N4.
You will have to open the EDI batch and manually post the EDI session.
Optionally, select the Check Interchange Number check box to send a notification e-mail if the received message
envelope interchange number is not one larger than that of the previous message.
When you select Check Interchange Number, N4 validates the Message Sequence Number. If the current
envelope sequence number is not one larger than that of the previous message sent by the trading partner,
N4 sends a notification e-mail.
16. Click Save.
You must save the EDI session before you can add additional mailboxes, EDI settings, and EDI filters for the EDI
session.
For inbound EDI messages the EDI session must be unique by trading partner, direction, and EDI message
type.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
52
Part 1: EDI
Setting up EDI
How to set up EDI
Defining session criteria
In the Filter Criteria area of the EDI Session form, for outbound EDI sessions you can define session criteria (on page
) to restrict the data included in the extract EDI message. By default, an outbound STOWPLAN EDI message
includes the data for the selected vessel and an outbound INVENTORY EDI session includes all of the unit facility visit
data for the current complex.
The Filter Criteria pane is not available until there are values for all required Session Details.
The session criteria differs from an EDI filter (on page 223), EDI filter (on page 906), which you can use to map
data from one value to another value.
For an ACTIVITY EDI session, N4 includes all of the existing data, therefore you must create session criteria to restrict
the data in the extract to the line operators and events you want. In addition, you must also create session criteria for
outbound ACKNOWLEDGEMENT (on page 38), outbound ACKNOWLEDGEMENT (on page 187), outbound
ACKNOWLEDGEMENT (on page 837) EDI sessions.
For an ACTIVITY EDI session, you must only select event types that are supported by the EDI message map
associated with the EDI session. Before defining session criteria, we recommend that you review the event
types listed in the mapping file for the selected EDI message map.
For examples, see Session Criteria examples (on page 53), Session Criteria examples (on page 200).
Session Criteria examples
The following lists some examples of session criteria for the EDI Session form (on page 195):
Example 1: An outbound ACTIVITY EDI session for gate activity for a line operator
For example, to include only units with a line operator of ABC and only deliver and receive container gate activity in an
extract, you can define the following session criteria for an outbound ACTIVITY EDI session:
Example 2: An outbound ACTIVITY EDI session for vessel activity for a line operator
For example, to include only vessel activity (container loads or discharges) in an extract for units that have any of the
following:
• ABC as the line operator
• ABC as the equipment operator
• ABC as the vessel operator, to include alliance partners on an inbound or outbound ABC vessel
You can define the following session criteria for an outbound ACTIVITY EDI session:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
53
Part 1: EDI
Setting up EDI
How to set up EDI
Example 3: An outbound STOWPLAN EDI session
For example, to include only units with a line operator of ABC or ANL in an extract, instead of all of the units on a
vessel, you can define the following session criteria for an outbound STOWPLAN EDI session:
Example 4: An outbound ACKNOWLEDGEMENT EDI session
For example, to send outbound APERAK EDI messages back to the associated EDI trading partner when N4
processes inbound BOOKING EDI transactions with ERRORS, you can define the following session criteria for an
outbound ACKNOWLEDGEMENT (on page 38), outbound ACKNOWLEDGEMENT (on page 187), outbound
ACKNOWLEDGEMENT (on page 837) EDI session using the APERAK EDI message type:
Example 5: An outbound INVENTORY EDI session
For example, to include only unit facility data located in the MAIN facility, you can define the following session criteria
for an outbound INVENTORY (on page 39), outbound INVENTORY (on page 188), outbound INVENTORY (on page
838) EDI session:
Defining additional mailboxes
The Additional Mailbox form enables you to associate additional mailboxes with the selected outbound EDI session.
The additional mailboxes enable you to send copies of all the outbound messages generated by an EDI session to
other trading partners.
To associate an additional mailbox with an EDI session:
1. Open the Administration EDI EDI Configuration EDI Configuration view EDI Session form
Additional Mailboxes tab Additional Mailbox form (on page 198), Additional Mailbox form (on page 848).
2. From the Trading Partner drop-down list, select a trading partner.
3. From the Primary Mailbox drop-down list, select an EDI mailbox associated with the trading partner.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
54
Part 1: EDI
Setting up EDI
How to set up EDI
4. Click Save.
Configuring EDI session settings
The EDI Setting form enables you to add and edit EDI settings for the selected EDI session (on page 195). For an EDI
session, the available EDI settings are determined by the Message Class and the Direction specified in the EDI
Session form (on page 195). For more information on EDI message class, see EDI Message Type form (on page
209), EDI Message Type form (on page 879).
To add an EDI setting to an EDI session:
1. Open the Administration EDI EDI Configuration EDI Configuration view
tab EDI Setting form (on page 199), EDI Setting form (on page 849).
EDI Session form
Settings
2. From the Setting drop-down list, select an EDI setting.
Additional fields are displayed based on the EDI setting selected in step 1.
3. Enter any additional information required for the EDI setting, such as the events to be extracted or the equipment
operator, or select true or false option buttons.
4. Click Save.
Defining an EDI filter
The EDI Filter form enables you to add and edit an EDI filter. An EDI filter maps a field value in an inbound or
outbound EDI message to a field value you specify. The filter can be used to:
• Translate field values between the facility and its EDI trading partners in order to maintain consistency.
• Convert values in an EDI interchange to the values used by the facility or trading partner, such as a port ID or
container operator code.
• Correct erroneous values, such as an incorrect ISO code.
For outbound EDI sessions an EDI filter does not restrict the data included in an extracted EDI file, to restrict
data you must define filter criteria in the EDI Session form (on page 195).
An EDI filter enables you to maintain consistency, convert values in an EDI interchange to the values used by the
facility or trading partner, and correct erroneous values. For example, the standard code for Kaohsiung, Taiwan is
"TWKHH", but one line operator always sends and expects to receive "TWKHA" in the BAPLIE messages. Create two
EDI filters, one for the inbound EDI session and one for the outbound EDI session to make the conversion in all EDI
interchanges with the line operator.
An EDI filter can consist of any number of individual field mappings. You need to create separate EDI filters for inbound
and outbound EDI sessions.
To add an EDI filter:
1. Open the Administration
906).
EDI
Filters
Filters view
EDI Filter form (on page 223), EDI Filter form (on page
2. In the Filter Name field, enter a name that uniquely identifies the EDI filter.
3. From the Direction drop-down list, select one of the following values:
▪ Send: Create an EDI filter for outbound EDI sessions
▪ Receive: Create an EDI filter for inbound EDI sessions.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
55
Part 1: EDI
Setting up EDI
How to set up EDI
4. Click Save.
You must save an EDI filter before you can add filter entries that map field values in inbound and outbound EDI
messages.
To map field values for an EDI filter:
1. In the Administration
EDI
Filters
Filters view, double-click on the EDI filter you want to add values to.
The EDI Filter form (on page 223), EDI Filter form (on page 906) opens.
2. In the Entry Filter tab, click
.
3. From the Field Id drop-down list, select a field for mapping.
For example, select Port ID to create a filter that corrects the port ID specified in an EDI interchange.
4. In the From Value field, enter the field value to be changed.
For example, for an inbound EDI filter, enter TWKHA to specify the non-standard port ID to be changed.
5. In the To Value field, enter the new field value.
For example, for an inbound EDI filter, enter TWKHH to specify the standard port ID.
Either the From Value or To Value must be filled in or there will be an error.
6. Click Save.
Selecting an EDI filter
The EDI Session Filter form enables you to associate EDI filters with the selected EDI session. An EDI filter translates
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
56
Part 1: EDI
Setting up EDI
How to set up EDI
data from one value to another when N4 extracts or before N4 posts an EDI message. For outbound EDI sessions an
EDI filter does not restrict the data included in an extracted EDI file, to restrict data you must define session criteria in
the EDI Session form (on page 195).
An EDI filter created to map an Interchange Sender for an inbound EDI session applies even if the filter is not
associated with the EDI session.
To add a filter to the selected session:
1. Open the Administration EDI EDI Configuration EDI Configuration view EDI Session form
tab EDI Session Filter form (on page 199), EDI Session Filter form (on page 875).
Filters
2. From the EDI Filter drop-down list, select an EDI session filter.
3. Click Save.
Configuring EDI posting rules
When you create a unit with a different hazards class, N4 does not update the hazards for the unit when posting the
EDI Loadlist message, if you define the posting rules to ignore as shown in the following example:
How to configure the posting rule when creating a unit with a
different hazards class
When posting two EDI messages to create a unit with a different hazards class, the LoadList Discrepancies tab in the
Vessel Inspector displays the hazards discrepancies if you configure the posting rule as given in the following example:
If (Unit Category = Import) : [Ignore]
If (Unit Category = Export)...
If(Unit Transit State in [EC/In,Yard,EC/Out])...
If(Unit Transit State in [EC/In,Yard,EC/Out]) : [Ignore]
Otherwise...
If (Existing Source in [In Gate,Local User, Bookings EDI]) : [Ignore]
Otherwise : [Apply]
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
57
Part 1: EDI
Setting up EDI
How to set up EDI
Control which data sources can update certain fields
Under Configuration Equipment Data Quality you can configure the data sources that can update any of the
following six equipment attributes, depending on the source of the existing data:
• Equipment Build Date
• Equipment Csc Expiration
• Equipment Height Mn
• Equipment Strength Code
• Equipment Tare Weight Kg
• Equipment Type
No other equipment attributes are currently supported.
See Data Quality view for detailed information.
Example of how to use data quality
For this example, let's say you don't want a user to be able to update the equipment type value if the source for the
existing value is Load List EDI. You would then want to achieve the following rule:
Where:
Then:
Field you want to protect= Equipment Type
Updates aren't allowed
Data Source for Existing Data = Load List EDI
Incoming Data Source = Local User (for UI updates)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
58
Part 1: EDI
Setting up EDI
How to set up EDI
To set the data quality:
1. In the left pane (where you select the incoming data), double-click on Local User, which is the data source for user
updates through the UI. The six supported fields display.
2. Select Equipment Type, since this is the field you want to protect.
Once you select a field, the Mapping Rules in the right pane become editable.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
59
Part 1: EDI
Setting up EDI
How to set up EDI
3. Under Mapping Rules, select Load List EDI as the Existing Data Source:
4. To the right, click + Add Criterion. The criteria is displayed as an IF statement.
5. Click Set Value. The small Posting Action dialog displays.
6. From the Posting Action drop-down list, select Ignore.
7. Click Save.
To view your data quality setting from the Unit Inspector:
1. Find a container for which the data source for the existing data is Load List EDI.
2. Open the Unit Inspector and select Data Source. You will see that Equipment Type is set to data source Load List
EDI.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
60
Part 1: EDI
Setting up EDI
How to set up EDI
3. If you try to manually update the equipment type for that container, you will receive the following warning:
Data Quality Indicators
At the code level, a data source in N4 may be associated with a data quality indicator to determine the quality of the
incoming data. A data source may be assigned a data quality indicator from 0 through 8 where 0 indicates a low quality
data whereas 8 indicates the highest quality most reliable data.
For example, when you create an equipment using SNX, N4 sets the data source for the record as SNX Message
(Data Quality Indicator=5). When you receive the same container at the facility via the gate (Data Quality Indicator=8)
and the user tries to update any equipment attributes, N4 updates the attribute using the incoming information because
the data quality of the incoming information is higher than that of the existing information.
N4 uses these data quality indicators when you use the UI, an API, or Groovy to update existing data.
The following table displays the data source and the data quality indicator assigned to the source.
Data Source
Description
Data
Quality
Indicator
Data Source (Internal Code)
Automatically
Generated
Data generated by the
system on the fly
0
DataSourceEnum.AUTO_GEN
Testing
Data that is generated by
test suites
0
DataSourceEnum.TESTING
Unknown
Source of Data is Unknown
0
DataSourceEnum.UNKNOWN
Built-in
Data that is built into the
system (should never be
deleted)
1
DataSourceEnum.BUILT_IN
REFCON
Data received direct from
REFCON interface
1
DataSourceEnum.REFCON
SPARCS Import
Data that originated from a
SPARCS Import
1
DataSourceEnum.SPARCS_IMPORT
Bookings EDI
Data received in Bookings
EDI
2
DataSourceEnum.EDI_BKG
Consist EDI
Data received in Consist
EDI
2
DataSourceEnum.EDI_CNST
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
61
Part 1: EDI
Setting up EDI
How to set up EDI
Data Source
Description
Data
Quality
Indicator
Data Source (Internal Code)
Hazards EDI
Data received in Hazards
EDI
2
DataSourceEnum.EDI_HAZRD
Manifest EDI
Data received in Manifest
EDI
2
DataSourceEnum.EDI_MNFST
Release EDI
Data received in Release
EDI
2
DataSourceEnum.EDI_RELS
Transport EDI
Data received in Transport
EDI
2
DataSourceEnum.EDI_TRNPT
Load List EDI
Data received in Load List
EDI
3
DataSourceEnum.EDI_LDLT
Discharge List
EDI
Data received in Discharge
List EDI
3
DataSourceEnum.EDI_DCLT
Stow Plan EDI
Data received in Stow Plan
EDI
3
DataSourceEnum.EDI_STOW
Web User
Data entered by a web
user
4
DataSourceEnum.USER_WEB
Serial Range
Equipment Serial Range
Table
5
DataSourceEnum.EQ_SERIAL_RANGE
SNX Message
Data that originated from
an SNX message
5
DataSourceEnum.SNX
SNX EDI
Data received in SNX EDI
5
DataSourceEnum.EDI_SNX
Inventory EDI
Data received in Inventory
EDI
7
DataSourceEnum.EDI_INVT
In Gate
Data was created at the In
Gate
8
DataSourceEnum.IN_GATE
System DBA
Data entered by a System
DBA
8
DataSourceEnum.USER_DBA
Local User
Data entered by a local
user
8
DataSourceEnum.USER_LCL
Line LoadList Tab
Data posted from Load List
Tab
8
DataSourceEnum.UI_LOADLIST
8
DataSourceEnum.UI_DISCHARGELIST
Line DischargeList Data posted from
Tab
Discharge List Tab
There are other data sources that do not have a data quality indicator assigned at the code level. N4 treats
these data sources as having the lowest precedence (i.e., data quality indicator=0 for these data sources).
The following table displays the data sources that do not have a data quality indicator assigned.
Data Source
Description
Data Source (Internal Code)
Data Import
Data that originated from a
DataSourceEnum.DATA_IMPORT
external system imported through
the Data Importer
Acknowledgement EDI
Data received in
Acknowledgement EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
DataSourceEnum.EDI_ACK
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
62
Part 1: EDI
Setting up EDI
How to set up EDI
Data Source
Description
Data Source (Internal Code)
Activity EDI
Data received in Incoming Activity DataSourceEnum.EDI_ACTIVITY
EDI
Gate Appointment EDI
Data received in Gate
Appointment EDI
DataSourceEnum.EDI_APPOINTMENT
Preadvise EDI
Data received in Preadvise EDI
DataSourceEnum.EDI_PREADVISE
Rail Order EDI
Data received in Rail Order EDI
DataSourceEnum.EDI_RLORD
Rail Way Bill EDI
Data received in Rail Way Bill EDI DataSourceEnum.EDI_RLWAYBILL
Saudi Load Permit
Data received Saudi Load Permit
EDI
DataSourceEnum.EDI_SAUDILDP
Saudi manifest EDI
Data received in Saudi Manifest
EDI
DataSourceEnum.EDI_SAUDIMANIFEST
Apex Purge Background
Job
Purge old data in database
DataSourceEnum.PURGE_JOB
XPS
Updates received from XPS
DataSourceEnum.XPS
Vermas EDI
Data received from Vermas EDI
DataSourceEnum.EDI_VERMAS
Prevent booking or routing updates for a unit after loadlist by line
operator
On the Configuration Organizations Line Operators Line Operators view
Booking Rules tab, you can select the following check box options:
Line Operator form
• Stop all booking updates to unit after loadlist
• Stop all routing updates for unit after loadlist
These options are described below.
Stop all booking updates to unit after loadlist
Whenever there is an update to the booking, the following data usually gets rolled over to the unit associated with that
booking:
• Routing: Vessel visit, port of load, port of discharge, secondary pod, origin, destination
• Contents: Commodity code, shipper, consignee, hazards
• Reefer: Temp req, humidity req, venti req, venti unit, o2 req, co2 req
• Oog: Overlong back, overlong front, overwide left, overwide right, overheight
• Stow: Special Stow
However, when you select the Stop all booking updates to unit after loadlist check box, when updating the booking,
N4 does not roll over any booking data to the unit after the loadlist is received. When booking updates are not rolled
over to the unit, N4 displays a warning.
Use Cases
Action
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Result
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
63
Part 1: EDI
Setting up EDI
How to set up EDI
Booking is updated via UI and unit is
already attached.
Booking can be updated, but updates are not pushed to the unit. You
will receive a warning giving you the option to update the unit.
Booking is updated through EDI.
Booking is attached to the unit, but no updates are made to the unit.
User associates a booking with a unit
through Units Actions Transaction
Assign Booking.
Booking is attached to the unit, but no updates are made to the unit.
You will receive a warning giving you the option to update the unit.
Unit is entered in the appointment or gate
screen with a booking number.
Booking is attached to the unit, but no updates are made to the unit.
Stop all routing updates for unit after loadlist
When you select this check box, when updating the booking routing, N4 does not roll over any routing data to the unit
after the loadlist is received. When routing updates are not rolled over to the unit, the following warning displays:
“Booking updates are not rolled over to Unit, after LoadList has been received.” This affects the following attribute
updates:
• Vessel visit
• POD
• POL
• Origin
• Destination
• POD-2
• Optional POD1
Use Cases
Action
Result
Update unit through Actions Update any of the following:
• Routing
• Other Details (POL)
• Delivery Requirements (Destination)
• Shipment Details (Origin)
N4 displays a warning: “Loadlist has been
received. Do you want to continue?” The routing is
updated only if you select OK.
Manually associate a booking with a unit through Unit
Actions Transaction Assign Booking.
Routing details are not changed, but other booking
updates can be made.
Unit is entered in the appointment or gate screen with a
booking number.
Routing details not changed, but other booking
updates can be made.
Defining a schedule for an EDI job
The Scheduling tab enables you to set up a schedule for the selected job. After you set up a schedule on the
Scheduling tab, you must select the Actions Schedule Job option in the respective view to schedule the job.
To define a schedule for an EDI job:
1. Open the Administration
that you want to schedule.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI
EDI Jobs
EDI Jobs view
EDI Job form
Scheduling tab for the EDI job
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
64
Part 1: EDI
Setting up EDI
How to set up EDI
2. From the Frequency drop-down list, select one of the following options:
▪ On Demand: To execute the job only when a user selects the Actions
Execute Now (once) option.
This indicates that no schedule is set up for the job and a user will have to manually select the Actions
Execute Now (once) option to execute the job each time.
▪ Daily (on page 65), Daily (on page 231), Daily (on page 914), Daily (on page 940), Daily (on page 955): To
execute the job daily at a specified time or repeat after specified time intervals.
For example, you can set this frequency if you want to generate a report at 10:00 pm everyday or if you want to
generate a report everyday at an interval of five hours.
▪ By Day of Week (on page 67), By Day of Week (on page 232), By Day of Week (on page 915), By Day of
Week (on page 941), By Day of Week (on page 957): To execute the job only on specific weekdays. If you select
this frequency, you can still specify the time and the repeat interval for executing the job on the specified
weekdays.
For example, you can set this frequency if you want to generate a report every Monday and Wednesday at 10:00
pm.
▪ By Day of Month (on page 68), By Day of Month (on page 234), By Day of Month (on page 917), By Day of
Month (on page 943), By Day of Month (on page 958): To execute the job only on specific days of a month. If
you select this frequency, you can still specify the time and the repeat interval for executing the job on the
specified day of the month.
For example, you can set this frequency if you want to generate a report on the 1st and 15th of every month at
10:00 pm.
▪ Cron Expression (on page 69), Cron Expression (on page 235), Cron Expression (on page 918), Cron
Expression (on page 944), Cron Expression (on page 959): To use a cron expression to define the schedule to
execute the job.
The other frequencies, Daily, By Weekday, and By Day of Month, internally create a cron expression that
displays in the Expression column in the Reporting Jobs view or EDI Jobs view.
3. Specify the time and/or repeat interval information for the selected frequency option.
4. Click Save to save the changes and close the form.
Daily
The following table lists the date and time fields available if you select the Daily option from the Frequency drop-down
list:
Field
Label
Description
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute according
to the schedule that you set up until you manually unschedule the job using the
Actions Unschedule option.
Execution
Hour(s)
Enter the hour(s) of the day that you want the job to execute.
The valid hour values are from 0 to 23, with 0 representing 12:00 midnight.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
65
Part 1: EDI
Setting up EDI
How to set up EDI
Field
Label
Description
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
For example:
• 0: The job will execute at midnight.
• 0,10,20: The job will execute at midnight, 10 A.M., and 8 P.M.
• 10-20: The job will execute every hour starting 10 A.M and ending 8 P.M.
• 5,10,15-20: The job will execute at 5 A.M., at 10 A.M, and then every hour
starting 3 P.M. and ending 8 P.M.
If you do not enter a value in this field, the job will execute every hour of the day at the
minutes defined in the Execution Minute(s) fields.
Execution
Minute(s)
Enter the minute(s) of the hour that you want the job to execute.
The valid minute values are from 0 to 59.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
The time of execution of a job is calculated by combining the values entered in the
Execution Hour(s) and Execution Minute(s) fields.
For example:
• 0: The job will execute at the hour specified in the Execution Hour(s) field.
• 0,10,20: The job will execute at the hour, and then at 10 minutes past, and 20
minutes past the hour specified in the Execution Hour(s) field.
• 10-20: The job will execute every minute starting 10 minutes past the hour and
ending 20 minutes past the hour specified in the Execution Hour(s) field.
• 5,10,15-20: The job will execute at 5 minutes past, 10 minutes past, and then
every minute starting 15 minutes past and ending at 20 minutes past the hour
specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute every minute of the hour(s)
specified in the Execution Hour(s) field.
Repeat
Interval
Hours
Repeat
Interval
Mins
Enter the number of hours after which the job execution must be repeated.
The valid range of values is 1 to 23.
For example, if you enter 2, the job execution will be repeated every two hours
starting at the hour specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
Enter the number of minutes after which the job execution must be repeated.
The valid range of values is 0 to 59.
The number of minutes can be combined with the number of hours to specify the
repeat interval.
For example:
• If you enter 20 in the Repeat Interval Mins field, the job execution will be repeated
every twenty minutes.
• If you enter 2 in the Repeat Interval Hours field and 20 in the Repeat Interval
Mins field, the job execution will be repeated every two hours at 0, 20, and 40
minutes (assuming that the value in the Execution Minute(s) field is 0).
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
66
Part 1: EDI
Setting up EDI
How to set up EDI
By Day of Week
The following table lists the date and time fields available if you select the Day of Week option from the Frequency
drop-down list:
Field Label
Description
Day of Week
Include the days of the week you want the job to execute. For more information, see
the steps below to include or exclude an entity.
For example, if you include Monday and Thursday, the job is executed on Monday
and Thursday of the week at the time specified.
Occurrence
in the Month
Select the occurrence of the selected weekday(s) in a month.
For example, if you want to execute the job every third Monday of the month, select
Third from the Occurrence in the Month drop-down list and include Monday in
the Day of Week field.
Last
Occurrence
in the Month
Select the check box to execute the job on the last occurrence of the day in the
month.
For example, if you want to execute the job on the last Monday of every month,
select the check box and include Monday in the Weekday field.
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute
according to the schedule that you set up until you manually unschedule the job
using the Actions Unschedule option.
Execution
Hour(s)
Enter the hour(s) of the day that you want the job to execute.
The valid hour values are from 0 to 23, with 0 representing 12:00 midnight.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
For example:
• 0: The job will execute at midnight.
• 0,10,20: The job will execute at midnight, 10 A.M., and 8 P.M.
• 10-20: The job will execute every hour starting 10 A.M and ending 8 P.M.
• 5,10,15-20: The job will execute at 5 A.M., at 10 A.M, and then every hour
starting 3 P.M. and ending 8 P.M.
If you do not enter a value in this field, the job will execute every hour of the day at
the minutes defined in the Execution Minute(s) fields.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
67
Part 1: EDI
Setting up EDI
How to set up EDI
Field Label
Execution
Minute(s)
Description
Enter the minute(s) of the hour that you want the job to execute.
The valid minute values are from 0 to 59.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
The time of execution of a job is calculated by combining the values entered in the
Execution Hour(s) and Execution Minute(s) fields.
For example:
• 0: The job will execute at the hour specified in the Execution Hour(s) field.
• 0,10,20: The job will execute at the hour, and then at 10 minutes past, and 20
minutes past the hour specified in the Execution Hour(s) field.
• 10-20: The job will execute every minute starting 10 minutes past the hour and
ending 20 minutes past the hour specified in the Execution Hour(s) field.
• 5,10,15-20: The job will execute at 5 minutes past, 10 minutes past, and then
every minute starting 15 minutes past and ending at 20 minutes past the hour
specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute every minute of the
hour(s) specified in the Execution Hour(s) field.
Repeat
Interval
Hours
Repeat
Interval Mins
Enter the number of hours after which the job execution must be repeated.
The valid range of values is 1 to 23.
For example, if you enter 2, the job execution will be repeated every two hours
starting at the hour specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
Enter the number of minutes after which the job execution must be repeated.
The valid range of values is 0 to 59.
The number of minutes can be combined with the number of hours to specify the
repeat interval.
For example:
• If you enter 20 in the Repeat Interval Mins field, the job execution will be
repeated every twenty minutes.
• If you enter 2 in the Repeat Interval Hours field and 20 in the Repeat Interval
Mins field, the job execution will be repeated every two hours at 0, 20, and 40
minutes (assuming that the value in the Execution Minute(s) field is 0).
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
By Day of Month
The following table lists the date and time fields available if you select the By Day of Month option from the
Frequency drop-down list:
Field Label
Day of
Month
Description
Include the days of a month you want the job to execute. For more information, see
the steps below to include or exclude an entity.
For example, if you include 1, 15, and 30, the job is executed on the selected days
of the month at the time specified.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
68
Part 1: EDI
Setting up EDI
How to set up EDI
Field Label
Description
Last Day of
Month
Select the check box if you want to execute the job at the last day of the month.
Closest
Workday
Select the check box if you want to execute the job on the closest workday if the
selected day(s) of the month falls on a weekend.
For example, if you include 15 in the Day of Month field and select the check box,
the job will execute:
• On Friday the 14th, if 15th is a Saturday, and
• On Monday the 16th, if 15th is a Sunday.
Repeat
Interval
Days
Enter the number of days after which the job execution must be repeated.
The valid range of values is 1 to 30.
For example, if you enter 2, the job execution will be repeated every two days.
If you do not enter a value in this field, the job will execute only on the day(s)
selected in the Day of Month field.
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute according
to the schedule that you set up until you manually unschedule the job using the
Actions Unschedule option.
Cron Expression
The following table lists the date and time fields available if you select the Cron Expression option from the
Frequency drop-down list.
Field Label
Description
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the
first possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute
according to the schedule that you set up until you manually unschedule the job
using the Actions Unschedule option.
Cron
Expression
Enter the UNIX cron expression to define a schedule for the job. For more
information on cron expressions, go to a website such as http://
wiki.opensymphony.com/display/QRTZ1/CronTriggers+Tutorial.
Sending email notifications for an EDI job
Optionally, on the Notification tab, you can specify the email address of the recipients that want to receive notification
from N4 when an EDI job succeeds or fails. For example, you can specify your email address if you want to receive an
email when an EDI job fails to process.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
69
Part 1: EDI
Setting up EDI
Posting Rules: Overview
For an EDI job that executes an outbound EDI session, N4 sends the EDI message to the Primary Mailbox and any
Additional Mailboxes specified in the EDI Session form (on page 195).
To send notifications for an EDI job:
1. Open the Administration EDI EDI Jobs
that you want to send notifications for.
EDI Jobs view
EDI Job form
Notification tab for the EDI job
2. Optionally, in the Email Message Subject field, enter text to be displayed as the subject of the email notification
sent to the recipient.
For example, you can specify the name of the report being sent as the subject of the email.
3. Optionally, in the Success Recipient Email field, enter the email address to be used if the job runs successfully.
To add multiple recipients, specify multiple email addresses separated by a semi-colon (;).
N4 requires a success recipient email address for a reporting job.
4. Optionally, in the Success Message Prefix field, enter any text you want to appear as part of the body of the email
message.
If you do not enter any text in this field, only the default template for the email message will be used.
5. Optionally, in the Error Recipient Email field, enter the email address to be used if the job is not completed
successfully.
To add multiple recipients, specify multiple email addresses separated by a semi-colon (;).
6. Optionally, in the Error Message Prefix field, enter any text you want to appear as part of the body of the email
message if the job is not completed successfully.
7. Click Save to save the changes and close the form.
1.3.2 Posting Rules: Overview
Administration
EDI
Posting Rules
Posting Rules view
The Posting Rules view displays the EDI posting rules defined at the current scope level. A posting rule enables you
to control the incoming EDI message that is posted to an existing unit. The posting rules are based on property groups
defined in N4.
A property group is a group of related properties of a unit that are usually updated together. The posting rule follows a
hierarchical model that has a parent (Property group) and child properties. The child properties have only one parent
property group, whereas each parent property group has one or more child properties in the Posting Rules view. If the
child property does not have a specified posting rule, N4 inherits the posting rule of the parent property group and
applies to all the child properties. The following graphic displays the tree structure of the Posting Rules view, where
the property group represents the parent part of the hierarchy.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
70
Part 1: EDI
Setting up EDI
Posting Rules: Overview
The following property groups has the corresponding child properties:
Property groups
Child properties
I/B Carrier
I/B Service, I/B Classification
O/B Carrier
O/B Service, O/B Classification
Routing
POD, POD2, POL, Origin, Destination, Optional Port of
Load, Optional Discharge Port1, Optional Discharge Port2,
Optional Discharge Port3, Group Code
Reefer Requirements Temp Required, Temp Max, Temp Min
Weight
Gross Weight, VGM Weight
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
71
Part 1: EDI
Setting up EDI
Posting Rules: Overview
Notes
• When posting an EDI file, the EDI posting rules determine whether N4 updates the property groups only for the
units. For example, when posting a BOOKING EDI message, the EDI posting rules determine whether N4 updates
the units associated with the booking, but not the booking itself.
• You need to use the Category property from the DISCHLIST and the LOADLIST property group of the Posting
Rules view to configure the category for load and discharge list.
1.3.2.1 Define a posting rule
When an EDI message is received, the posting rules determine whether a property group is updated or not based on
one or more of the following criteria:
• Existing data source: Where the existing values for the property group originated.
• Gross Weight Source: Such as EDI, VGM, SCALE, USER, GATE, COMPUTED.
• Trading partner: The trading partner sending the EDI message.
• Unit Category: Such as an Export, Import, or Transship.ok
• Unit Freight Kind: Such as FCL, LCL, or Empty.
• Unit Transit State: Where the unit is in its life cycle.
• Unit Visit State: The visit state of the unit.
N4 tracks the data source of each property group for a unit. When you update a property group, manually or through
EDI, N4 updates the data source for the property group and records the time of the update.
Starting N4 3.2 the Ctr Operator property is removed from STOWPLAN, LOADLIST, and DISCHARGELIST
EDI classes of the Posting Rules view. If you have already created the posting rule for the Ctr Operator
property, after upgrading from a version prior to N4 3.2, you should recreate the same rule in Data Quality view
since the Ctr Operator is removed from the Posting Rules view.
To define a posting rule:
1. In the left pane, double-click an Inbound EDI class such as BOOKING, MANIFEST, PREADVISE, RELEASE,
STOWPLAN, LOADLIST, DISCHLIST.
For example, following the example described above, double-click the STOWPLAN EDI class.
2. Select a property group, such as Commodity.
3. In the right pane, from the first drop-down list, select the criteria for the posting rule.
For example, you can select Existing Source from the first drop-down list.
4. From the second drop-down list, select an operator, such as is (=), is not (!=), or is one of (in). For more
information on operators, see Using filter operators (on page ).
For example, to apply the posting rule to all entities where the existing data source for the Commodity property
group is Manifest EDI, use the is (=) operator.
5. From the third drop-down list, select a value for the criteria selected in step 3.
For example, select Manifest EDI to specify the existing data source for the Commodity property group as Manifest
EDI.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
72
Part 1: EDI
Setting up EDI
Posting Rules: Overview
6. Click + Add Criterion.
The criteria is displayed as an If statement as shown in the graphic below:
7. Click Set Value.
8. From the Posting Action drop-down list, select one of the following options:
▪ Apply: Update the property group if the selected criteria is true.
▪ Ignore: Ignore the updates for the property group if the selected criteria is true.
9. Add the Otherwise criteria or the nested Sub-Criteria to specify the conditions for updating a property group and
set the value for each criteria.
10. Click Save.
If you update the posting rule for a property group and select a different property group or EDI class without
saving the changes, N4 displays a confirmation message. You must click Yes or No to save or cancel your
changes to the property group.
Add an Otherwise criteria
The Otherwise criteria enables you to add an else statement for all If statements that you define at one level. For
example, the first Otherwise criteria in the above example, represents all the data sources other than the Manifest
EDI. The second Otherwise criteria represents all the trading partners other than NYK. To add an Otherwise criteria to
the posting rule, select the If statement for which you want to add the Otherwise criteria and click Add Otherwise.
The following graphic shows sample If and Otherwise statements:
You can add an Otherwise criteria only after you add at least one If statement. In addition, you can add only
one Otherwise criteria at each level of nested criteria.
Add a Nested sub-criteria
To add a nested sub-criteria to the posting rule, select the If statement you want to specify as the parent criteria, use
the drop-down lists to define the criteria, and click Add Sub-Criterion. You can nest sub-criteria within sub-criteria to
any level of detail.
A sub-criterion is a child to the criteria under which it is nested. If you delete the parent criteria, N4 deletes all
the child criteria under it.
You can use nested sub-criteria to check for multiple conditions. In the above example, if the existing source for the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
73
Part 1: EDI
Setting up EDI
Posting Rules: Overview
Commodity property group is not the Manifest EDI, the nested criteria is used to check if the Stowplan EDI is from a
specific trading partner.
1.3.2.2 Define the General Rule for a class
For each EDI class, you can define a General Rule that is independent of any property group. N4 verifies the General
Rule for an EDI class before verifying the posting rules for the specific property groups. If the conditions specified in the
General Rule ignore the EDI message, N4 ignores the data in the EDI message and does not check the posting rules
specified for the specific property groups.
For example, for the Stowplan EDI class, you can specify a General Rule that checks the transit state of a unit and
ignores all EDI updates to the unit if the transit state is either EC-Out, or Loaded.
The Inbound EDI Classes APPOINTMENT, BOOKING, HAZARD, MANIFEST, PREADVISE, RELEASE, STOWPLAN,
ACTIVITY, LOADLIST, DISCHLIST, RAILCONSIST, RAILORDER, RAILWAY BILL, SAUDI MANIFEST, SAUDIDP, and
VERMAS has the following property group and child properties:
Property Group
Child Properties
General Rule
X
Agents
X
Category
X
Freight Kind
X
Line Operator
X
O/B Carrier
O/B Carrier Service
O/B Classification
Routing
Routing POD
Routing POL
Routing POD2
Routing Origin
Routing Destination
Optional Port of Load
Optional Discharge Port 1
Optional Discharge Port 2
Optional Discharge Port 3
Commodity
X
Hazards
X
OOG
X
Reefer Requirement
Reefer Temp Requirement
Reefer Temp Max
Reefer Min
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
74
Part 1: EDI
Setting up EDI
Posting Rules: Overview
Property Group
Child Properties
Seals
X
Weight
Gross Weight
VGM Weight
1.3.2.3 How do the posting rules work?
The posting rule follows a hierarchical model that has a parent (Property group) and child properties. The child
properties have only one parent property group whereas, each parent property group has one or more child properties.
• When you define posting rules, you are creating a set of instructions that N4 must adhere to when an incoming file is
being posted.
• The instructions are with respect to the data in N4 and not with respect to the data present in an EDI file.
• If you do not define a posting rule for an inbound EDI class, N4 by default updates existing data with the values
provided in the EDI file.
• If the posting rule criteria is not met, N4 ignores the attribute in the EDI file even if you did not specifically define the
‘IGNORE’ criteria for the posting action.
The following graphic displays the tree structure of the Posting Rules view, where the Property Group represents the
'parent' part of the hierarchy.
You can define the posting rules for the child properties explicitly. If you did not define any posting rule for the child
properties, then N4 inherits the posting rule from its corresponding property group.
For example, after you create a posting rule for the I/B Carrier property group and if the child property I/B Service
does not have a posting rule, N4 inherits the posting rule of the I/B Carrier and applies to all its child properties.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
75
Part 1: EDI
Setting up EDI
Scheduling an EDI session
1.3.3 Scheduling an EDI session
The EDI Jobs view displays the EDI jobs that exist at the current scope level. You can use an EDI job to define a
schedule for N4 to execute a specified EDI session at timed intervals.
The EDI Job form enables you to add an EDI job definition that specifies a schedule to run EDI sessions at specified
time intervals.
For example, you can use a scheduled EDI job to have N4 execute an outbound ACTIVITY EDI session for ABC line
operator at the end of each day and send the EDI message to the EDI mailbox specified in the EDI session.
The Scheduling tab enables you to set up a schedule for the selected job. After you set up a schedule on the
Scheduling tab, you must select the Actions Schedule Job option in the respective view to schedule the job.
The Notification tab enables you to specify the email address of the recipients for the reporting job outputs. You can
specify the recipient for successful execution of a report as well as a recipient for a failure message.
To add or edit an EDI job:
1. Open the Administration
2. To add or edit a job, click
EDI
EDI Jobs
EDI Jobs view.
or double-click on the EDI job you want to edit.
If you select a scheduled EDI job for editing, N4 prompts you to select one of the following options:
▪ Yes: To unschedule the EDI job and open the EDI Job form to edit the EDI job.
▪ No: To leave the EDI job scheduled, and open the EDI Job form in a view-only mode.
If you select No, the entire EDI Job form displays in the view-only mode except the Execution Logs tab (on page
933). You can view and delete execution logs on this tab.
The EDI Job form opens.
3. In the General area, in the Id field, enter a unique ID for the EDI job.
4. Optionally, in the Description field, enter a short description for the EDI job.
5. From the Execution Node drop-down list, select the node where N4 must execute the EDI job.
It is a best practice to have a Cluster node dedicated to EDI jobs. If you have a node dedicated to EDI jobs,
select that node.
N4 executes the EDI job on the selected node in the cluster.
6. In the Job Target area, optionally, from the Partner Name drop-down list, select the EDI trading partner.
7. From the Job Class Name drop-down list, select a job class:
▪ InboundSession
▪ OutboundSession
▪ CommunicationSession (send only without any other processing)
▪ ReprocessSession (retry the selected inbound session if posting failed)
8. If you selected InboundSession or OutboundSession in the Job Class Name drop-down list, select an EDI session
from the Session drop-down list.
▪ The options you see in the Session drop-down list depend on the job class and the EDI trading partner, if any.
▪ The Session drop-down list does not display outbound sessions that are based on the carrier visit since it is not
possible to provide carrier information when you set up an EDI job. Therefore, you cannot schedule an EDI job to
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
76
Part 1: EDI
Setting up EDI
Scheduling an EDI session
extract EDI based on carrier information (vessel or rail visit). Examples of carrier based EDI include Stowplan,
LoadList, DischargeList, etc.
9. If you selected CommunicationSession in Job Class Name drop-down list, select an EDI mailbox from the Mailbox
drop-down list.
10. If you selected ReprocessSession in the Job Class Name drop-down list, select an inbound EDI session from the
Session drop-down list.
11. From the Complex drop-down list, select the complex for the EDI job.
If you are logged in at the complex or a lower scope level, you can only set up EDI jobs for the current complex.
12. On the Scheduling tab (on page 230), Scheduling tab (on page 913), Scheduling tab (on page 939), define a
schedule to execute the EDI job.
For more information on defining a schedule, see Defining a schedule for an EDI job (on page 64).
Do not use the Scheduling tab for ReprocessSession jobs.
13. Optionally, on the Notification tab, you can specify the e-mail address of the recipients that want to receive
notification from N4 when an EDI job succeeds or fails. For more information, see Sending email notifications for an
EDI job (on page 69).
N4 validates the email address format and accepts only the email addresses that are entered in the
'username@mailprovider.domain' format (for example: john@navis.com). 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: john@navis.c).
▪ Has a Domain name ending with a numeric domain identifier (for example: john@navis.co2).
N4 allows you to use an apostrophe anywhere in the recipient's name in an email address, such as
O'Donnell@xyz.com.
14. If you selected ReprocessSession in the Job Class Name drop-down list, enter the number of times N4 should
attempt to process the EDI job.
You cannot reprocess a session more than five times.
15. Click Save.
To schedule an EDI job:
1. Open the Administration
EDI
EDI Jobs
EDI Jobs view.
The EDI Jobs view opens.
2. In the EDI Jobs view, select the EDI job you want to schedule.
3. Select Actions
Schedule to schedule the EDI job.
Once scheduled, N4 displays the EDI job in the Background Jobs view (on page 929) and executes the EDI job at
the specified times.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
77
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
If an EDI job is scheduled, a bullet displays in the Is Scheduled column.
To unschedule an EDI job:
1. Open the Administration
EDI
EDI Jobs
EDI Jobs view.
The EDI Jobs view opens.
2. In the EDI Jobs view, select the EDI job you want to unschedule.
3. Select Actions
Unschedule to unschedule the EDI job.
Once unscheduled, N4 removes the EDI job from the Background Jobs view and will no longer execute the EDI
job until you schedule it again or use the Execute Now (once) option.
You can also use the Actions Halt Job option in the Background Jobs view to unschedule an EDI job.
For example, if an EDI job is running when you unschedule it in the EDI Jobs view, the EDI Scheduler will
continue processing the EDI job until it is complete unless you halt the EDI job in the Background Jobs
view.
To execute an EDI job on demand:
1. Open the Administration
EDI
EDI Jobs
EDI Jobs view.
The EDI Jobs view opens.
2. In the EDI Jobs view, select the EDI job you want to execute.
3. Select Actions
Execute Now (once) to execute the EDI job.
1.3.4 Configure EDI for US Customs Holds
N4 allows you to do the following in support of US Customs Holds requirements:
The USCustomsBLReleaseGvy built-in groovy handles US customs 95, 1J, 1C for the 350 release message. To use
this groovy, you need to add it in the EDI session's post code extension.
The below example describes how to configure the disposition codes for 350 release messages.
Configure 350 release map for 1J and 95 disposition code, ensure the Apply Hold check box is not selected and Match
By Reference Number is NULL.
Create a BL with Manifest Qty = 100. The 350 message with disposition code 1C and quantity 50 make s released
quantity as 50. The Customs Default hold status is active.
When 350 message with disposition code 1J, quantity 50 and reference number 1111 arrives, make the inbond quantity
=100, the released quantity =50 and the manifest quantity =100. The Inbond status will be INBOND.
When the 350 message with disposition code 95 and reference number 2222 arrives, it will cancel the 1J since Match
By Reference Number is NULL for 95 disposition code. Inbond status will be in CANCEL state. In the N4 application,
the BL Release reference entity column for the canceled 1J will be populated with the 95 disposition code sequence
number to indicate that this 1J was canceled by the corresponding 95.
The functionality of these disposition codes are given below:
The Inbond quantity should be the sum of 1J quantity and 11C quantity.
- Disposition code 1J: The disposition code 1J sets the Bill of Lading to Inbond Status. Each 1J received is with a
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
78
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
reference number. When a 1J is received, the quantity received in the 1J is added to the release quantity for the BL. If
the inbond quantity is equal to release quantity then the Inbond Status of the BL is changed as INBOND.
- Disposition code 1C: This disposition code will add the quantity to the released quantity. When 350 message arise,
the quantity of 1C will be considered the inbond quantity, and 1C disposition code updates BL's Inbond Status.
If the BL manifest quantity is less than or equal to sum of inbond quantity then the Inbond Status will be
INBOND otherwise CANCEL. It records the RECEIVED_1J event event for acknowledgment.
- Disposition code 95: This disposition code cancels all 1J if the reference number matches the 1J reference number
and updates Inbond Status. It records the CANCELED_1J event for acknowledgment.
1.3.4.1 Configure Customs holds for a BL through EDI
The Customs governs certain rules and regulations to deliver containers outside the terminal. There are around 84
disposition codes that the Customs uses for the Release EDI message. N4 allows configuring some of these codes to
handle the Customs Release messages.
Customs disposition codes are functionally classified as follows:
• Codes that apply or release a hold on the BL based on the reference number and affect the BL quantity.
Example:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100. N4 creates:
A 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
A 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1B map code for reference number 12345 and quantity 50.
• Codes that apply or release a hold based on the reference number but do not affect the BL quantity.
These are information codes and they function based on the Resend indicator defined in the message.
Example:
When the Resend indicator is set to true, N4 creates only one hold record even if you post the 7H message twice.
When the Resend indicator is set to false, N4 creates two holds if you post the 7H message twice.
• Codes that are only for information purposes and do not apply any changes to the Bill of Lading quantity. Whenever
N4 receives these codes, it merely records them against the bill of lading.
Example:
A 1M message creates a 1M record in the BL Releases tab of the Bill of Lading Inspector.
It does not create a hold in the Holds/Perms tab.
Whenever a BL is created for the first time, it is on hold until a specific hold or release message is received from the
US Customs. A hold on a bill of lading is generally released when the release quantities add up to exactly the BL’s
manifested quantity.
That is, every time a disposition code that is received affects the release quantity, N4 adds up all the positive and
negative release quantities previously received and matches the total against the BL’s manifested quantity. If they both
match exactly, the default hold on the BL is released; otherwise the hold remains on the BL.
1.3.4.2 Configuring a default hold for a BL
Whenever a BL is created, N4 immediately places a default terminal hold in anticipation of the upcoming disposition
codes that either release or apply a hold by quantity. This default hold is determined by the configuration of the
CGOCARGORELEASE001 (RELEASE_BY_QTY_FLAGTYPE) setting. Using this setting, you can specify the hold
that you want to apply to a BL.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
79
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
After you configure the default hold,
• If the release quantity and manifested quantity are zero, the hold defined in the Settings view (on page 1042) is
applied to the BL.
• If the release quantity is equal to the manifested quantity, the hold defined in the Settings view is released for the
BL.
Prerequisites
• Create a hold using the Hold/Permission Type form (on page 489).
• Open the CGOCARGORELEASE001 setting and enter the hold ID defined in the first step as the value for the
setting, then click Save.
• Create a Manifest EDI session.
• Map the Customs default hold to the hold configured in N4 using the EDI Release Map form (on page 221), EDI
Release Map form (on page 904).
Following are the field configurations recommended for the terminal hold in the EDI Release Map form:
Map code
Hold/
Perm
BL_CUSTOMS <hold
defined in
N4>
Apply a
Hold?
No
Match
Quantity
-
Modify
Quantity
Released
Quantity
Match
Unit By
Id Only
Behavior
• Adds quantity to the
Manifested quantity field.
• Releases the terminal hold if
the Released quantity is
equal to the Manifested
quantity.
Example scenario for a default hold
Assume the Released quantity is 100 for a BL.
Post a Manifest EDI file with quantity 100.
N4:
• Adds the Manifested Qty to 100 in the Bill of Lading Inspector.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
80
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
• Updates the status of the default terminal hold to RELEASED in the Holds/Perms tab.
1.3.4.3 Configuring Map Codes
When a Release message with a disposition code is received for a BL, N4, based on the purpose of the code, either
merely records an event, or performs a hold or release process for the BL.
N4 calculates the BL quantity based on the negative or positive quantity sent in the Release message. When there is a
negative indicator in the release message, the quantity gets subtracted from the entered or released quantity.
Map Codes 1A, 1B, and 1C
Prerequisites
• Create a 1A hold using the Hold/Permission Type form (on page 489).
• Map 1A, 1B, and 1C using the EDI Release Map form (on page 221), EDI Release Map form (on page 904).
Following are the field configurations recommended for the 1A, 1B and 1C codes in the EDI Release Map form:
Map
code
Hold/
Perm
Apply a
Hold?
Match
Quantity
Modify
Quantity
Match
Unit By
Behavior
1A
1A
Yes
By Reference
Entered
Quantity
Id Only
• Records a 1A hold.
• Adds quantity to the Entered Qty
1B
1A
No
By Reference
Released
Quantity
Id Only
• Records receipt of 1B release
message.
• Adds quantity to the Released
Qty.
• Releases 1A hold for the specified
quantity
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
81
Part 1: EDI
Map
code
1C
Setting up EDI
Configure EDI for US Customs Holds
Hold/
Perm
1A
Apply a
Hold?
No
Match
Quantity
By Manifest
Modify
Quantity
Released
Quantity
Match
Unit By
Id Only
Behavior
• Records receipt of 1C message.
• Adds /subtracts quantity to/from
the Released Qty.
Example Scenarios involving 1A and 1B codes
Case 1:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1B map code for reference number 12345 and quantity 50.
N4:
• Creates a 1B record with Released Qty 50 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
Again, post a CUSRES message with 1B map code for reference number 12345 and quantity 50.
N4:
• Creates another 1B record with Released Qty 50 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
• Updates the 1A record with the status RELEASED in the Holds/Perms tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
82
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
Case2:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Again, post a CUSRES message with 1A map code for reference number 12345 and quantity 100.
N4:
• Creates another 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
Post a CUSRES message with 1B map code for reference number 12345 and quantity 200.
N4:
• Creates a 1B record with Released Qty 200 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
• Updates the 1A record in the Holds/Perms tab with the RELEASED status.
Case 3:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
83
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
Creates a 1A hold record for the BL number in the Holds/Perms tab.
Again, post a CUSRES message with 1A map code for reference number 12345 and quantity 100.
N4:
Creates another 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
Post a CUSRES message with 1B map code for reference number 12345 and quantity 175.
N4:
Creates a 1B record with Released Qty 175 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
Retains the 1A hold in ACTIVE status.
Examples Scenarios for 1C code
While a 1A code is used to apply a hold for a specific BL and a 1B to release the hold, 1C is a generic release
message that is not reference-number-dependent. 1C is generally sent when the Customs releases a BL by mistake
and needs to rectify it. The quantity received in a 1C message gets added to the existing Released quantity. When 1C
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
84
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
is sent with a negative indicator, the quantity is subtracted from the Released quantity. The Entered quantity does not
get affected.
Case 1
Assume a bill of lading has the released quantity amounting to 100.
Post a CUSRES message with 1C map code and quantity -50.
N4 creates a 1C record with Released Qty 50 in the BL Releases tab of the Bill of Lading Inspector.
Case 2
Assume a bill of lading has the released quantity amounting to 100.
Post a CUSRES message with 1C map code and quantity 100.
N4 creates a 1C record with Released Qty 200 in the BL Releases tab of the Bill of Lading Inspector.
Map Codes 4A, 4C, and 4E
A 4A map code functions similar to a 1A code except that it affects the Released quantity. Further, a 4A message can
be sent with a negative indicator based on which N4 either adds to or subtracts from the Released quantity.
A 4C map code records release of the 1A hold for the specified quantity and it affects the Released quantity.
A 4E map code is used to cancel the 1A hold applied to a BL by affecting both the Entered quantity and the Released
quantity.
Prerequisites
• Map 4A, 4C and 4E using the EDI Release Map form (on page 221), EDI Release Map form (on page 904).
Following are the field configurations recommended for the 4A, 4C and 4E codes in the EDI Release Map form:
Map
code
Hold/
Perm
Apply a
Hold?
Match
Quantity
Modify
Quantity
Match
Unit By
Behavior
4A
1A
No
By
Reference
Released
Quantity
Id Only
• Records a 1A hold.
• Adds/subtracts quantity to/from the
Released quantity.
• Records receipt of 4A message.
4C
1A
No
By
Reference
Released
Quantity
Id Only
• Records release of 1A hold for the
specified quantity.
• Adds quantity to the Released Quantity.
• Records receipt of 4C message.
4E
1A
No
By
Reference
Entered
Quantity
Id Only
• Reactivates or releases a hold applied
to the BL.
• Subtracts from the Entered and/or
Released Quantity based on the receipt
of the previous map codes.
• Records receipt of 4E message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
85
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
Example scenarios involving 4A and 4C codes
Case 1:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1B map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1B record with Released Qty 100 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
• Updates the 1A record with the Status RELEASED in the Holds/Perms tab.
Now, post a CUSRES message with 1C code, reference Id 12345 and quantity -100.
N4:
• Creates a 4A record with Released Qty 0 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
86
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
• Reapplies a hold by updating the 1A record with the Status ACTIVE in the Holds/Perms tab.
Case 2:
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 200.
N4:
• Creates a 1A record with Entered Qty 200 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record with the status ACTIVE in the Holds/Perms tab.
Post a CUSRES message with 1A map code, reference Id 13330 and quantity 50.
N4:
• Creates another 1A record with Entered Qty 50 for reference number 13330 in the BL Releases tab of the Bill of
Lading Inspector.
• Creates another 1A hold record with the status ACTIVE in the Holds/Perms tab.
Post a CUSRES message with 4C code, reference Id 13330 and quantity 50.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
87
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
N4:
• Creates a 4C record with Released Qty 50 for reference number 13330 in the BL Releases tab of the Bill of
Lading Inspector.
• Updates the 1A record with the status RELEASED in the Holds/Perms tab.
Example scenarios for 4E code
A 4E code is used to cancel the operations performed by codes received prior to the 4E code based on the reference
number. It subtracts from either the Entered Quantity or the Released Quantity or both based on the reference number
and the preceding receipt of the disposition codes.
For instance,
• If 1C was received prior to a 4E code, then it cancels the 1C operation. That is, it subtracts the quantity from the
Released Quantity.
• If 1A, 1B and 1C were received with quantities 100, 100 and 50 respectively, a 4E message sent next cancels only
the 1C operation. That is, it only subtracts from the Released Quantity received through the 1C message.
• If a 1A hold has been applied to a BL followed by a 1B release message, a 4E code sent next subtracts the quantity
from both the Entered and the Released Quantity.
Case 1
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1B map code, reference Id 12345 and quantity 100.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
88
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
N4:
• Creates a 1B record with Released Qty 100 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
• Updates the 1A hold record with RELEASED status in the Holds/Perms tab.
Post a CUSRES message with 4E map code, reference Id 12345 and quantity 100.
N4:
• Creates two 4E records with Entered Qty 0 and Released Qty 0 in the BL Releases tab of the Bill of Lading
Inspector.
• 1A hold record remains in the RELEASED status in the Holds/Perms tab.
Case 2
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1B map code, reference Id 12345 and quantity 50.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
89
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
N4:
• Creates a 1B record with Released Qty 50 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
Post a CUSRES message with 4E map code; reference Id 12345 and quantity -100.
N4:
• Creates two 4E records with Entered Qty 0 and Released Qty -50 in the BL Releases tab of the Bill of Lading
Inspector.
• Updates the 1A hold record with the Status RELEASED in the Holds/Perms tab.
Case 3
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 100.
N4:
• Creates a 1A record with Entered Qty 100 for reference number 12345 in the BL Releases tab of the Bill of Lading
Inspector.
• Creates a 1A hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 1A map code, reference Id 12345 and quantity 76.
N4:
• Creates another 1A record with Entered Qty 176 for reference number 12345 in the BL Releases tab of the Bill of
Lading Inspector.
Post a CUSRES message with 4E map code; reference Id 12345 and quantity -50.
N4:
• Creates a 4E record with Entered Qty 126 in the BL Releases tab of the Bill of Lading Inspector.
• 1A hold record remains in the ACTIVE status in the Holds/Perms tab.
Map codes 7H and 7I
7H, 7I, 1M, 54 are information codes that do not have any impact on either Entered or the Released Quantity. A 7H
code applies a hold to the BL while a 7I code releases the hold based on the reference number.
Certain information codes, such as 7H and 7I, have a Resend Indicator attribute defined in the EDI message. When
the Resend Indicator is false, if you post the 7H message for the second time, N4 creates one more hold record in the
Holds/Perms tab of the Bill of Lading Inspector.
Now, if you post the 7I message, N4 releases the 7H hold record that has the earliest Created time.
When the Resend Indicator is true, if you post the 7H message for the second time, N4 creates only one record in the
Holds/Perms tab of the Bill of Lading Inspector.
Prerequisites
• Map 7H and 7I using the EDI Release Map form (on page 221), EDI Release Map form (on page 904).
Following are the field configurations recommended for the 7H and 7I codes in the EDI Release Map form:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
90
Part 1: EDI
Map
code
Setting up EDI
Configure EDI for US Customs Holds
Hold/
Perm
Apply a
Hold?
Match
Quantity
Modify
Quantity
Match Unit
By
Behavior
7H
7H
Yes
-
-
Id Only
• Records a 7H hold.
• Adds quantity to the Entered
Qty
7I
7H
No
-
-
Id Only
• Records release of 7H hold.
• Records receipt of 7I
message.
Example scenarios involving 7H and 7I codes
Case 1
Post a CUSRES message with 7H map code, reference Id 12345 and Resend Indicator set to true.
N4:
• Creates a 7H record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
• Creates a 7H hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 7H map code and reference Id 12345 and Resend Indicator set to true.
N4:
• Creates another 7H record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
Post a CUSRES message with 7I map code and reference Id 12345.
N4:
• Creates a 7I record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
• Updates the 7H hold record with the RELEASED status in the Holds/Perms tab.
Case 2
Post a CUSRES message with 7H map code, reference Id 12345 and Resend Indicator set to false.
N4:
• Creates a 7H record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
• Creates a 7H hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 7H map code and reference Id 12345 and Resend Indicator set to false.
N4:
• Creates another 7H record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
• Creates another 7H hold record for the BL number in the Holds/Perms tab.
Post a CUSRES message with 7I map code and reference Id 12345.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
91
Part 1: EDI
Setting up EDI
Configure EDI for US Customs Holds
N4:
• Creates a 7I record for reference number 12345 in the BL Releases tab of the Bill of Lading Inspector.
• Updates the earliest 7H hold record with the RELEASED status in the Holds/Perms tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
92
1.4 EDI Configuration
In This Section
EDI Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
XPS Privileges for EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
XPS Settings for EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
EDI Message Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
EDI Session Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
93
1.4.1 EDI Privileges
The following privileges are related to EDI functionality.
ID
Name
Description
License
Required
Option
Name
BATCH_UPDATE_CARRIER_VISIT
EDI Batch
Update Carrier
EDI
Actions Visit using the EDI
Update Carrier Batch Inspector
Visit
Actions menu
Advanced
EDI
Foundation
CANCEL_EDI_BATCH
EDI Batch
Actions Cancel EDI
Batch
Update EDI Batch EDI
status from
ERRORS to
CANCEL using the
Batches view
Actions menu.
Advanced
EDI
Foundation
EDI_ENABLE_BATCH_LINK
EDI Enable
Batch Link
Enable the link to
access the EDI
batch number in
the Event Details
form to view the
associated batch
details from the
Batches view (on
page 172),
Batches view (on
page 823).
EDI
Advanced
EDI
Foundation
EDI_EXECUTE
EDI - Execute
Execute EDI
EDI
Sessions, Batches,
Interchanges, and
Transactions
Advanced
EDI
Foundation
EDI_EXPORT_SEGMENTS
EDI - Export
Segments
Export EDI
segments in an
EDI Interchange
EDI
Advanced
EDI
Foundation
EDI_EXTRACT
EDI - Extract
Extract EDI
interchanges
EDI
Advanced
EDI
Foundation
EDI_FILTER_ADD
EDI Filter Add
Add EDI Filter
EDI
Advanced
EDI
Foundation
EDI_FILTER_DELETE
EDI Filter Delete
Delete EDI Filter
EDI
Advanced
EDI
Foundation
EDI_FILTER_EDIT
EDI Filter Edit
Edit EDI Filter
EDI
Advanced
EDI
Foundation
EDI_FILTER_VIEW
EDI Filter View
EdiFilter - View
only
EDI
Advanced
EDI
Foundation
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
94
Part 1: EDI
EDI Configuration
EDI Privileges
ID
Name
Description
License
Required
Option
Name
EDI_MANAGEMENT
EDI - Set Up
Set up EDI Trading EDI
Partners, Message
Types, Sessions,
Job Schedules,
Filters, and EDI
Upload
Advanced
EDI
Foundation
EDI_POST
EDI - Post
Post EDI
interchanges
EDI
Advanced
EDI
Foundation
EDI_UPLOAD
EDI - Upload
Upload EDI
EDI
Advanced
EDI
Foundation
EDI_BATCH_INTERCHANGE_INSPECTOR
EDI Batch
Interchange Inspect
Inspect EDI
Interchange from
the Batches view
(on page 172),
Batches view (on
page 823).
EDI
Advanced
EDI
Foundation
EDI_BATCH_DENY_UNFILTERED_VIEW
EDI Batch
Prevent a user
Actions - Deny from viewing a list
Unfiltered View of unfiltered EDI
batches in the
Batches view.
EDI
Advanced
EDI
Foundation
EDI_INTERCHANGES_DENY_UNFILTERED_VIEW Interchanges
Prevents a .user
EDI
Actions - Deny from viewing the
Unfiltered View list of unfiltered
EDI interchanges
in the Interchanges
view
Advanced
EDI
Foundation
EDI_TRANSACTIONS_DENY_UNFILTERED_VIEW Transactions
Prevents a user
EDI
Actions - Deny from viewing the
Unfiltered View list of unfiltered
EDI transactions in
the Transactions
view.
Advanced
EDI
Foundation
EDI_TRANSACTIONS_VIEW
EDI
Transactions View
Allows a user to
view the
Transactions
view.
EDI
Advanced
EDI
Foundation
INSPECTOR_EDI_BATCH
EDI Batches Inspect
Inspect EDI
Batches using the
EDI Batch
Inspector
EDI
Advanced
EDI
Foundation
INSPECTOR_EDIT_EDI_BATCH
EDI Batches Edit
Edit EDI Batches
EDI
using the EDI
Batch Inspector
(on page 175), EDI
Batch Inspector
(on page 825)
Advanced
EDI
Foundation
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
95
Part 1: EDI
EDI Configuration
EDI Privileges
ID
Name
Description
MID_EDI
Menu - EDI
INSPECT_VVD_EDI
Vessel
Access the
Inspector - EDI Inbound and
Outbound EDI
panels in the
Vessel Inspector
UPDATE_EDI_BATCH_NOTES
EDI Batch
Actions Update Notes
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Access to main
EDI drop-down
menu
License
Required
Option
Name
EDI
Advanced
EDI
Foundation
VESSEL,
EDI
Vessel,
Advanced
EDI
Foundation
Update notes
EDI
using the Batches
View Actions
menu.
Advanced
EDI
Foundation
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
96
1.4.2 XPS Privileges for EDI
BAPISO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
EDIMEN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
MOVSTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
97
Part 1: EDI
EDI Configuration
XPS Privileges for EDI
1.4.2.1 BAPISO
Type: Privilege
Description: When you set BAPISO to ON and select either BAPLIE import or export from the Actions drop-down list
in the EDI window, XPS displays the check box Ship is ISO bay name compliant in the corresponding dialog.
BAPISO works only in Solo mode because BAPLIES are exported using N4 and not from XPS.
Default: OFF
Module: EDI
1.4.2.2 EDIMEN
Type: Privilege
Description: File
EDI is available.
Default: N
Module: EDI
Area/Option:
• For XPS - System Foundation I or II
1.4.2.3 MOVSTF
Type: Privilege
Description: When you generate projections using the MOVINS file, N4 generates projections based on Stow Factors
if this privilege is enabled.
Default: OFF
Module: EDI
Area/Option: MOVINS Option
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
98
1.4.3 XPS Settings for EDI
EDFHST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
STIFEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
COATRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
99
Part 1: EDI
EDI Configuration
XPS Settings for EDI
1.4.3.1 EDFHST
Type: Setting
Description: Use this setting to specify EDIFACT formats for which you wish to retain a message history (export only).
For example, if you keep a message history for BAPLIE, enter BAPLIE. To specify more than one format, separate the
entries with a tab (text file), or place them in adjacent columns (Excel file). Note: This setting is available only at sites
that license the appropriate EDI options.
To change this setting, see Change XPS settings with the SPARCS settings.txt file in the Navis N4: Setup,
Maintenance, and System Diagnostics Guide.
Module: EDI
Area/Option:
• For XPS: System Foundation II Option
1.4.3.2 STIFEQ
Type: Setting
Description: When enabled, this setting ensures that the STIF equiv file is used for reading and writing STIF files. To
change this setting, see Change XPS settings with the SPARCS settings.txt file in the Navis N4: Setup, Maintenance,
and System Diagnostics Guide.
Default: N
Module: EDI
Area/Option:
• For XPS: System Foundation II Option
1.4.3.3 COATRT
Type: Setting
Description: Set of two-character codes corresponding to IMO container size-type codes for controlled atmosphere
reefer containers. These characters allow inferring a special kind of reefer. This setting is only relevant with MOVINS
files (BAPLIE import happens on the N4 side). To change this setting, see Change XPS settings with the SPARCS
settings.txt file in the Navis N4: Setup, Maintenance, and System Diagnostics Guide.
Module: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
100
1.4.4 EDI Message Settings
You can use the following settings (on page 1042) to specify the Email addresses and servers for outbound EDI
messages sent via Email.
You must configure these settings before you can send outbound EDI messages using Email.
The other EDI settings (on page 118), other EDI settings (on page 850) displayed in the Settings view (on page 1042)
are used only when set for an EDI session. For more information on configuring these EDI settings, see EDI Setting
form (on page 199), EDI Setting form (on page 849).
ARGOACTIVITY006 (EXTRACT_ACTIVITY_FORMAT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI001 (AUTO_CREATION_OF_COMMODITY_CODE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI002 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_VALUE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI003 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_LINE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI004 (EDI_INBOUND_TRANSACTION_SIZE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI005 (USE_FILE_NAME_FOR_SORTING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI006 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_REGEX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI007 (EDI_FACILITY_FOR_POSTING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI008 (EDI_POST_NUM_PARALLEL_JOBS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI009 (EDI_EXTRACT_END_TIME_LATENCY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI010 (EDI_EXTRACT_TRANSACTIONS_ENABLE_FOR_EXPORTER). . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI011 (EDI_MANIFEST_BILLOFLADING_DETACH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI012 (EDI_STOWPLAN_REPLACE_CONTAINERS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI013 (EDI_ADHOC_VESSEL_CREATION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI014 (EDI_ADHOC_ITINERARY_CREATION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI015 (EDI_VESSEL_ID_CONVENTION) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI016 (EDI_UNIQUE_VESSEL_VISIT_ID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI017 (EDI_VERMAS_IDENTIFY_UNITS_BY_CATEGORY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI020 (EDI_OVERRIDE_CARRIER_ITINERARY). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI_EXTRACT001 (EXTRACT_NEW_LINE_WITH_CARRIAGE_RETURN). . . . . . . . . . . . . . . . . . . . . . .
ARGOLINE_LOAD_DISCHARGE_LIST001 (EDI_STAGING_LOADLIST). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOLINE_LOAD_DISCHARGE_LIST002 (EDI_STAGING_DISCHARGELIST). . . . . . . . . . . . . . . . . . . . . . . . .
ARGOLINE_LOAD_DISCHARGE_LIST007 (EDI_LINELOAD_DISCHARGE_LIST). . . . . . . . . . . . . . . . . . . . . .
ARGOMANIFEST011 (MFT_REEVALUATE_TERMINAL_HOLD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOMANIFEST012 (MFT_GENERAL_CARGOLOT_AGAINST_VESSEL). . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOPREADVISE006 (CANCEL_PREADVISE_NOT_RETIRE_UNIT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOSAUDILDP001 (SAUDI_LOAD_PERMIT_PERMISSION). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI024 (CARRIER_SERVICE_VISIBLE_XPS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDIEMAIL001 (EMAIL_FROM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDIEMAIL002 (EMAIL_REPLY_TO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDIFTP001 (FTP_DEFAULT_TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDIFTP002 (FTP_READ_WRITE_TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDISFTP001 (SFTP_READ_WRITE_TIMEOUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG001 (HOST). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG002 (PORT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
103
103
103
103
104
104
104
105
105
107
107
107
107
109
109
110
110
110
111
111
111
111
112
112
112
112
113
113
113
114
114
114
114
115
115
101
Part 1: EDI
EDI Configuration
EDI Message Settings
MSEMAIL_SERVER_CONFIG003 (PROTOCOL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG004 (DEFAULT_EMAIL_ATTACHMENT_CONTENT_TYPE). . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG005 (SMTPS_USER). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI023 (CREATE_EQUIPMENT_OBS_STATUS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG006 (SMTPS_PASSWORD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG007 (TIMEOUT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI026 (USE_VESSEL_LINE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOMANIFEST013 (DELETE_MANIFEST_UPDATE_UNIT_CV). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARGOEDI025 (CHECK_EQUIPMENTTYPE_EQUIVALENT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
........................................................................................
ARGOEDI028 (MFT_VESSEL_VISIT_PHASE_WORKING). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
115
115
116
116
116
116
116
116
117
117
117
117
117
102
Part 1: EDI
EDI Configuration
EDI Message Settings
ARGOACTIVITY006 (EXTRACT_ACTIVITY_FORMAT)
Determines whether the date/time for an ACTIVITY EDI message is extracted using the XML format of the standard
format. Can only be configured at the complex level.
Values:
• EXTRACT_DATE_TIME_IN_STANDARD_FORMAT (Default): To extract the date/time with standard format. For
example, argo:containerArrivedDateTime="2018-02-05 10:29:15">
• EXTRACT_DATE_TIME_IN_XML_FORMAT: To extract the date/time with XML format. For example,
argo:containerArrivedDateTime="2017-12-18T07:05:00".
ARGOEDI001 (AUTO_CREATION_OF_COMMODITY_CODE)
Set it to true if you want N4 to create a commodity if it cannot find one in the system for the given commodity code. Set
it to false if you want N4 to generate an error if commodity is not found for the given commodity code.
Default: true
ARGOEDI002 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_VALUE)
Used for the batch processing mechanism for EDI flat files in N4 that requires either the length or the starting value of
segments, such as the header, body, and the footer. The ARGOEDI002 setting specifies the starting keyword for the
header, each body segment, and the footer of a flat file separated by a comma.
You must set ARGOEDI002 at the EDI session level. This enables you to use different keywords for each session.
For example, if you set ARGOEDI002 as hhh,bbb,fff, "hhh" represents the start of the header, "bbb" represents the
start of each body segment, and "fff" represents the start of the footer.
If the inbound EDI flat file does not have any of the three sections, you must include the keywords for only the sections
present in the flat file.
For example, using the above scenario, if the EDI flat file does not have a header or a footer, you must set
ARGOEDI002 as bbb.
If you do not set either ARGOEDI002 or ARGOEDI003 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_LINE)
(on page 103) for a session processing flat files, N4 does not use batch processing when executing the session.
ARGOEDI003 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_LINE)
Used for the batch processing mechanism for EDI flat files in N4 that requires either the length or the starting value of
segments, such as the header, body, and the footer. The ARGOEDI003 setting specifies the length of the header, each
transaction in the body, and the footer of a flat file separated by a comma.
You must set ARGOEDI003 at the EDI session level. This enables you to use different values for each session.
For example, if you set ARGOEDI003 as 1,2,3, "1" represents the number of segments in the header, "2" represents
the number of segments for each transaction in the body, and "3" represents the number of segments in the footer.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
103
Part 1: EDI
EDI Configuration
EDI Message Settings
After excluding the header and the footer segments, N4 treats the remaining segments in the file as the body. In this
example, two consecutive segments in the body are considered as one transaction.
If you do not set either ARGOEDI002 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_VALUE) (on page 103)
or ARGOEDI003 for a session processing flat files, N4 does not use batch processing when executing the
session.
ARGOEDI004 (EDI_INBOUND_TRANSACTION_SIZE)
Specifies the number of transactions in each commit for an Inbound EDI session using flat files. N4 uses this setting to
split and save an Inbound EDI flat file to the database. For example, if you set ARGOEDI004 as 100, N4 treats each
set of 100 transaction as a batch and saves the same in the database.
You can set this value either for each EDI session or for your site. To set it for an EDI session, use the EDI Session
form (on page 195) Settings tab (on page 199), Settings tab (on page 849). To set it for all EDI sessions
processing flat files, use the Settings view (on page 1042). N4 first checks the EDI session for the setting. If not found,
it uses the value in the Settings view.
Default: 100
Minimum: 100
Maximum: 500
N4 can use ARGOEDI004 only if either ARGOEDI002 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_VALUE)
(on page 103) or ARGOEDI003 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_LINE) (on page 103) is
specified. If neither of these two settings is configured, N4 ignores ARGOEDI004.
ARGOEDI005 (USE_FILE_NAME_FOR_SORTING)
Determines whether to use the time stamp or the file name to pick up files from a mailbox when processing inbound
EDI files. You can set this setting as true if you have multiple files with the same date and time stamp and you want
them to be process alphabetically.
Set it to true if you want N4 to process inbound EDI files based on the filename. In this case, N4 processes the files in
the alphabetical order.
N4 first processes all the file names starting with uppercase characters in the alphabetical order and then processes
the file names starting with lowercase characters, also in the alphabetical order. Therefore, all the files starting with A
through Z are processed before the files starting with a through z.
Set it to false if you want N4 to process inbound EDI files based on the timestamp in the order that the files were
received.
Default: false
ARGOEDI006 (EDI_FLAT_FILE_IDENTIFY_SEGMENTS_BY_REGEX)
The ARGOEDI006 setting specifies the header length, the regular expression to match and find the transactions in the
body, and the footer length in a flat file separated by a comma. If the input file does not have a header or a footer,
provide only the regular expression to match and find the transactions in body. The segments between the first and
second match of the regular expression is treated as one transaction.
For example, if the ARGOEDI006 setting contains the value ' 2, [a-zA-Z][0-9],2', N4 considers 2 as the header length,
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
104
Part 1: EDI
EDI Configuration
EDI Message Settings
[a-zA-Z][0-9] as the regular expression to find transactions in the body, and 2 as the footer length. If the ARGOEDI006
setting contains the value [a-zA-Z][0-9] with neither the header length or the footer length, N4 considers [a-zA-Z][0-9]
as the regular expression to find the transactions in the body.
You also need to override the ARGOEDI004 (EDI_INBOUND_TRANSACTION_SIZE) (on page 104) setting to provide
the number of transactions for each commit instance of a flat file.
Because comma is the delimiter for the header, body, and footer, do not use comma in the regular expression. To post
the correct segments, ensure that you provide the accurate expression to split the segments.
ARGOEDI007 (EDI_FACILITY_FOR_POSTING)
Use this setting to specify the ID of the facility where the EDI messages are posted.
This setting is only for posting EDI using a Groovy code extension and is not handled in N4.
You can override this setting at the EDI session level to use a different facility for different EDI sessions.
ARGOEDI008 (EDI_POST_NUM_PARALLEL_JOBS)
You can use this setting to configure multi-thread processing for inbound EDI sessions that process STOWPLAN,
LOADLIST, and DISCHARGELIST EDI files, or SNX, and all FLATFILE standard message types except
SAUDIMANIFEST and SAUDILDP.
For example, when you set ARGOEDI008 to 8 at the EDI session level and post an inbound BAPLIE file, N4 runs as
many parallel/simultaneous jobs (threads) to post the transactions in the batch for that session. The default value for
ARGOEDI008 is 4.
N4 considers the value of ARGOEDI008 only when you add it to an EDI Session for any of the above message
types.
Default: 4
Minimum: 1
Maximum: 24
The following table lists the message types that use the multi-thread for standard and non-standard files:
Message Types
ACTIVITY
Multi-thread for
Standard files
Multi-thread for
Non-Standard files
No
No
ACKNOWLEDGMENT No
No
APPOINTMENT
No
No
BOOKING
No
No
DISCHLIST
Yes
No
HAZARD
No
No
INVENTORY
Yes
Yes
LOADLIST
Yes
No
MANIFEST
No
No
MCP VESSEL VISIT
No
No
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
105
Part 1: EDI
EDI Configuration
EDI Message Settings
PREADVISE
No
No
RAILCONSIST
No
No
RAILORDER
No
No
RAILWAYBILL
Yes
Yes
RELEASE
No
No
SAUDILDP
No
No
SAUDIMANIFEST
No
No
STOWPLAN
Yes
Yes
SNX
Yes
Yes
VESSEL ACTIVITY
No
No
VERMAS
No
No
See also ARGOBAPLIE005 (EDIPOST_THREAD_COUNT) (on page 134), ARGOBAPLIE005
(EDIPOST_THREAD_COUNT) (on page 865).
Use multi-thread process for EDI flat files
The following table lists the message type that uses the multi-thread for standard and non-standard files. To use the
multi-thread process for EDI flat files, you must add the ARGOEDI008 (EDI_POST_NUM_PARALLEL_JOBS) (on
page 105) setting to the EDI session.
Message Types
ACTIVITY
Multi-thread for
Standard files
Multi-thread for
Non-Standard files
No
No
ACKNOWLEDGMENT No
No
APPOINTMENT
No
No
BOOKING
No
No
DISCHLIST
Yes
No
HAZARD
No
No
INVENTORY
Yes
Yes
LOADLIST
Yes
No
MANIFEST
No
No
MCP VESSEL VISIT
No
No
PREADVISE
Yes
Yes
RAILCONSIST
Yes
Yes
RAILORDER
No
No
RAILWAYBILL
Yes
Yes
RELEASE
No
No
SAUDILDP
No
No
SAUDIMANIFEST
No
No
STOWPLAN
Yes
Yes
SNX
Yes
Yes
VESSEL ACTIVITY
No
No
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
106
Part 1: EDI
Message Types
VERMAS
EDI Configuration
EDI Message Settings
Multi-thread for
Standard files
No
Multi-thread for
Non-Standard files
No
ARGOEDI009 (EDI_EXTRACT_END_TIME_LATENCY)
Specify the time in seconds in the past from which you want the EDI extractor to extract events/EDI transactions.
Customer can also override this setting in at the EDI session level.
For example, if you set ARGOEDI009 as '60' seconds, then the EDI extractor will fetch all the transaction starting from
60 seconds before the current system time to the current system time.
Default: 60
Minimum: 0
Maximum: 300
ARGOEDI010 (EDI_EXTRACT_TRANSACTIONS_ENABLE_FOR_EXPORTER)
Set ARGOEDI010 to true if you want N4 to insert data into the edi_transaction table when extracting STOWPLAN and
INVENTORY EDI messages. The default value for ARGOEDI010 is false.
ARGOEDI011 (EDI_MANIFEST_BILLOFLADING_DETACH)
The ARGOEDI011 setting is used when posting the EDI 309 Manifest message with Delete message function. If you:
• Set this to true, N4 only detaches the units from the bill of lading and does not delete the bill of lading from the
database.
In this case, N4 records the UNIT_BOL_DETACHED event in the event history of the BL and the
UNIT_CANCEL_RESERVE event in the event history of the units.
N4 does not detach the units if the units are already Departed or Retired.
• Set this to false, N4 deletes the bill of lading from the database.
In this case, since there is not BL record, N4 records only the UNIT_CANCEL_RESERVE event in the event history
of the units.
Default: false
Notes
• For Inbound EDI sessions, this setting works only with the MANIFEST Message Class option and only at the EDI
Session level.
ARGOEDI012 (EDI_STOWPLAN_REPLACE_CONTAINERS)
Set to true if you want to replace the existing stow containers in <n4, with the stow containers in the EDI file.
Set to false if you want N4 to add the new containers from the EDI file to the already stowed containers.
N4 currently does not support any message functions for the stowplan messages.
Default: false
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
107
Part 1: EDI
EDI Configuration
EDI Message Settings
If you are posting an updated or amended stowplan (for example, BAPLIE) file, N4 takes into consideration the
option(s) you selected in the EDI Load form (on page 225) before posting the EDI file.
For example, assume you posted an original BAPLIE file with 10000 containers. Your terminal later receives an
amended BAPLIE file for the same vessel visit with with following updates:
1. Container count includes 99 new containers that were not present in the original file
2. Position and weight updates are received for 100 existing containers
If you selected the the Additions Only and Positions Only check boxes in the EDI Load form (on page 225) before
posting the amended EDI file, N4 updates the existing stow containers as follows:
• Containers posted previously through the original BAPLIE file that are NOT present in the amended file are deleted
• New containers present in the amended file are created (99 containers)
• The stow position for 100 containers provided in the amended file is updated (since Position Only checkbox was
marked in the EDI Load form)
• The weight for 100 containers provided in the amended file is retained
The image below is a representation of how this EDI setting, along with the option(s) you select in the EDI Load form
(on page 225), impacts data in N4
In the examples below, read
as,
C1 - Container number
Pos1 - Stow position
16000 - Container weight
HKG - POD
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
108
Part 1: EDI
EDI Configuration
EDI Message Settings
ARGOEDI013 (EDI_ADHOC_VESSEL_CREATION)
Using this setting ARGOEDI013 N4 enables you to add a new vessel visit in the Vessel Visit view during the EDI
IFTSAI message posting process.
If set to ALLOWED, N4 allows you to add a new vessel visit during the EDI IFTSAI message posting process.
If set to NOT_ALLOWED, N4 allows you to add the existing vessel visit during the EDI IFTSAI message posting
process. However, when:
• Both the vessel and vessel visit does not exist in the application, then N4 displays "Adhoc vessel creation is not
allowed" error message.
• Vessel exist and vessel visit does not exist in the application, then N4 creates the vessel visit with the existing
vessel.
Default: NOT_ALLOWED
ARGOEDI014 (EDI_ADHOC_ITINERARY_CREATION)
Using this setting ARGOEDI014 N4 enables you to add a routing point to the itinerary during the EDI IFTSAI message
posting process.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
109
Part 1: EDI
EDI Configuration
EDI Message Settings
If set to ALLOWED, N4 allows you to add a routing point to the itinerary during the EDI IFTSAI message posting
process.
Default: Not Allowed
ARGOEDI015 (EDI_VESSEL_ID_CONVENTION)
When posting an IFTSAI message, this setting determines whether you create the vessel ID based on either the call
sign or the Lloyds number included in the IFTSAI message.
• When posting multiple IFTSAI messages against the same vessel, N4 first tries to identify the vessel based on
setting ARGOEDI015. If the setting value is not provided in the posting EDI IFTSAI message then N4 displays an
error message.
• If the setting value is provided in the posting EDI IFTSAI message, then N4 tries to find the vessel based on the
setting value. If the vessel does not exist, then N4 creates a new vessel but displays a warning message.
Values:
• CALLSIGN: Create the Vessel ID based on the call sign in the EDI IFTSAI message.
• LLOYDS (default): Create the Vessel ID based on the Lloyds ID in the EDI IFTSAI message.
ARGOEDI016 (EDI_UNIQUE_VESSEL_VISIT_ID)
This setting determines how you name the vessel visit ID posted via the IFTSAI message.
Valid values:
• MMYY (MonthYear) (Default) N4 truncates the vessel ID to four characters and adds the current system month and
year. For example, <vessel ID 4 characters > + <MMYY>
• HHMM (HourMonth) - N4 truncates the vessel ID to four characters and adds the current system month and year.
For example, <vessel ID 4 characters > + <HHMM>
• SSS (milliseconds) - N4 truncates the vessel ID to five characters and adds the current system milliseconds. For
example, <vessel ID 5 characters > + <SSS>
• MMYY. N4 truncates the vessel ID to four characters and adds the current system month and year. For example,
<vessel ID 4 characters > + <MMYY>
ARGOEDI017 (EDI_VERMAS_IDENTIFY_UNITS_BY_CATEGORY)
When you post a VERMAS message, this setting determines whether N4 should update the VGM details to an existing
unit or create a new unit and then update the VGM details to the new unit. You need to set this setting at the EDI
session level.
Valid values:
• EXISTING_EXPORT_UNIT - When you post a VERMAS message, the EXISTING_EXPORT_UNIT value results in
the following:
▪ For an existing import/transshipment active unit without the category value (null), N4 creates a new unit with
VERMAS details with the category Export Advised/Advised.
▪ For an existing import/transshipment active unit with the category value 'Tranship/Import', N4 creates a new unit
with VERMAS details with the category Tranship/Import Advised/Advised.
▪ For an existing import/transshipment unit with the category value 'Import/Tranship', N4 updates the existing with
VERMAS details.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
110
Part 1: EDI
EDI Configuration
EDI Message Settings
• EXISTING_ACTIVE_UNIT - When you post a VERMAS message, the EXISTING_ACTIVE_UNIT value results in
the following:
▪ For an existing import/transshipment active unit without a category value (null), N4 updates the existing unit with
VERMAS details.
▪ For an existing import/transshipment unit with the category value 'Tranship/Import', N4 creates a new unit with
VERMAS details with the category Tranship/Import Advised/Advised.
▪ For an existing import/transshipment unit with the category value 'Import/Tranship', N4 updates the existing with
VERMAS details.
• CARRIER_MISMATCH_ERROR - When you post a VERMAS message, the CARRIER_MISMATCH_ERROR value
results in the following:
▪ If the carrier visit of the existing unit matches the carrier visit in the VERMAS EDI message, N4 updates the
existing Active/Advised unit with VGM information.
▪ If the carrier visit of the existing unit does not match the carrier visit in the VERMAS EDI message, N4 does not
update the existing Active/Advised unit with VGM information and displays “Cannot post the VERMAS file. The
Carrier Visit of the existing unit and the unit in the VERMAS file do not match” error message.
ARGOEDI020 (EDI_OVERRIDE_CARRIER_ITINERARY)
This setting determines whether to retain the itinerary of the existing carrier service, or override it with the itinerary in an
EDI file being processed. The default value is OVERRIDE_ITINERARY.
ARGOEDI_EXTRACT001 (EXTRACT_NEW_LINE_WITH_CARRIAGE_RETURN)
Determines which delimiter is used in the EDI extract output.
Set to true if you want the extracted EDI output to use "\r\n" as the new line character as carriage return and line feed
(hexa value Od and Oa).
For the X.12 standard: The "\r\n" delimiter will be added to the extracted file only if the setting is true at complex level
and the edi session has "\n" as the delimiter.
For EDIFACT: To add the "\r\n" delimiter to the extracted file, the setting needs to be true at the complex level, but
setting the EDI session with the "\n" delimiter is not needed.
Default: false
ARGOLINE_LOAD_DISCHARGE_LIST001 (EDI_STAGING_LOADLIST)
Navis has deprecated the ARGOLINE_LOAD_DISCHARGE_LIST001 setting. You must use
ARGOLINE_LOAD_DISCHARGE_LIST007 (EDI_LINELOAD_DISCHARGE_LIST) (on page 112) setting to
create a record in the Line LoadList view during EDI posting.
ARGOLINE_LOAD_DISCHARGE_LIST002 (EDI_STAGING_DISCHARGELIST)
Navis has deprecated the ARGOLINE_LOAD_DISCHARGE_LIST002 setting. You must use the
ARGOLINE_LOAD_DISCHARGE_LIST007 (EDI_LINELOAD_DISCHARGE_LIST) (on page 112) setting to
create a record in the Line DischargeList view during EDI posting.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
111
Part 1: EDI
EDI Configuration
EDI Message Settings
ARGOLINE_LOAD_DISCHARGE_LIST007 (EDI_LINELOAD_DISCHARGE_LIST)
Use this setting ARGOLINE_LOAD_DISCHARGE_LIST007 to create a record in the Units view, Line LoadList view
and Line DischargeList view respectively during EDI posting process by selecting any of the following values:
• CREATE_LOADLIST_DISCHARGELIST_AND_UNITS - Creates a record in the Line Loadlist or Line DischargeList
views and the Units view. This results in no discrepancies since the same data is getting posted to the Loadlist/
DischargeList views as well as the Units view.
• CREATE_LOADLIST_DISCHARGELIST_ONLY -If the unit is already available in the Units view, N4 creates a
record in the line load/discharge list only, with no updates to the Units view. If there is a difference between the Units
view, Line Loadlist, and Line DischargeList views, N4 displays the discrepancies against the Disch.list.Discrepancies
and Loadlist Discrepancies tabs respectively, in the Vessel Visit Inspector. If the unit does not exist, then N4 creates
the unit and an entry in Line Loadlist and Line Dischargelist views. See also, Loadlist Discrepancies tab or Disch.list
Discrepancies tab.
• CREATE_UNITS_ONLY (Default) - The EDI updates unit records only. Line loadlist/Line DischargeList entities are
not created. This will not create a discrepancy, since there will be no record created in either the Loadlist or
DischargeList views that would conflict with the records in the Units view.
N4 updates the category of an Active Import Container in the yard to Transship only if you set
ARGOLINE_LOAD_DISCHARGE_LIST007 for individual EDI sessions and not at the global level in the
Settings view (on page 1042).
If you are using either of the deprecated ARGOLINE_LOAD_DISCHARGE_LIST001
(EDI_STAGING_LOADLIST) (on page 111) or ARGOLINE_LOAD_DISCHARGE_LIST002
(EDI_STAGING_DISCHARGELIST) (on page 111) settings (these settings are not in use anymore), you
must configure the setting ARGOLINE_LOAD_DISCHARGE_LIST007
(EDI_LINELOAD_DISCHARGE_LIST) with the options mentioned above to achieve the same results.
ARGOMANIFEST011 (MFT_REEVALUATE_TERMINAL_HOLD)
Determines whether N4 allows the released quantity to be greater than the manifested quantity when posting a
RELEASE or MANIFEST EDI message type.
If set to true, then N4 releases all holds when the release quantity is greater than the manifested quantity.
if set to false (default), then N4 applies the default terminal hold when the release quantity is greater than the
manifested quantity.
ARGOMANIFEST012 (MFT_GENERAL_CARGOLOT_AGAINST_VESSEL)
Determines whether N4 should manifest a cargo lot against a vessel when posting a MANIFEST EDI message type.
This EDI setting is available for an Inbound MANIFEST EDI session.
You can set ARGOMANIFEST012 to one of the following values:
• MANIFEST_GENERAL_CARGOLOT (default): To manifest a cargo lot against a vessel through MANIFEST EDI
message.
• DO_NOT_MANIFEST_GENERAL_CARGOLOT: To not manifest a cargo lot against a vessel through MANIFEST
EDI message.
ARGOPREADVISE006 (CANCEL_PREADVISE_NOT_RETIRE_UNIT)
Determines whether N4 must retire a unit when you cancel a pre-advise against a booking.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
112
Part 1: EDI
EDI Configuration
EDI Message Settings
You may cancel a pre-advise against a booking either from the Pre-advised tab in the Booking Item form or using the
PREADVISE EDI message with a delete function for the booking, which can be message function "D", "E", or "R".
You can set ARGOPREADVISE006 to one of the following values:
• ACTIVE_ONLY: N4 does not retire a unit if it is in the Active state when you cancel a pre-advise. However, it does
retire a unit if it is in the Advised state when you cancel the pre-advise.
• ACTIVE_AND_ADVISED: N4 does not retire a unit if it is in the Active state or the Advised state when you cancel
a pre-advise.
If you do not override the setting, N4 retires a unit, regardless of the visit state of the unit, when you cancel a preadvise. This is the default behavior for the setting.
ARGOSAUDILDP001 (SAUDI_LOAD_PERMIT_PERMISSION)
Specify the permissions (comma-separated) that you want N4 to grant for the units specified in a Saudi Load Permit
SAUDILDP EDI message when processing this EDI message.
Before granting these permission(s), N4 validates that all of the cargo/BL items attached to the unit have a load permit
number in the Export Rel Nbr column of the Cargo Lots tab.
ARGOEDI024 (CARRIER_SERVICE_VISIBLE_XPS)
When you post a DISCHARGELIST (COPRAR) EDI message, N4 sends the carrier service of the inbound carrier to
XPS for import containers that do not have their outbound carrier information specified in the file. Use ARGOEDI024 to
determine whether to update the inbound import containers in XPS with the inbound, or outbound carrier service. The
available options for ARGOEDI024 are:
• INBOUND_CARRIER_SERVICE
• OUTBOUND_CARRIER_SERVICE
EDIEMAIL001 (EMAIL_FROM)
Specify the From email address for your site.
N4 validates the email address format and accepts only the email addresses that are entered in the
'username@mailprovider.domain' format (for example: john@navis.com). 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: john@navis.c).
• Has a Domain name ending with a numeric domain identifier (for example: john@navis.co2).
N4 allows you to use an apostrophe anywhere in the recipient's name in an email address, such as
O'Donnell@xyz.com.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
113
Part 1: EDI
EDI Configuration
EDI Message Settings
EDIEMAIL002 (EMAIL_REPLY_TO)
Specify the Reply To email address for your site.
N4 validates the email address format and accepts only the email addresses that are entered in the
'username@mailprovider.domain' format (for example: john@navis.com). 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: john@navis.c).
• Has a Domain name ending with a numeric domain identifier (for example: john@navis.co2).
N4 allows you to use an apostrophe anywhere in the recipient's name in an email address, such as
O'Donnell@xyz.com.
EDIFTP001 (FTP_DEFAULT_TIMEOUT)
Specify the timeout period (in milliseconds) after which an EDI process stops trying to create an FTP connection. If an
EDI process is taking too long to create an FTP connection, this setting determines when to stop that process
preventing the slowdown of other processes.
Default: 60000
Minimum: 0
Maximum: 300000
EDIFTP002 (FTP_READ_WRITE_TIMEOUT)
Specify the default socket timeout (in milliseconds) after which an EDI process stops waiting for data. If there is a
communication failure and a delay in getting the required information, a timeout occurs in the default socket and N4
displays a SocketTimeOutexception error message. A value of zero for the FTP_READ_WRITE_TIMEOUT setting is
interpreted as an infinite timeout.
Default: 60000
Minimum: 0
Maximum: 300000
EDISFTP001 (SFTP_READ_WRITE_TIMEOUT)
For EDI files posted via SMTP, specify the default socket timeout (in milliseconds) after which an EDI process (reading
and writing via SFTP) stops waiting for data. If there is a communication failure and a delay in getting the required
information, a timeout occurs in the default socket and N4 displays a SocketTimeOutexception error message. A value
of zero for the FTP_READ_WRITE_TIMEOUT setting is interpreted as an infinite timeout.
Default: 60000
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
114
Part 1: EDI
EDI Configuration
EDI Message Settings
Minimum: 0
Maximum: 300000
MSEMAIL_SERVER_CONFIG001 (HOST)
Specify the address of the email server. You can specify the IP address or the DNS name, such as smtp.navis.com,
of the email server.
The email server must be installed with an SSL certificate and configured to support TLS version 1.0 for encryption. It
does not work with SSL 3.0, TLS 1.1, or TLS 1.2.
MSEMAIL_SERVER_CONFIG002 (PORT)
Specify the port for the email server. The port number must be configured in the Yard level.
The default port is 25; however, if you are using a different port for the email server, specify that in this setting.
Protocol
Port
smtp
25
smtps
587
IMAP
143
POP3
110
MSEMAIL_SERVER_CONFIG003 (PROTOCOL)
Specify the email protocol, such as smtp, used by the email server configured for your site.
N4 supports Simple Mail Transfer Protocol (SMTP) over Secure Sockets Layer (SSL). See
MSEMAIL_SERVER_CONFIG005 (SMTPS USER) (on page 116) and MSEMAIL_SERVER_CONFIG006
(SMTPS_PASSWORD) (on page 116).
• N4 email notification works with either smtp or smtps protocol on the Yard level. Enter the protocol in lower case
smtp or smtps. (It will not work in upper case.)
• The email client can use either protocol POP3 with port 110 or IMAP with port 143 for email retrieval. The protocol
IMAP is only for retrieving emails.
MSEMAIL_SERVER_CONFIG004 (DEFAULT_EMAIL_ATTACHMENT_CONTENT_TYPE)
Specify the content-type for an email attachment, which you want N4 to set as default.
You can select from one of the following options:
• MULTIPART_MIXED: To send emails with files (such as pictures or easily readable files) that have different Content
Type headers.
• MULTIPART_RELATED (Default): To send emails with message parts that are related to each other and a
component of the whole message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
115
Part 1: EDI
EDI Configuration
EDI Message Settings
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS)
Set to 'True' to enable the use of the STARTTLS command (if supported by the server) to switch the connection to a
TLS-protected connection.
When the value for this setting is 'True', MSEMAIL_SERVER_CONFIG003 (PROTOCOL) (on page 115) must
be set to 'smtp'.
Use the settings MSEMAIL_SERVER_CONFIG005 (on page 116) and MSEMAIL_SERVER_CONFIG006 (on page
116) to define the User ID and Password to access the SSL/TLS server.
MSEMAIL_SERVER_CONFIG005 (SMTPS_USER)
Specify the User ID to access the remote SMTPS server over SSL. (This is different from the N4 user.)
ARGOEDI023 (CREATE_EQUIPMENT_OBS_STATUS)
Add ARGOEDI023 to the EDI Session and set it to ALLOWED to create new equipment in N4 through Import SNX or
EDI, with the life cycle state 'OBS' (obsolete).
For example, when you create new equipment (chassis, container, accessory) through Import SNX or by posting an
EDI file (message class Inventory or SNX), N4 creates the new equipment with the life cycle state as OBS (obsolete) if
mentioned in the file.
By default, ARGOEDI023 is set to NOT ALLOWED and N4 does not create the new equipment if the life cycle state
mentioned in the file is OBS (obsolete).
You can view an equipment's life cycle state in the Containers view.
MSEMAIL_SERVER_CONFIG006 (SMTPS_PASSWORD)
Specify the password for the remote SMTPS server over SSL. (This is the password for the User ID you entered for
MSEMAIL_SERVER_CONFIIG005 (SMTPS_PASSWORD) setting.)
MSEMAIL_SERVER_CONFIG007 (TIMEOUT)
Specify the time-out (in milliseconds) for attempting to re-connect to the email server when the email server is not
responding to the client connection request. The default value is 15000 millisecond (15 seconds) before timing out, and
creates an entry in the log (type = error).
MSEMAIL_SERVER_CONFIG008 (ENABLE_STARTTLS)
Set to 'True' to enable the use of the STARTTLS command (if supported by the server) to switch the connection to a
TLS-protected connection.
When the value for this setting is 'True', MSEMAIL_SERVER_CONFIG003 (PROTOCOL) (on page 115) must
be set to 'smtp'.
Use the settings MSEMAIL_SERVER_CONFIG005 (on page 116) and MSEMAIL_SERVER_CONFIG006 (on page
116) to define the User ID and Password to access the SSL/TLS server.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
116
Part 1: EDI
EDI Configuration
EDI Message Settings
ARGOEDI026 (USE_VESSEL_LINE)
You can use this setting to determine the line operator for a vessel visit created as a result of an IFTSAI message.
• true (default value) - N4 creates a vessel visit using the vessel operator specified in N4.
• false - N4 creates a vessel visit using the line operator from the EDI message. Also, N4 adds an entry for the vessel
operator in the EDI message to the vessel visit lines (Vessel Visit Inspector > Lines tab).
ARGOMANIFEST013 (DELETE_MANIFEST_UPDATE_UNIT_CV)
You can use this setting to determine whether N4 updates the existing unit's inbound visit as GEN_VESSEL on posting
the Delete message for the 310 Manifest EDI message.
This setting is applicable only for Advised units.
If set to true, N4 updates the unit's inbound declared visit to GEN_VESSEL.
If set to false (default), N4 does not update the unit's inbound declared visit to GEN_VESSEL.
ARGOEDI025 (CHECK_EQUIPMENTTYPE_EQUIVALENT)
You can use this setting to determine whether to check for the Equipment Type Equivalent or not when reserving units
against an ELO, an EDO, or a Booking when you pre-advise a container.
For example, assume you have UNIT01 with ISO 2200. If you have defined equipment type equivalents for 2200 and
2210 ISO types, then if ARGOEDI025 is set to true, you can reserve UNIT01 against an ELO, EDO, or booking that's
defined for the 2210 ISO type.
If set to true, N4 checks for equipment type equivalents when reserving units against an ELO, EDO or booking.
If set to false (default), N4 does not check for the equipment type equivalents and displays an error message in the
Batches view (on page 172), Batches view (on page 823)/EDI Batch Inspector (on page 175), EDI Batch Inspector
(on page 825) if a unit with an ISO equivalent is reserved against an order.
You can use this setting to determine whether to record the discrepancies for the units posted in the BAPLIE message
and missed in the COPRAR Load list or Discharge list file in the Vessel Visit Inspector Loadlist Discrepancies tab
or Disch.list Discrepancies tab.
By default, N4 records the discrepancies in the Vessel Visit Inspector
Discrepancies tab for the missing units.
Loadlist Discrepancies tab or Disch.list
If you override the above setting, at the Global level or the EDI Session level, and select the
AVOID_CREATE_MISSING_UNITS option, N4 does not record the discrepancies for the missing units in the Vessel
Visit Inspector Loadlist Discrepancies tab or Disch.list Discrepancies tab.
ARGOEDI028 (MFT_VESSEL_VISIT_PHASE_WORKING)
You can use this setting to determine whether N4 must allow you to post a SAUDIMANIFEST EDI message when the
vessel visit is in the Working phase.
Values:
• ALLOWED (Default) – N4 allows you to post the SAUDIMANIFEST t EDI message.
• NOT_ALLOWED – N4 displays an error message and does not allow you to post the SAUDIMANIFEST EDI
message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
117
1.4.5 EDI Session Settings
The following sections list the various EDI settings that you can configure for individual EDI sessions from the EDI
Session form Settings tab (on page 199), Settings tab (on page 849). For more information on EDI settings
configured in the Settings view (on page 1042), see EDI settings (on page 101) in the online help or the Navis N4:
Reference Guide.
ACKNOWLEDGEMENT EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
APPOINTMENT EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DISCHLIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound INVENTORY UPDATES EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound BOOKING EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound HAZARD EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound MANIFEST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound PREADVISE EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound RAILWAYBILL EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound STOWPLAN EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound STOWPLAN EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOADLIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound ACTIVITY EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound VESSELACTIVITY EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RAILCONSIST EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RAILORDER EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RELEASE EDI settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
119
121
123
123
130
130
132
133
134
138
140
142
144
144
145
146
118
Part 1: EDI
EDI Configuration
EDI Session Settings
1.4.5.1 ACKNOWLEDGEMENT EDI settings
The following EDI settings are available for an ACKNOWLEDGEMENT EDI session:
ARGOACKNOWLEDGEMENT001 (ACK_ACKNOWLEDGE_BY_INTERCHANGE)
Set it to true if you want N4 to generate EDI acknowledgement at the interchange level rather than for each transaction
in the interchange.
The valid acknowledgement statuses are: ACCEPTED and REJECTED.
When you enable the ARGOACKNOWLEDGEMENT001 setting,N4 extracts all transactions, regardless of the status,
for a single interchange.
The default value for ARGOACKNOWLEDGEMENT001 is false; therefore, N4 generates the acknowledgement at the
transaction level, by default.
If you want N4 to extract only ERROR transactions, then you need to add an EDI session filter criteria for
Status = ERROR.
1.4.5.2 APPOINTMENT EDI settings
The following EDI settings are available for an inbound or an outbound APPOINTMENT EDI session:
ARGOAPPOINTMENT002 (HAZARD_MATCH)
Set it to true (default) if you want N4 to match the hazards in appointment with existing advised unit.
Set it to false, so that N4 suppresses the comparison of hazards received through an EDI message against the
hazards present in the existing unit.
ARGOAPPOINTMENT003 (ALLOW_FOREIGN_VESSEL_VISIT)
Set it to true if you want N4 to create a vessel visit for a non operational facility if the visit specified in a
APPOINTMENT EDI message is not in N4.
ARGOAPPOINTMENT004 (UPDATE_UNIT_IN_YARD)
Set it to true if you want N4 to update active units in the facility when processing an APPOINTMENT EDI message for
receive gate transactions.
Set it to false (default) if you do not want N4 to update active units that are in the facility. However, N4 does update
non-active units prior to arrival (not in the facility).
ARGOAPPOINTMENT005 (ARGOAPPOINTMENT_CREATE_ON_ERROR)
Set ARGOAPPOINTMENT005 to True and post the EDI message with an appointment, if there are business task
failures, N4 still creates the appointment.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
119
Part 1: EDI
EDI Configuration
EDI Session Settings
If you set ARGOAPPOINTMENT005 to False (default) N4 does not allow the creation of the appointments from the
EDI message if any of the business tasks fail.
If you use code extensions to periodically evaluate the status of appointments, you can set
ARGOAPPOINTMENT005 (ARGOAPPOINTMENT_CREATE_ON_ERROR) to True for your environment.
Otherwise, you must leave ARGOAPPOINTMENT005 as False.
The setting ARGOAPPOINTMENT005 allows to create an appointment even if the validation fails and N4 displays
errors. For example, set the setting to False and post an appointment EDI message with an invalid order number for a
transaction,
N4 fails to create an appointment creation is failed with error message in batches.
When you set the setting ARGOAPPOINTMENT005 to True and repost the EDI batch, then N4 completes the batch
and creates an appointment.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
120
Part 1: EDI
EDI Configuration
EDI Session Settings
1.4.5.3 DISCHLIST EDI settings
The following EDI settings are available for an inbound or an outbound DISCHLIST EDI session:
ARGODISCHLIST001 (POST_PERMISSIONS_DISCH)
Lists the permissions that you want N4 to apply to the containers in the EDI message during EDI processing.
To include a permission, you can do any of the following:
• Double-click the permission in the Excluded field.
• Select the permissions in the Excluded field and click
.
Press and hold the Shift key to select adjoining permissions and the Ctrl key to select non-adjoining permissions.
• Use your mouse to drag and drop the permission from the Excluded field to the Included field.
• Click
to include all permissions.
To exclude a permission, you can do any of the following:
• Double-click the permission in the Included field.
• Select the permissions in the Included field and click
.
• Use your mouse to drag and drop the permission from the Included field to the Excluded field.
• Click
to exclude all permissions.
ARGODISCHLIST002 (DISCH_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to validate the equipment type provided by the DISCHLIST EDI message and generate an
error if the equipment type is not found.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
121
Part 1: EDI
EDI Configuration
EDI Session Settings
ARGODISCHLIST003 (DISCH_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
ARGODISCHLIST004 (ACCEPT_DISCHARGE_LIST_FOR_COMPLETED_VESSEL)
ARGODISCHLIST004 determines whether to process a discharge list if the vessel is in either the Departed,
Completed, or Closed state. This setting must be added in the Settings tab of the EDI Session form.
Set it to true if you want N4 to process the discharge list even after the vessel changes to either of these phases:
Departed/Completed/Closed.When set to true, N4 allows discharge list updates even after the inbound vessel is
departed but only until the unit itself departs the terminal.
Set it to false (default) if you do not want N4 to process the discharge list when the vessel phase is Departed/
Completed/Closed and to display an error message instead.
Regardless of the value set for ARGODISCHLIST004, N4 does not process a discharge list when the vessel
visit phase is Archived and displays an error.
ARGODISCHLIST005 (DISCH_EDI_ACCURATE)
When you post the discharge list EDI, N4 updates the category of the import containers based on the Port of Discharge
(POD).
• When set to NOT_ACCURATE, if the container category is Import and if the POD of the container is not the current
port, then N4 updates the category as Transshipment.
• When set to ACCURATE, if the container category is Import and if the POD of the container is not the current port,
then N4 retains the category as Import.
Default:NOT_ACCURATE.
ARGODISCHLIST006 (EDI_VALIDATE_OB_CARRIER_DISCHARGELIST)
When you post the discharge list EDI for transship units, N4 validates the O/B Carrier in the EDI based on the
following options:
WARN_AND_USE_GENERIC – If the O/B Carrier in the EDI is invalid and when you select the
WARN_AND_USE_GENERIC option, N4 displays a warning message and updates the O/B carrier as GEN_VESSEL.
The default option is WARN_AND_USE_GENERIC.
REJECT_IF_INVALID – If the O/B Carrier in the EDI is invalid and when you select the REJECT_IF_INVALID option,
N4 rejects the EDI message.
For example, when you send O/B Carrier information on discharge list for tranship units and if the particular O/B
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
122
Part 1: EDI
EDI Configuration
EDI Session Settings
vessel visit does not exist in N4, then N4 validates the O/B Carrier information in the discharge list based on the setting
options, displays an error message and does not posts the EDI for the unit.
1.4.5.4 Inbound INVENTORY UPDATES EDI settings
The following EDI settings are available for an inbound INVENTORY UPDATES EDI session:
ARGOCORE014 (INV_UPDATES_ALLOW_FOREIGN_VESSEL_VISIT)
Use this setting when you post the COHAOR (Inventory Updates) EDI message to determine whether N4 must
automatically create a new vessel visit.
When set to True, N4 automatically creates new vessel visits when you post the EDI.
The default value for this setting is False.
ARGOCORE015 (INV_UPDATES_EQUIP_CATEGORY)
Use this setting when you post the COHAOR (Inventory Updates) EDI message to determine whether the category in
the EDI is accurate.
When set to True, N4 considers the category in the EDI as accurate.
The default value for this setting is False.
Inbound BOOKING EDI settings
The following EDI settings are available for an inbound BOOKING EDI session:
ARGOBOOKING001 (BKG_IMPORT_TO_TRANSSHIP)
Set it to true of you want N4 to change import containers to transship containers.
Default: false
ARGOBOOKING002 (BKG_UPDATE_CONTAINERS)
Set it to true if you want to allow the following container updates from EDI processing:
• Create new pre-advised containers
• Update existing containers to associate them to the booking
You must configure ARGOBOOKING002 at the EDI session level and not at the global level in the Settings view (on
page 1042). For more information on inbound processes for BOOKING EDI messages, see Inbound BOOKING EDI
processes (on page 31), Inbound BOOKING EDI processes (on page 181), Inbound BOOKING EDI processes (on
page 831) in the online help or on the NCC.
ARGOBOOKING004 (BKG_ALLOW_FOREIGN_VESSEL_VISIT)
When set to true, this setting automatically creates a foreign vessel visit if the vessel already exists in N4 and the EDI
facility is non-operational.
You must configure ARGOBOOKING004 at the EDI session level. If you configure ARGOBOOKING004, in the
Settings view (on page 1042), N4 does not use the setting.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
123
Part 1: EDI
EDI Configuration
EDI Session Settings
ARGOBOOKING005 (BKG_RELAY_FCY_FOR_NON_OPRNL_FCY)
Specify the name of the operational "relay" facility, or facilities, a unit passes through on its way to a non operational
facility.
ARGOBOOKING006 (BKG_EQUIP_CATEGORY)
Set it to true if you want N4 to post the category specified in the EDI file. If set to true, the category must be present in
the EDI file. Otherwise, the following error occurs: "Booking category is required".
Set it to false if you want N4 to derive the category of the container based on the booking Port of Load (POL) and the
facility port. If set to false, to include the domestic category the INVROUTING003
(SUPPORTS_DOMESTIC_CATEGORY) setting must be set to true. Otherwise, the default category is EXPORT.
ARGOBOOKING007 (BKG_USE_UNIT_IN_FACILITIES)
Define a list of facilities where units created through other sources may possibly exist. When defined, N4 looks in to the
listed facilities to check if a specific unit exists already. If it does, N4 updates that unit instead of creating a new unit in
the current facility.
ARGOBOOKING008 (BKG_EQUIP_TEMP_FOR_EMPTY)
Set it to true if you want N4 to update the temperature of an empty container with the temperature provided in the EDI
file.
Set it to false if you do not want N4 to update the temperature of an empty container.
ARGOBOOKING009 (BKG_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
ARGOBOOKING010 (BKG_AUTO_GENERATE_BKGITEM_SEQ_NBR)
Set it to true if you want N4 to auto generate a sequence number and assign it to the SeNbr field in the Equipment
Order Item if the sequence number was not received in the BOOKING message.
ARGOBOOKING011 (BKG_ALLOW_SHIPPER_VIEW_UNASSOCIATED_ORDERS)
N4 setting ARGOBOOKING011 (BKG_ALLOW_SHIPPER_VIEW_UNASSOCIATED_ORDERS) determines whether
N4 allows shippers access to unassociated orders in the Bookings form to pre-advise export containers. It can be used
for both bookings and rail orders.
When set to true, N4 displays the logged in shipper's bookings or rail orders and also the unassociated bookings or rail
orders in the Booking form.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
124
Part 1: EDI
EDI Configuration
EDI Session Settings
When set to false, N4 displays only the logged in shipper's bookings or rail orders and does not display the
unassociated bookings or rail orders in the Booking form.
Default: true
ARGOBOOKING012 (BKG_PROPAGATE_HAZARDS_TO_THE_UNIT)
You can use the setting ARGOBOOKING012 (BKG_PROPAGATE_HAZARDS_TO_THE_UNIT) for N4 to propagate
the hazardous details of the unit level.
The two values for the setting are as follows:
• BOOKING_HAZARDS: When you post a COPARN booking message for a unit, and there are no unit-level hazards
in the incoming message, N4 applies all the booking level hazards to the units. However, any equipment level
hazards that are included in the message are applied to the unit records, as opposed to the booking hazards.
• UNIT_HAZARDS (default): When there are no unit-level hazards, N4 does not apply the booking-level hazards.
For example, when you set the setting ARGOBOOKING012 to BOOKING_HAZARDS
Case 1: DGS segments under Booking only (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with DGS segment under booking where no DGS segment exists below the EQD
segment (no hazard at equipment level):
▪ N4 creates the booking with given hazard.
▪ N4 creates the unit with hazard from the booking
Case 2: DGS segments under Equipment only (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with no DGS segment under booking with the DGS segment below the EQD segment
(Hazard at equipment level):
▪ N4 creates the booking without any hazard.
▪ N4 creates the unit with given hazard (equipment level)
Case 3: DGS segments under both Booking and Equipment (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with DGS segment under booking where a second DGS segment exists below the
EQD segment (Hazard at equipment level):
▪ N4 creates the booking with given hazard (booking level).
▪ N4 creates the unit with hazard from the unit only.
Case 4: DGS segments under both Booking and Equipment (Null value under Equipment level)
When you posted a COPARN EDI with DGS segment under booking where a second DGS segment exists below the
EQD segment with empty values (null Hazard at equipment level):
▪ N4 creates the booking with given hazard (booking level).
▪ N4 creates the unit with hazard from the booking.
Case 5: DGS segments under Booking only, where Equipment already has a hazard
▪ Pre-advised an Export container and added Hazard A.
▪ Post a COPARN EDI for above container with DGS segment, Hazard B, under booking.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
125
Part 1: EDI
EDI Configuration
EDI Session Settings
▪ Ensured no hazard (DGS segment) at equipment level
Result:
▪ N4 creates the booking with given hazard (booking level).
▪ N4 updates the unit with Hazard B from the booking (Hazard A got removed).
When you set the setting ARGOBOOKING012 set to UNIT_HAZARDS
Case 1: DGS segments under Booking only (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with DGS segment under booking with no DGS segment below the EQD segment (no
hazard at equipment level):
▪ N4 creates the booking with given hazard.
▪ N4 creates the unit without any hazard as no DGS segment exists at Equipment level.
Case 2: DGS segments under Equipment only (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with no DGS segment under booking where the DGS segment exists below the EQD
segment (Hazard at equipment level):
▪ N4 creates the booking without any hazard.
▪ N4 creates the unit with given hazard (equipment level)
Case 3: DGS segments under both Booking and Equipment, (equipment new or equipment hazard does not exists)
When you post a COPARN EDI with DGS segment under booking where a second DGS segment exists below EQD
segment (Hazard at equipment level):
▪ N4 creates the booking with given hazard (booking level)
▪ N4 creates the unit with hazard at Equipment level
Case 4: DGS segments under both Booking and Equipment (Null value under Equipment level)
When you post a COPARN EDI with DGS segment under booking where a second DGS segment exists below EQD
segment with empty values (null Hazard at equipment level):
▪ N4 creates the booking with given hazard (booking level)
▪ N4 creates the unit without any hazard as no DGS segment exists at Equipment level
Case 5: DGS segments under Booking only, where Equipment already has a hazard
▪ Pre-advised an Export container and added Hazard A.
▪ Posted a COPARN EDI for above container with DGS segment, Hazard B, under booking.
▪ Ensured no hazard (DGS segment) at equipment level
Result:
▪ N4 creates the booking with given hazard (booking level).
▪ Unit hazard is nullified (Hazard A is removed).
ARGOBOOKING013 (BKG_MATCHING_VESSEL_VISIT_NOT_FOUND)
When you post the 301 EDI Booking message with the message function D to delete the booking, N4 deletes the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
126
Part 1: EDI
EDI Configuration
EDI Session Settings
booking if the booking number in the EDI message exists in N4 and is associated to the same vessel visit. However, if
the booking number and vessel visit associated with the booking is not available, N4 displays either a warning or error
message in the Batches view (on page 172), Batches view (on page 823) based on the value selected in this setting:
Values:
• SHOW_WARNING (Default) – N4 displays a warning message in the Batches view (on page 172), Batches view
(on page 823) when you post the 301 EDI Booking message with the message function D and if the vessel visit
associated with the booking in the EDI message does not exist in N4.
• SHOW_ERROR – N4 displays an error message in the Batches view (on page 172), Batches view (on page 823)
when you post the 301 EDI Booking message with the message function D and if the vessel visit associated with the
booking in the EDI message does not exist in N4.
ARGOOOKING014
You can use this setting to determine whether N4 must validate the vessel visit specified in the Booking EDI message
or XML message posted for creating or updating an Empty Loadout Order (ELO).
Valid values:
true: N4checks if the vessel visit specified in the Booking Release EDI message or XML message exists and displays
an error message in the Batches view (on page 172), Batches view (on page 823) if the vessel visit is not available and
does not create the ELO.
false (default): N4 does not validate the vessel visit specified in the Booking Release EDI message or XML message.
ARGOEDI021 (EDI_NULLIFY_ENTITY_PROPERTY)
When you post an EDI message, N4 by default overwrites any existing entity property (for example, booking agent)
with the value received in the EDI file. On the other hand, if an entity property is null or not present in the EDI file, N4
retains the existing value instead of updating it to null.
With ARGOEDI021, you have the option to nullify any of the following values if those values are null or not present in a
posted EDI file:
• ORDER_AGENT
• UNIT_OOG
• UNIT_HAZARDS
• UNIT_REEFER
You can override this setting at the global level or add it to a specific EDI session.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
127
Part 1: EDI
EDI Configuration
EDI Session Settings
For example, assume a booking exists in N4 with agent code ABC. When you include the entity property
ORDER_AGENT using the EDI setting ARGOEDI021,
• if you post a BOOKING EDI file with agent code XYZ, N4 updates the booking's agent to XYZ.
• if you post a BOOKING EDI file that does not include the booking agent details, N4 updates the booking's agent
code to null or no value.
If you are using the EDI Posting Rules (on page 70), EDI Posting Rules (on page 908), the rule that you
define takes precedence over the setting.
ARGOEDI021 (EDI_NULLIFY_ENTITY_PROPERTY)
When you post an EDI message, N4 by default overwrites any existing entity property (for example, booking agent)
with the value received in the EDI file. On the other hand, if an entity property is null or not present in the EDI file, N4
retains the existing value instead of updating it to null.
With ARGOEDI021, you have the option to nullify any of the following values if those values are null or not present in a
posted EDI file:
You can choose to include either:
• ORDER_AGENT
• UNIT_OOG
• UNIT_REEFER
• UNIT_HAZARD
You can override this setting at the global level or add it to a specific EDI session.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
128
Part 1: EDI
EDI Configuration
EDI Session Settings
For example, assume a booking exists in N4 with agent code ABC. When you include the entity property
ORDER_AGENT using the EDI setting ARGOEDI021,
- if you post a BOOKING EDI file with agent code XYZ, N4 updates the booking's agent to XYZ.
- if you post a BOOKING EDI file that does not include the booking agent details, N4 updates the booking's agent
code to null or no value.
If you are using the EDI Posting Rules (on page 70), EDI Posting Rules (on page 908), the rule that you define
takes precedence over the setting.
ARGOEDI022 (AVOID_EDI_CREATE_REFERENCE_ENTITY)
If you receive a BOOKING EDI file that includes an Agent or Shipper/Consignee that does not already exist in the
system, by default N4 will create a record for the new agent or shipper. The ARGOEDI022 setting allows you to prevent
N4 from creating a new Agent or Shipper if received as part of an EDI BOOKING file. The setting is available for
BOOKING Message Types and can be used at the global level or at the EDI session level. You can select one or both
of the following values:
• Agent
• Shipper_Consignee
For example, to prevent N4 from creating the new agent found in a BOOKING EDI file, override ARGOEDI022 by
including the AGENT value and add the setting to the required EDI Session. See below:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
129
Part 1: EDI
EDI Configuration
EDI Session Settings
When you override this setting with AGENT, and you post a COPARN BOOKING EDI message with a new agent ID,
N4 displays the error "Could not find Agent with id = "AG1"".
If the BOOKING EDI file doesn't include an agent code, N4 displays a warning message stating ‘Missing or insufficient
data’ and processes the EDI file without the agent.
Inbound HAZARD EDI settings
The following EDI settings are available for an inbound HAZARD EDI session:
ARGOHAZARD001 (HAZARD_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to validate the equipment type provided by the HAZARD EDI message and generate an
error if the equipment type is not found in N4.
The default value for ARGOHAZARD001 is false.
Inbound MANIFEST EDI settings
The following EDI settings are available for an inbound MANIFEST EDI session:
ARGOMANIFEST001 (BL_EXPORT_TO_TRANSSHIP)
Set it to true of you want N4 to change export containers to transship containers.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
130
Part 1: EDI
EDI Configuration
EDI Session Settings
ARGOMANIFEST002 (DEFAULT_FACILITY_FOR_CARRIER_VISIT)
Specify the default facility for the next port of call when N4 creates a skeletal vessel visit.
N4 also uses this facility when a BOOKING message provides a port that is not the current facility.
ARGOMANIFEST003 (MFT_CREATE_VESSEL_ON_FLY)
Set it to true of you want N4 to create a vessel if the vessel specified in a MANIFEST EDI message is not in N4.
ARGOMANIFEST004 (MFT_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to validate the equipment type provided in a MANIFEST EDI message and generate an
error if the equipment type is not found.
ARGOMANIFEST005 (MFT_ALLOW_FOREIGN_VESSEL_VISIT)
Set to true of you want N4 to create a vessel visit for a non operational facility if the visit specified in a MANIFEST EDI
message is not in N4.
ARGOMANIFEST006 (MFT_RELAY_FCY_FOR_NON_OPRNL_FCY)
Specify the name of the operational "relay" facility, or facilities, a unit passes through on its way to a non operational
facility.
ARGOMANIFEST007 (MFT_USE_UNIT_IN_FACILITIES)
Define a list of facilities where units created through other sources may possibly exist. When defined, N4 looks in to the
listed facilities to check if a specific unit exists already. If it does, N4 updates that unit instead of creating a new unit in
the current facility.
ARGOMANIFEST008 (MFT_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
ARGOMANIFEST009 (MFT_ALLOW_SAME_BL_NBR_FOR_VESSEL_VISIT)
Set it to false (default) if you want N4 to match the Bill of Lading (BL) only by the Bill of Lading Number (BL Nbr) and
Line Operator and not match the Vessel Visit. Also, N4 will throw an error if there are multiple BLs found.
ARGOMANIFEST010 (MFT_SKIP_MANIFEST_QTY_UPDATE)
Determines whether N4 updates the manifest quantity for an existing bill of lading when the UPDATE qualifier is used
in the EDI message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
131
Part 1: EDI
EDI Configuration
EDI Session Settings
If set to true, then N4 does not update the manifest quantity, but updates other manifest information and displays the
warning message "Manifest Qty is not updated...". In this case, N4 only updates the manifest quantity for an existing
bill of lading when the REPLACE qualifier is used.
If set to false (default), then N4 updates the manifest quantity along with manifest information and displays the
following warning message "Manifest qty is updated but message function is not replace".In this case, N4 updates the
manifest quantity for an existing bill of lading when either the UPDATE (with warning message) or REPLACE (no
warning message) qualifier is used.
Inbound PREADVISE EDI settings
The following EDI settings are available for an inbound PREADVISE EDI session:
ARGOPREADVISE001 (PRE_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to validate the equipment type and generate an error if it cannot find an equipment type for
the ISO code specified in the EDI message.
If you set it to false, N4 does not validate the equipment type but tries to find an existing equipment type for the ISO
code provided in the EDI message and applies this equipment type to the appropriate units specified in the EDI
message.
If N4 does not find an existing equipment type, it creates an UNKN equipment type and applies it to the appropriate
units specified in the EDI message.
Default: false
ARGOPREADVISE002 (PRE_ALLOW_FOREIGN_VESSEL_VISIT)
Set to true if you want N4 to create a vessel visit for a non operational facility if the visit specified in a PREADVISE EDI
message is not in N4.
ARGOPREADVISE003 (PRE_VALIDATE_LINE_OPERATOR)
Set it to true if you want to compare the unit's line operator provided with the first PREADVISE message with that of
additional PREADVISE messages and reject the additional messages if the line operators do not match.
ARGOPREADVISE004 (PRE_EQUIP_TEMP_FOR_EMPTY)
Set it to true if you want N4 to update the temperature of an empty container with the temperature provided in the EDI
file.
Set it to false if you do not want N4 to update the temperature of an empty container.
ARGOPREADVISE005 (PRE_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
132
Part 1: EDI
EDI Configuration
EDI Session Settings
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
Inbound RAILWAYBILL EDI settings
The following EDI settings are available for an inbound RAILWAYBILL EDI session:
ARGORAILWAYBILL001 (WAYBILL_AUTO_CREATE_VESSEL_VISIT)
Set it to true to allow N4 to automatically create vessel visits.
The default setting is false.
ARGORAILWAYBILL002 (WAYBILL_VALIDATE_WAY_BILL_NUMBER)
Set it to false to turn off validation of the railway bill number.
A standard RAILWAYBILL message requires a railway bill number; however, an ANSI 204 message does not require a
railway bill number. You can use this setting to support the ANSI 204 messages using the railwaybill.xsd schema
file.
The default setting is true.
ARGORAILWAYBILL003 (WAYBILL_POST_FACILITY)
Specify the default facility for RAILWAYBILL messages.
Use this setting to specify the facility for the RAILWAYBILL messages because standard RAILWAYBILL messages do
not include a facility.
Facility ID field is optional in the railwaybill.xsd schema. However, N4 does require a facility ID. If you do not
specify the facility ID with ARGORAILWAYBILL003 or by using a custom mapping file, N4 generates an error.
ARGORAILWAYBILL004 (WAYBILL_RAIL_OPERATOR)
Set to true to allow N4 to validate the railroad ID in the RAILWAYBILL message.
Valid values:
true (Default): Displays the MISSING_RAIL_ROAD_ID error when the RAILWAYBILL message is posted without the
railroad ID.
false: Allows posting the RAILWAYBILL message successfully even without the railroad ID.
ARGORAILWAYBILL005 (WAYBILL_USE_UNIT_IN_FACILITIES)
Define a list of facilities where units created through other sources may possibly exist. When defined, N4 checks the
listed facilities to see if a specific unit exists already. If it does, N4 updates that unit instead of creating a new unit in the
current facility.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
133
Part 1: EDI
EDI Configuration
EDI Session Settings
Inbound STOWPLAN EDI settings
The following EDI settings are available for an inbound STOWPLAN EDI session:
ARGOBAPLIE001 (SP_VALIDATE_LINE_PER_VSL)
Use this setting to validate that the line operator for a container is a partner on the vessel before creating a stow plan
for the container either using EDI or the Stow Plan form.
Set it to true if you want to reject a stow plan if the line operator for the container is not a partner on the vessel i.e. not
listed in the schedule.
If you want to apply this validation for a specific EDI session, set it for the specific EDI Session using the EDI Setting
form (on page 199), EDI Setting form (on page 849). However, if you want to apply this validation to all EDI sessions
and to the Stow Plan form during manual data entry, you must set this configuration setting to true in the Settings
view (on page 1042).
ARGOBAPLIE002 (SP_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to reject a container if the equipment type (ISO code) does not match the equipment type
(ISO code) in N4. Also, set it to true if you do not want N4 to create a new equipment type from the BAPLIE session. In
this case, N4 displays an error if the equipment type does not exist in N4.
You must set ARGOBAPLIE002 for individual EDI sessions.
ARGOBAPLIE003 (SP_EQUIP_OPERATORS)
You can use this setting if you want to extract the information for only specific containers on a vessel and not all the
containers on the vessel.
To use this setting, specify the line operators, in a comma-separated list, for which you want to extract the containers
on a vessel. For example, if you specify ABC, ASC as the value for the ARGOBAPLIE003 setting, N4 extracts only the
containers where the line operator is either ABC or ASC.
ARGOBAPLIE004 (SP_EQUIP_CATEGORY)
Set it to true if you want N4 to post the category specified in the EDI file without using the posting logic.
Set it to false if you want N4 to use the posting logic to determine the category of the container.
For more information on the posting logic in N4, see Inbound STOWPLAN EDI processes (on page 30), Inbound
STOWPLAN EDI processes (on page 179), Inbound STOWPLAN EDI processes (on page 829) in the online help or on
the NCC.
ARGOBAPLIE005 (EDIPOST_THREAD_COUNT)
The ARGOBAPLIE005 configuration setting is deprecated and is replaced by setting ARGOEDI008
(EDI_POST_NUM_PARALLEL_JOBS) (on page 105). The ARGOEDI008 setting is similar to the
ARGOBAPLIE005.
ARGOBAPLIE007 (SP_USE_UNIT_IN_FACILITIES)
Define a list of facilities where units created through other sources may possibly exist. When defined, N4 looks in to the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
134
Part 1: EDI
EDI Configuration
EDI Session Settings
listed facilities to check if a specific unit exists already. If it does, N4 updates that unit instead of creating a new unit in
the current facility.
ARGOBAPLIE008 (SP_EQUIP_TEMP_FOR_EMPTY)
Set it to true if you want N4 to update the temperature of an empty container with the temperature provided in the EDI
file.
Set it to false if you do not want N4 to update the temperature of an empty container.
ARGOBAPLIE009 (SP_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
ARGOBAPLIE010 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSACTION_FOR_INBOUND)
Specify the number of EDI transactions that you want N4 to translate (map) at a time to control the memory required
when processing a STOWPLAN EDI message. N4 splits the EDI message into sections and then maps each section
separately instead of mapping the entire EDI message at once. Once all of the sections are mapped, N4 continues
processing the entire message as usual.
This setting determines the size of each section or the number of EDI transactions in each section for mapping. A
single EDI transaction starts with the LOC+147 segment and ends at the next LOC+147 segment.
You must configure AGROBAPLIE010 at the individual EDI session level (on page 195) and not at the Global
level from the Settings view (on page 1042). Navis recommends that you set ARGOBAPIE010 to around 1000
in order to reduce the mapping time when processing an inbound EDI BAPLIE file without too much impact on
the performance of the system.
Minimum: 0
Maximum: 3000
Default: 100
If you set ARGOBAPIE010 to 0 (zero), it turns off this functionality so that N4 uses the standard mapping process,
which is to extract all the container information in the XML at once.
See also, ARGOBAPLIE011 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSLATION_FOR_OUTBOUND) (on page
138), ARGOBAPLIE011 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSLATION_FOR_OUTBOUND) (on page
868).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
135
Part 1: EDI
EDI Configuration
EDI Session Settings
ARGOBAPLIE012 (SP_REJECT_THE_VESSEL_LOADED_IN_DIFF_FACILITY)
You can use the setting ARGOBAPLIE012 (SP_REJECT_THE_VESSEL_LOADED_IN_DIFF_FACILITY) to
determine whether N4 should process the BAPLIE message for a vessel that is active at another facility.
You can set the setting to True if you want N4 to reject an Inbound Stowplan EDI if the vessel visit is working or
departed at a different facility.
The default value for the setting is False.
ARGOEDI018 (VALIDATE_EQUIP_TYPE_EQUIVALENT)
You can set the setting ARGOEDI018 (VALIDATE_EQUIP_TYPE_EQUIVALENT) to validate the equipment type
equivalent when you post the Stowplan, DischargeList or Activity EDI message. You must set the ARGOEDI018 at the
EDI session level.
Values:
When you set the setting to True and:
• Post the Stowplan or the DischargeList message, if the properties of the unit's ISO Type (length, height and ISO
Group) in the posted message are different from the existing unit’s ISO Type properties, then N4 displays an error
message in the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825).
• Post an Activity EDI message and the ISO specified for a booking item is not found in the specified Booking Order,
then N4 uses the Equipment Type Equivalent if you have set the Order Item Not Unique in the Booking Rules for a
particular line operator.
False (default): When you set the setting to False and post the Stowplan, DischargeList, or Activity EDI message, N4
does not try to use the Equipment Type Equivalent and posts the message successfully.
ARGOEDI019 (EDI_CREATE_UPDATE_UNIT)
The ARGOEDI019 (EDI_CREATE_UPDATE_UNIT) setting uses the EdiUnitPredicates.xml to determine if N4 should
create a new unit or update the existing unit when you post the 301 EDI message based on the T-State, Category, and
Outbound Carrier for the unit. You must configure ARGOEDI019 at the Complex level and not at the global level in the
Settings (on page 1042) view by importing your modified EdiUnitPredicates.xml as an override.
If the ARGOBOOKING001 (BKG_IMPORT_TO_TRANSSHIP) setting is set as “true”, N4 updates the existing
import unit even though the outbound carrier visit of the existing unit and the outbound carrier specified in the
301 EDI message are different.
When you post a load list (301 EDI message) for an existing transship or export container with the same unit number,
the conditions listed below determine if N4 creates a new unit or updates the existing unit.
• If the outbound carrier for the existing unit is generic, N4 updates the existing unit.
• If the outbound carrier specified in the load list and the existing unit are the same, N4 updates the existing unit.
• If both of the above conditions are not met, N4 updates the existing unit or creates a new unit based on the new
XML setting ARGOEDI019 (EDI_CREATE_UPDATE_UNIT)
The following code segment shows a sample EdiUnitPredicates.xml file:
<?xml version="1.0" encoding="UTF-8"?>
<edi-unit-predicates>
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
136
Part 1: EDI
EDI Configuration
EDI Session Settings
<!--If there is no predicate defined or no predicate matches then the value provided
for the default="" attribute in booking element would be
considered either to create a new unit or update a existing unit. If the default value
is defined then it might be either "UPDATE" (or) "CREATE"
-->
<booking default="">
<!-1. All the attributes (ediCategory,unitCategory,unitTstate,existingObCv) with value are
mandatory.
2. ediCategory/unitCategory value might be any one of the following value "EXPRT" (or)
"IMPRT" (or) "TRSHP" (or)"STRGE".
3. unitTstate can be provided either with single value or multiple value with comma(,)
separation.
eg. unitTstate="INBOUND" or unitTstate="INBOUND,YARD,EC/IN"
4. unitTstate value might be given as any of these value INBOUND,YARD,EC/IN,EC/
OUT,DEPARTED,RETIRED.
5. existingObCv might be provided as either "SAME" (or) "DIFF" (or) "GEN_CARRIER".
6. <predicate> value might be either "UPDATE" (or) "CREATE"</predicate>
-->
<predicate ediCategory="EXPRT" unitCategory="EXPRT" unitTstate="INBOUND,YARD"
existingObCv="SAME">UPDATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="EXPRT" unitTstate="INBOUND,YARD"
existingObCv="DIFF">CREATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="EXPRT" unitTstate="INBOUND,YARD"
existingObCv="GEN_CARRIER">UPDATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="IMPRT" unitTstate="INBOUND,YARD"
existingObCv="SAME">UPDATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="IMPRT" unitTstate="INBOUND,YARD"
existingObCv="DIFF">CREATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="IMPRT" unitTstate="INBOUND,YARD"
existingObCv="GEN_CARRIER">UPDATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="TRSHP" unitTstate="INBOUND,YARD"
existingObCv="SAME">UPDATE</predicate>
<predicate ediCategory="EXPRT" unitCategory="TRSHP" unitTstate="INBOUND,YARD"
existingObCv="DIFF">CREATE</predicate>
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
137
Part 1: EDI
EDI Configuration
EDI Session Settings
<predicate ediCategory="EXPRT" unitCategory="TRSHP" unitTstate="INBOUND,YARD"
existingObCv="GEN_CARRIER">UPDATE</predicate>
</booking>
</edi-unit-predicates>
The following table show how setting the various parameters determines whether a new UFV is created or updated.
1.4.5.5 Outbound STOWPLAN EDI settings
The following EDI settings are available for an outbound STOWPLAN EDI session:
ARGOBAPLIE011 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSLATION_FOR_OUTBOUND)
Specify the number of EDI transactions that you want N4 to translate (map) at a time to control the memory required
when processing a STOWPLAN EDI message. N4 splits the EDI message into sections and then maps each section
separately instead of mapping the entire EDI message at once. Once all of the sections are mapped, N4 continues
processing the entire message as usual.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
138
Part 1: EDI
EDI Configuration
EDI Session Settings
This setting determines the size of each section or the number of EDI transactions in each section for mapping. A
single EDI transaction starts with the LOC+147 segment and ends at the next LOC+147 segment.
Minimum: 0
Maximum: 10
Default: 10
If you set ARGOBAPLIE011 to 0 (zero), it turns off this functionality so that N4 uses the standard mapping process,
which is to extract all the container information in the XML at once.
You can configure this setting in the EDI Session form for individual EDI sessions or in the Settings view for all
the EDI sessions. However, N4 gives precedence to values set at the EDI session level.
See also, ARGOBAPLIE010 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSACTION_FOR_INBOUND) (on page
135), ARGOBAPLIE010 (SP_TRANSACTION_SIZE_FOR_EACH_TRANSACTION_FOR_INBOUND) (on page 865).
ARGOBAPLIE006 (SP_EXPORT_TO_CATEGORY)
Use this setting to either convert an existing Advised or Inbound Export unit facility visit (UFV) into an Import,
Transship, or a Through UFV or create a new UFV for the new category when you post a STOWPLAN EDI message.
You can set ARGOBAPLIE006 to any of the following options:
• NONE: To leave the existing Export UFV as Advised or Inbound and create a new UFV with Import, Transship, or
Through Category based on the information in the EDI message.
• ALL (Default): To update the Category of the existing Advised or Inbound Export UFV to Import, Transship, or
Through based on the information in the EDI message. In this case, no new UFV is created.
• IMPORT_ONLY: To update the Category of the existing Advised or Inbound Export UFV only if the new
Category is Import. If the EDI message changes the Category to either Transship or Through, create a new UFV
based on the information in the EDI message.
• TRANSSHIP_ONLY: To update the Category of the existing Advised or Inbound Export UFV only if the new
Category is Transship. If the EDI message changes the Category to either Import or Through, create a new UFV
based on the information in the EDI message.
• THROUGH_ONLY: To update the Category of the existing Advised or Inbound Export UFV only if the new
Category is Through. If the EDI message changes the Category to either Import or Transship, create a new UFV
based on the information in the EDI message.
• The ARGOBAPLIE006 setting is available at the EDI session level for STOWPLAN EDI messages and also at the
application level in the Settings view (on page 1042).
INVBATCH001 (UNIT_DELETE_BATCH_SIZE)
This setting has been deprecated for version 2.6, 3.1, and 3.4 or later.
Specify the maximum number of units in a batch that you need to delete in a single action.
Default value is 500.
Minimum: 10
Maximum: 1000
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
139
Part 1: EDI
EDI Configuration
EDI Session Settings
1.4.5.6 LOADLIST EDI settings
The following EDI settings are available for an inbound or an outbound LOADLIST EDI session:
ARGOLOADLIST001 (POST_PERMISSIONS_LOAD)
Lists the permissions that you want N4 to apply to the containers in the EDI message during EDI processing.
To include a permission, you can do any of the following:
• Double-click the permission in the Excluded field.
• Select the permissions in the Excluded field and click
.
Press and hold the Shift key to select adjoining permissions and the Ctrl key to select non-adjoining permissions.
• Use your mouse to drag and drop the permission from the Excluded field to the Included field.
• Click
to include all permissions.
To exclude a permission, you can do any of the following:
• Double-click the permission in the Included field.
• Select the permissions in the Included field and click
.
• Use your mouse to drag and drop the permission from the Included field to the Excluded field.
• Click
to exclude all permissions.
ARGOLOADLIST002 (LDL_VALIDATE_EQ_TYPE)
Set it to true if you want N4 to validate the equipment type provided by the LOADLIST EDI message and generate an
error if the equipment type is not found.
By default this is set to false.
The setting ARGOLOADLIST002 handles only the equipment type validation. To validate equipment type
equivalents you need to use the setting ARGOLOADLIST007 (LDL_VALIDATE_EQUIP_TYPE_EQUIVALENT)
(on page 141), ARGOLOADLIST007 (LDL_VALIDATE_EQUIP_TYPE_EQUIVALENT) (on page 871).
ARGOLOADLIST003 (LDL_IMPORT_TO_TRANSSHIP)
Determines if N4 updates the category of an existing export or import container to a transship container when posting
an EDI file for that container.
• Set it to True if you want N4 to update the category of an existing export or import container to a transship container.
In this case, N4 also sets the port of load to the load port provided in the EDI file even if the posting rules are set to
ignore the routing information.
• Set it to False if you want N4 to keep the category of an existing export or import container the same.
When you post the COPRAR Load List EDI message, if the EDI setting ARGOLOADLIST003 is set to True and when
the unit is in the yard then, N4 updates the unit’s POL with the POL given in EDI file. If the POL is not present in EDI
file then N4 updates the current facility port. Also, if the unit is inbound on different vessel then N4 does not change the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
140
Part 1: EDI
EDI Configuration
EDI Session Settings
POL and displays a warning message ‘The POL XXX cannot be changed because the container is inbound on a
different vessel’ on the batch.
When the existing data source is Loadlist, you need to set the posting rule for Routing property group.
If you set the setting ARGOLOADLIST003 (LDL_IMPORT_TO_TRANSSHIP) to True, ensure that you set
ARGOLOADLIST006 (LDL_EDI_ACCURATE) to False. When ARGOLOADLIST003
(LDL_IMPORT_TO_TRANSSHIP) is set to True, N4 updates the category of an existing export or import
container to a transship container.
ARGOLOADLIST004 (LDL_REJECT_NO_TEMP_FOR_LIVE_REEFER)
Set it to true if you want N4 to reject a null temperature value in an EDI file for an existing live reefer container with a
required temperature. In this case, an error message occurs for the EDI transaction with the null temperature value.
This enables you to contact your EDI partner to verify whether the container is a live reefer or not. If the container is not
supposed to be a live reefer, then you can remove the reefer requirements in N4 and repost the EDI transaction.
Set it to false (default) if you want N4 to ignore a null temperature value in an EDI file for an existing live reefer
container with a required temperature. In this case, N4 does not produce an error and processes the other EDI
transaction values except for the null temperature value.
Regardless of this setting, N4 does not apply a null temperature value from an EDI file to an existing live reefer
container with a temperature.
ARGOLOADLIST005 (LDL_CONVERT_STORAGE)
Set it to true if you want N4 to update the existing storage unit to the category specified in the Loadlist EDI message.
The default value for ARGOLOADLIST005 is false. When an active or yard empty storage unit exists in N4, and when
you post the COPRAR Loadlist EDI for the same empty storage container, N4 considers the setting
ARGOLOADLIST005 (LDL_CONVERT_STORAGE).
ARGOLOADLIST006 (LDL_EDI_ACCURATE)
Determines whether the category of the existing unit should be updated or not when posting an LOADLIST EDI
message for that unit.
• Set it to true if you want N4 to overwrite the category of the existing unit when posting an EDI message for that unit.
• Set it to false (default) to use the category from the EDI message. For existing transshipment units, when the
category value is not provided in the EDI message, N4 creates a new UFV. However, N4 updates the existing
transship unit instead of creating a new UFV, if both the containers have the same outbound carrier.
ARGOLOADLIST007 (LDL_VALIDATE_EQUIP_TYPE_EQUIVALENT)
Set it to true if you want N4 to validate the equipment type equivalents provided by the LOADLIST EDI message and
generate an error if the equipment equivalents is not found.
Set it to false if you do not want N4 to validate the equipment type equivalents from the EDI message.
The default value is true.
ARGOLOADLIST008 (LDL_REROUTE_UNIT)
You can use the EDI session level setting ARGOLOADLIST008 (LDL_REROUTE_UNIT) to determine if N4 should
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
141
Part 1: EDI
EDI Configuration
EDI Session Settings
create a new unit or update the existing unit when the existing unit's category is transshipment or export container. You
must configure ARGOLOADLIST008 at the EDI session level and not at the global level in the Settings view. (on page
1042)
When you post the load list message for an existing transship or export container with the same unit number, N4
updates the existing unit if:
▪ The existing outbound of the unit is generic carrier visit
▪ The load list outbound carrier visit and the existing unit's outbound carrier visit are similar.
▪ If both the above conditions are not met, then N4 updates the existing unit or creates a new unit based on the setting
ARGOLOADLIST008.
You can set ARGOLOADLIST008 to one of the following values:
• DO_NOT_REROUTE (Default): To create a new unit when the category of the unit is transshipment or export
container
• REROUTE: To update the existing unit when the category of the unit is transshipment or export container.
ARGOLOADLIST009 (LDL_VALIDATE_WEIGHT)
You can use this setting to determine whether N4 should validate the container weight with the Gross Weight and the
VGM Weight provided by the LOADLIST EDI message.
By default, N4 does not display any warning messages if the unit gross weight or the VGM weight of the container is
less than the tare weight.
You must override this setting and set the value as WARN_GROSS_LESS_THAN_TARE to display a warning
message if the unit gross weight or the VGM weight of the container is less than the tare weight.
1.4.5.7 Outbound ACTIVITY EDI settings
The following EDI settings are available for an outbound ACTIVITY EDI session:
ARGOACTIVITY001 (POST_ACTIVITY_FACILITY)
Specify the facility, in a multi-facility complex, to which you want N4 to send the inbound EDI ACTIVITY messages.
ARGOACTIVITY002 (EXTRACT_ACTIVITY_FACILITY)
Specify the facility where N4 extract records when processing an ACTIVITY EDI session extract. This reduces the
records to only those for facility specified to help reduce the strain on resources, such as memory.
ARGOACTIVITY003 (USE_APPLY_DATE_FOR_EXTRACT)
Set it to true if you want N4 to extract events based on the event's Apply Date.
Set it to false (default), if you want N4 to extract events based on the event's Created Date.
ARGOACTIVITY004 (EXTRACT_ACTIVITY_XSD_FORMAT)
When set to True, N4 generates the activity and basemapping files for an EDI message using XSD format, which
means for the container arrival time it only returns the date. If set to false, it returns both the date and time.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
142
Part 1: EDI
EDI Configuration
EDI Session Settings
Default: False
ARGOACTIVITY005 (UNIT_DETERMINATION_FOR_INBOUND_ACTIVITY)
When posting an ACTIVITY EDI message, by default, N4 updates the category of a unit based on carrier details of the
unit. You can use the setting ARGOACTIVITY005 (UNIT_DETERMINATION_FOR_INBOUND_ACTIVITY) to
determine how N4 deals with the discrepancies between the category of the activity inbound message and the existing
active inbound unit. You must configure ARGOACTIVITY005 at the EDI session level.
You can select from one of the following options:
• SELECT_BY_CARRIER_MODE: After posting an ACTIVITY EDI message, N4 determines the category of the unit
based on the inbound and the outbound carrier mode of the existing unit and EDI message. The determined unit's
category is either applied to the unit or ignored based on the posting rules set for the category. However, N4 always
updates the I/B carrier of the unit from the ACTIVITY EDI message. N4 updates the O/B carrier of the unit based on
the posting rule set in the routing property group for the unit.
• SELECT_BY_CARRIER (Default): N4 updates the category based on carrier details of the unit.
EDIEXTR004 (EXTRACT_MAX_EVENTS)
Specify the maximum number of records that N4 must extract when processing an ACTIVITY EDI session extract. This
helps reduce the strain on resources, such as memory.
For example, if N4 has not run an ACTIVITY EDI extract in a few days and a lot of records are waiting to be processed,
such as 10,000 or more records, you can set this setting to 5000 so that N4 processes only the first 5000 records.
Then you can set the Last Run Time value to pick up the next 5000 records during the next EDI process.
Default: 2000
Minimum: 1
Maximum: 5000
EDIEXTR005 (EXTRACT_MAX_MINUTES)
Specify the maximum number of minutes that N4 can run a query to extract events when processing an ACTIVITY EDI
session. This helps reduce the strain on resources, such as memory.
Default: 10081
EDIEXTR006 (EXTRACT_MAX_SELECTED)
Specify the maximum number of events that N4 must extract for filter evaluation when processing an ACTIVITY EDI
session.
This helps reduce the strain on resources, such as memory, by restricting the number of events for filter analysis. N4
stops filter analysis when the maximum number of events has been reached, and continues with the next record during
the next scheduled extract.
Default: 5000
Minimum: 1
Maximum: 20000
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
143
Part 1: EDI
EDI Configuration
EDI Session Settings
1.4.5.8 Outbound VESSELACTIVITY EDI settings
The following EDI settings are available for an outbound VESSELACTIVITY or VESSELACTIVITY BY CARRIER EDI
session:
ARGOVESSELACTIVITY001 (VESSEL_VISIT_OPERATOR)
When set to a specific line operator, N4 filters and extracts the activities of vessel visits either operated or shared by
the line operator.
ARGOVESSELACTIVITY002 (VALIDATE_VESSEL_LOCK)
When set to ‘true’, N4 validates the lock on a vessel visit and displays the error message "Cannot update routing.
Ensure that the Vessel Visit(s) is not locked" when you stowplan containers or create/update a discharge list using N4
forms or EDI.
By default, ARGOVESSELACTIVITY002 is set to 'false'.
Include this setting in the EDI session for BAPLIE and DISCHLIST message types to override the setting at the
EDI session level.
1.4.5.9 RAILCONSIST EDI settings
The following EDI settings are available for an inbound or an outbound RAILCONSIST EDI session:
ARGORAILCONSIST002 (RC_EQUIP_CATEGORY)
Use this setting to specify whether the unit Category specified in a RAILCONSIST EDI file is accurate and can be used
to create a unit in N4, if needed.
Set it to true if you want N4 to use the Category specified in the RAILCONSIST EDI file to search for the unit. If N4
finds a unit matching the Category, it updates the unit; otherwise, it creates a new unit with that Category. This setting
accepts the category from the inbound message.
If set to true, the Category must be present in the EDI file; otherwise, the following error occurs:
Container category is required.
Set it to false if you want N4 to derive the category of the container based on the routing points. If set to false, to
include the domestic category the INVROUTING003 (SUPPORTS_DOMESTIC_CATEGORY) setting must be set to
true. Otherwise, the default Category is Export.
ARGORAILCONSIST003 (RC_CREATE_TRAIN_VISIT_ON_FLY)
Set it to true if you want N4 to automatically create the train visit if the train visit specified in an inbound RAILCONSIST
EDI does not exist. If ARGORAILCONSIST003 is set to false and the train visit specified in an inbound RAILCONSIST
EDI does not already exist, N4 generates an error when you post the EDI.
If the train visit does not exist, N4 requires that the facility ID be specified in the inbound RAILCONSIST EDI;
otherwise, N4 displays an error message and does not create the train visit.
Default: false
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
144
Part 1: EDI
EDI Configuration
EDI Session Settings
ARGORAILCONSIST004 (RC_USE_UNIT_IN_FACILITIES)
Define a list of facilities where units created through other sources may possibly exist. When defined, N4 looks in to the
listed facilities to check if a specific unit exists already. If it does, N4 updates that unit instead of creating a new unit in
the current facility.
ARGORAILCONSIST005 (RC_USE_DEFAULT_RAILCAR_TYPE)
Set it to true if you want N4 to pick a default railcar type when it cannot find an existing railcar type in the system.
Default: false
ARGORAILCONSIST006 (RC_VALIDATE_RAILCAR_SLOT to ERROR)
When you add ARGORAILCONSIST006 to an EDI session and a Rail Consist EDI message contains invalid railcar
slots, N4 sets the status of the EDI Batch as ERROR or WARN based on the value of the new setting assigned to the
EDI Session.
The default value for the setting is WARN.
For example, let's say you include the ARGORAILCONSIST006 (RC_VALIDATE_RAILCAR_SLOT) for an EDI Session
and configure it as ERROR. Now, when you post a Rail Consist EDI message with invalid railcar slots, N4 fails the
batch, sets the batch status as ERRORS, and displays “Entered railcar slot position [SLOT] is invalid.” error message.
If you configure the setting as WARN for the EDI Session, then in the above scenario, N4 posts the EDI message
successfully but sets the batch status as WARNINGS.
Default: WARN
1.4.5.10 RAILORDER EDI settings
The following EDI settings are available for an inbound or an outbound RAILORDER EDI session:
ARGORAILORDER001 (RO_IMPORT_TO_TRANSSHIP)
Set it to true of you want N4 to change import containers to transship containers.
ARGORAILORDER002 (RO_UPDATE_CONTAINERS)
Set it to true if you want to allow the following container updates from EDI processing:
• Create new pre-advised export or domestic containers.
• Update existing containers to associate them to the rail order.
ARGORAILORDER003 (RO_EQUIP_CATEGORY)
Set it to true if you want N4 to post the category specified in the RAILORDER EDI file. If set to true, the category must
be present in the EDI file. Otherwise, the following error occurs: "Container category is required".
Set it to false if you want N4 to derive the category of the container based on the routing points. If set to false, to
include the domestic category the INVROUTING003 (SUPPORTS_DOMESTIC_CATEGORY) setting must be set to
true. Otherwise, the default category is EXPORT.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
145
Part 1: EDI
EDI Configuration
EDI Session Settings
1.4.5.11 RELEASE EDI settings
The following EDI settings are available for an inbound or an outbound RELEASE EDI session:
ARGORELEASE001 (RLS_VALIDATE_LINE_OPERATOR)
Set to true if you want N4 to validate the line operator for RELEASE messages. In addition, you must map the
shippingLine attribute appropriately in your COREOR mapping file.
ARGORELEASE002 (RLS_ALLOW_FOREIGN_VESSEL_VISIT)
Set to true of you want N4 to create a vessel visit for a non operational facility if the visit specified in a RELEASE EDI
message is not in N4.
ARGORELEASE003 (RLS_VALIDATE_UNIT_IN_YARD)
When processing the Saudi Inspection EDI message, use ARGORELEASE003 setting to validate the presence of a
unit in the yard.
• If you set this to true and a unit:
▪ Doesn't exist in the system, N4 throws an error message.
▪ Exists in the system but is not the yard, N4 throws an error message.
▪ Exists in the system and is in the yard, N4 uses the existing unit.
• If you set this to false and a unit:
▪ Doesn't exist in the system, N4 creates the unit.
▪ Exists in the system but is not the yard, N4 uses the existing unit.
▪ Exists in the system and is in the yard, N4 uses the existing unit.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
146
1.5 Using EDI
This section describes how to use EDI. This includes how to configure EDI schedules to automatically process EDI and
how to manually process EDI.
To ensure that N4 processes and sends EDI messages as dictated by terminal operations or the trading partners, you
can execute EDI sessions on demand or configure N4 to execute EDI on a scheduled basis per an EDI job, except for
STOWPLAN messages. In addition, you can specify the email address of the recipients that want to receive notification
from N4 when an EDI job succeeds or fails. For example, you can specify your email address if you want to receive an
email when an EDI job fails to process. You can also configure N4 to automatically reprocess a failed inbound or
outbound EDI job a specified number of times before N4 considers the EDI job as failed.
Depending on how you configured EDI, N4 can process EDI without much user intervention. However, it is really
important that you monitor the execution of EDI sessions, the status of the EDI batches, and review any EDI
associated errors. For more information on how to correct common EDI errors, see Troubleshooting EDI (on page
239).
In This Section
EDI Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Manually extracting an outbound EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Manually loading an inbound EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Manually posting the EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring EDI processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cancelling an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Correcting EDI errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remapping an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remapping an EDI interchange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reposting an EDI batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Re-extracting an ACTIVITY EDI session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Generate unit level discrepancy reports using I/B or O/B Carrier Visit as a filter criteria. . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
148
150
151
151
152
155
155
165
166
166
167
168
147
Part 1: EDI
Using EDI
EDI Process Flow
1.5.1 EDI Process Flow
The following process flow diagram illustrates how to use EDI. In addition, the topics that follow include detailed steps
for each box in the process flow.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
148
Part 1: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Using EDI
EDI Process Flow
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
149
Part 1: EDI
Using EDI
Manually extracting an outbound EDI session
1.5.2 Manually extracting an outbound EDI session
You can manually extract outbound ACTIVITY EDI and outbound EDI associated with a vessel visit.
The following process flow diagram illustrates how to manually extract an outbound EDI session. In addition, the
procedures that follow include detailed steps for each box in the process flow.
To manually extract an ACTIVITY EDI session:
1. In the Administration
you want to extract.
EDI
EDI Sessions
EDI Sessions view, double-click on the ACTIVITY EDI session
The EDI Session form (on page 195) opens.
2. Click Extract.
The Last Run Status field is updated automatically each time an EDI session is run.
When you run an ACTIVITY EDI session extract, the activity data in N4 is extracted from the date and time stored in
the Last Run Time field to the current date and time. If an Activity EDI session extract is successful, the date and
time of the last successful run is stored in the Last Run Time field. If the extraction is unsuccessful, the date and
time values are not updated for the erroneous extract.
The maximum number of days that can be extracted is last seven days (from the current date) to avoid
performance issues.
To extract EDI by email, make sure that the EDIEMAIL001 (EMAIL_FROM) (on page 113) and
EDIEMAIL002 (EMAIL_REPLY_TO) (on page 114) settings are set correctly for your scope level. N4
validates the email address when you create or edit the EDI configuration (on page 205), EDI configuration
(on page 843). For more information, see EDI settings (on page 101).
To manually extract an EDI for an outbound vessel visit:
1. In the Operations
extract EDI for.
Vessel
Vessel Visits
Vessel Visits view, double-click on the vessel visit you want to
The Vessel Visit Inspector opens.
2. Select the Outbound EDI tab.
3. Select
.
N4 displays the EDI Extract form.
4. In the EDI Extract form, from the Session drop-down list, select the EDI session to extract.
5. Optionally, if the vessel is still working you can de-select the Future check box to exclude the TBD units, and
include only the planned loads or the discharges in the EDI extract.
By default, the Future check box is checked to extract EDI that includes TBD units planned for a vessel visit.
If there is an actual unit in a specific TBD unit slot, then N4 excludes that TBD unit during extraction.
6. Click Extract.
The Last Run Status field is updated automatically each time an EDI session is run.
If an EDI session extract is successful, the date and time of the last successful run is stored in the Last Run Time
field. If the extraction is unsuccessful, the date and time values are not updated for the erroneous extract.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
150
Part 1: EDI
Using EDI
Manually loading an inbound EDI session
1.5.3 Manually loading an inbound EDI session
Prerequisites
• To access this form, you need to assign the EDI - Upload privilege to your user role.
• You have to set the setting ARGORAILCONSIST002 (RC_EQUIP_CATEGORY) to True to accept the category
from the inbound message.
The EDI Load form enables you to manually load an EDI message file. For example, if you receive a BAPLIE on a disk
or as an email, you can use the EDI Load form to manually load that file.
To load an EDI message file:
1. Open the Administration
EDI
EDI Load
EDI Load form (on page 225).
2. From the EDI Session drop-down list, select an inbound EDI session.
Each entry in the drop-down list displays the EDI Session name followed by the EDI message type ID in
parentheses.
3. Click Browse, to locate the file on your computer or network.
In the EDI Load dialog box, select the EDI message file. The complete path and the name of the selected file is
displayed in the EDI File field.
4. Optionally, select the Post Immediate check box, to post the EDI file immediately.
If you do not select the check box, the file is posted when the selected EDI session is posted. If the Auto Post
option is selected for the EDI session, the file is posted automatically. For more information, see EDI Session form
(on page 195).
5. Click Load.
1.5.4 Manually posting the EDI batch
Depending on the type of inbound EDI you want to manually post, you can post an EDI batch from the:
• EDI Batch Inspector: For all types of inbound EDI.
• Vessel Inspector: For inbound EDI associated with a vessel visit.
• Train Inspector: For inbound EDI associated with a rail visit.
The following process flow diagram illustrates how to manually post an EDI batch. In addition, the procedures that
follow include detailed steps for each box in the process flow.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
151
Part 1: EDI
Using EDI
Monitoring EDI processes
To post an EDI batch from the EDI Batch Inspector:
1. In the Administration
EDI
Batches
Batches view, double-click on the EDI batch you want to post.
The EDI Batch Inspector opens.
2. Select Actions
Post.
To post an EDI batch from the Vessel Inspector:
1. Open the Operations Vessel Vessel Visits
the vessel visit you want to post EDI for.
Vessel Visits view
Vessel Inspector
Inbound EDI tab for
2. In the Inbound EDI tab, select the batch record you want to post.
3. Select Actions
Post.
To post an EDI batch from the Train Inspector:
1. Open the Operations Rail
visit you want to post EDI for.
Train Visits
Train Visits view
Train Inspector
Inbound EDI tab for the train
2. In the Inbound EDI tab, select the batch record you want to post.
3. Select Actions
Post.
In the Inbound EDI tab of the Vessel Inspector or Train Inspector, you can optionally double-click on the
EDI batch to open the EDI Batch Inspector and post the EDI batch.
1.5.5 Monitoring EDI processes
It is important to monitor EDI processes to stay on top of any errors that may occur. To monitor EDI processes, use the
Batches view and EDI Errors view.
1.5.5.1 Reviewing the EDI batch
The Batches view displays the EDI batches processed by N4 and may be used for troubleshooting purposes. You can
view the details of an EDI batch, resolve processing problems, and then repost the batch.
The EDI Batch Inspector displays the details of the selected batch and provides a view of all the processes,
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
152
Part 1: EDI
Using EDI
Monitoring EDI processes
transactions, and segments in a batch. You can keep the EDI Batch Inspector open at all times as you work in other
views and forms, and you can move and resize it as needed.
The EDI Batch Inspector displays the basic information for an EDI batch in the following areas:
• EDI Batch Monitor: The left area displays the batch number of the selected batch.
• Batch Details: The central area displays the details such as the status of the batch, the interchange, number of
transactions and segments in the batch, and the date the batch was created.
• Configuration: The area on the right displays the configuration used by the batch including the direction, message
class, trading partner, EDI session, message map, and the carrier visit.
The EDI Batch Inspector displays additional EDI information in the Processes, Transactions, and Segments tabs.
The Processes tab displays the processes for the selected EDI batch, including the start and end time, number of
records, and the status of each process. The Processes tab also displays the errors, if any, for each process in the
selected EDI batch.
The Transactions tab displays the transactions for the selected EDI batch. Each individual business transaction in an
EDI interchange is represented as an EDI transaction.
The Segments tab displays the segments in the interchange for the selected EDI batch. If you have EDI processing
errors for an inbound EDI message due to errors in the EDI file, you can edit the segments to correct these errors and
then repost the selected EDI batch.
To view the details of an EDI batch:
1. Open the Administration
EDI
Batches
Batches view.
2. Double-click the record in the Batches view or select the record and click
.
The EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825) displays for the selected EDI batch.
To view the EDI batch processes:
1. Open the Administration
EDI
Batches
Batches view
EDI Batch Inspector for the selected EDI batch.
Batches
Batches view
EDI Batch Inspector
2. Select the Processes tab.
To view the EDI batch exceptions:
1. Open the Administration
selected EDI batch.
EDI
Processes tab for the
2. Select the Exceptions tab.
3. To view the details of an EDI exceptions, double-click the record on the Exceptions tab or select the record and
click
.
To view the EDI transactions:
1. Open the Administration
EDI
Batches
Batches view
EDI Batch Inspector for the selected EDI batch.
Batches
Batches view
EDI Batch Inspector for the selected EDI batch.
2. Select the Transactions tab.
To view the EDI segments:
1. Open the Administration
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
153
Part 1: EDI
Using EDI
Monitoring EDI processes
2. Select the Segments tab.
1.5.5.2 Reviewing the EDI interchange
The Interchanges view displays the EDI interchanges created when processing EDI messages. Each EDI file
exchanged with a trading partner creates an interchange for both inbound and outbound EDI.
The EDI Interchange form displays the EDI interchange details. All the fields in the form are read-only, except the
Delimiters field.
In the File Name read-only field, N4 displays the file name created in the EDI Session form. The file name has the
current system time and date in a long number format followed by the name of the EDI session. And the file suffix that
is specified in the EDI session form in the File Extension.
A delimiter is a character used to separate the fields in an EDI interchange. The Delimiters field displays the delimiter
for the selected EDI interchange and defaults to the delimiter specified in the EDI standard used for the EDI message
type.
The individual segments in the selected EDI interchange are displayed on the Segment tab. For inbound EDI
interchanges, you can edit segments, Remap, and Repost the EDI interchange.
If the Auto Post option is selected for the EDI session, the EDI interchange is automatically posted after you
edit a segment and Remap the EDI interchange.
In the EDI Interchange form, you can use the Export Segments button to export the EDI interchange segments to a
file.
To see how the EDI interchange details fit into the rail process flow, see the Full Rail Operations and Lite Rail
Operations process flows.
To view the details of an EDI interchange:
• In the Administration
EDI
to view or select it and click
Interchanges
Interchanges view, double-click on the EDI interchange you want
.
The EDI Interchange form opens.
To view the details of an EDI interchange associated with an EDI batch:
1. Open the Administration
EDI
Batches
Batches view.
2. Select the Inspect EDI Interchange option.
The EDI Interchange form (on page 171), EDI Interchange form (on page 821) displays for the flat files in
the batch. When accessed via Batches view, the EDI Interchange form does not include the Remap,
Repost, and Export Segment buttons.
1.5.5.3 Reviewing EDI errors
The EDI Errors view displays EDI error types that exist at the current scope level for an EDI batch. Each row in this
view represents a type of EDI error that occurred for one or more EDI transactions in an EDI batch. For example, if an
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
154
Part 1: EDI
Using EDI
Cancelling an EDI batch
EDI batch has ten EDI transactions with errors, but only three different types of EDI errors occurred, then the EDI
Errors view displays three rows, one for each EDI error type in the EDI batch.
The EDI Errors view displays the number of EDI transactions associated with each EDI error type in the
Transactions column.
Use this view to locate EDI errors by the error type, making the process of fixing and reposting EDI errors easier and
more efficient.
If you select more than one EDI error type, N4 determines which EDI batches are included and which transactions to
repost.
1.5.5.4 View EDI exceptions
To view the details of an EDI exception, double-click the record on the Exceptions tab (on page 177), Exceptions tab
(on page 827) or select the record and click
.
1.5.6 Cancelling an EDI batch
If an EDI batch has errors and you no longer need to process this batch, such as when subsequent EDI messages
supersede this, then you can cancel the EDI batch to remove it from your list of EDI errors to fix.
To cancel an EDI batch:
1. Open the Administration
EDI
Batches
Batches view.
2. Select the EDI batch with errors that you want to cancel.
3. Select Actions
Cancel EDI Batch.
This option is only available when you select a batch with a status of ERRORS, otherwise N4 disables this
option. If you select multiple batch records, the Cancel EDI Batch option updates only the batches with a
status ERRORS and ignores the others.
1.5.7 Correcting EDI errors
The following process flow diagram illustrates how to correct some common EDI errors.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
155
Part 1: EDI
Using EDI
Correcting EDI errors
1.5.7.1 Editing an EDI segment
You can view EDI segments for an EDI interchange in the Segment tab of the EDI Interchange form or for an EDI
batch in the Segments tab of the EDI Batch Inspector.
The Segment tab displays the segments in the selected EDI interchange. If you have EDI processing errors for an
inbound EDI message, you can correct these errors and repost the selected EDI interchange on this tab. If you have
processing errors that require changes to the EDI mapping file, you can edit the EDI mapping file and then remap the
selected EDI interchange on this tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
156
Part 1: EDI
Using EDI
Correcting EDI errors
The Segments tab displays the segments in the interchange for the selected EDI batch. If you have EDI processing
errors for an inbound EDI message due to errors in the EDI file, you can edit the segments to correct these errors and
then repost the selected EDI batch.
The EDI Segment form enables you to edit the selected segment in an inbound EDI interchange to correct processing
errors. You can then repost the EDI interchange in the EDI Interchange form (on page 171), EDI Interchange form
(on page 821).
To edit an EDI segment for an EDI Interchange:
1. Open the Administration
EDI
Interchanges
Interchanges view
EDI Interchange form
2. Double-click the record on the Segment tab or select the record and click
Segment tab.
.
The EDI Segment form (on page 172), EDI Segment form (on page 822) opens.
3. Select the EDI segment you need to edit.
4. Click
.
5. In the Segment field, make the necessary changes to the EDI segment.
6. Click Save.
To edit an EDI segment for an EDI batch:
1. Open the Administration
selected EDI batch.
EDI
Batches
Batches view
EDI Batch Inspector
2. Double-click on the record in the Segments tab or select the record and click
Segments tab for the
.
The EDI Segment form opens.
3. Select the EDI segment you need to edit.
4. Click
.
5. In the Segment field, make the necessary changes to the EDI segment.
6. Click Save.
Wherever possible you should use an EDI Filter (on page 223), EDI Filter (on page 906) to correct data in an
EDI interchange.
1.5.7.2 Editing an EDI message map
If EDI errors occur due to incorrect mapping or your EDI needs change and require updates to your custom EDI
mapping file, then you need to edit your custom EDI message map.
If you do not have a custom EDI message map and need to add one, see Creating and importing a message map (on
page 45).
To edit your custom EDI message map:
1. To export a custom or standard data dictionary file, click Export DIC.
2. In the Export XML Configuration dialog box, specify a name for the data dictionary file and click Save.
To save an XML data dictionary file, you must enter a name and the extension (.dic).
To save a flat text dictionary file for a FLATFILE EDI message, you must enter a name and the extension (.fxd).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
157
Part 1: EDI
Using EDI
Correcting EDI errors
3. To export a custom or standard mapping file, click Export MGT.
4. In the Export XML Configuration dialog box, specify a name for the mapping file and click Save.
To save a mapping file, you must enter a name and the extension (.mgt).
5. Edit and save the mapping file and data dictionary file as needed using the GoXML mapping utility.
6. If you edited the data dictionary file, to import your edited data dictionary file, click Import DIC.
If you do not import an edited data dictionary file, N4 uses the standard data dictionary file for the selected EDI
message type, if available.
7. In the Import XML Configuration dialog box, select the edited data dictionary file and click Open.
8. To import the edited mapping file, click Import MGT.
9. In the Import XML Configuration dialog box, select the edited mapping file and click Open.
10. Click Save.
1.5.7.3 Editing an EDI filter
When a trading partner consistently sends you:
• A value that is not used by your facility, such as a port ID or container operator that does not match what you use in
N4.
• An incorrect value, such as an incorrect ISO code.
Or if a trading partner wants you to send them a different value, then instead of editing the segments to correct this,
you should translate these values using an EDI filter. If you do not already have an EDI filter for the EDI session in
question, then you must first add an EDI filter. For more information, see Defining an EDI filter (on page 55).
To edit the mapped values in an EDI filter:
1. In the Administration
EDI
Filters
Filters view, double-click on the EDI filter you want to edit.
The EDI Filter form (on page 223), EDI Filter form (on page 906) opens.
2. In the Entry Filter tab, to translate a new value click
or to edit an existing mapped value click
.
3. From the Field Id drop-down list, select a field for mapping.
For example, select Port ID to create a filter that corrects the port ID specified in an EDI interchange.
4. In the From Value field, enter the field value to be changed.
For example, for an inbound EDI filter, enter TWKHA to specify the non-standard port ID to be changed.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
158
Part 1: EDI
Using EDI
Correcting EDI errors
5. In the To Value field, enter the new field value.
For example, for an inbound EDI filter, enter TWKHH to specify the standard port ID.
Either the From Value or To Value must be filled in or there will be an error.
6. Click Save.
1.5.7.4 Editing and reposting EDI transactions
The EDI Transaction form enables you to edit an EDI transaction in the N4 standard XML file. By directly making the
changes in the XML file, you can simply post the file without having to remap it. Editing a transaction is not
recommended unless you understand the corrections that need to be made.-Is this only used for XML files?
To edit an EDI transaction:
1. Open the Administration EDI
transaction form (on page 840).
Transaction
Transactions view
EDI transaction form (on page 190), EDI
2. In the EDI Transaction form, click on Edit Contents button. N4 allows you to edit the Contents Edit Area.
3. Make the necessary changes to correct the processing errors.
4. Click Save.
5. Click Post. N4 posts the XML file.
1.5.7.5 Editing the carrier visit
It is common for the carrier visit ID in an inbound STOWPLAN EDI message to match the one you use in N4. In this
case, before posting a STOWPLAN EDI message you must edit the carrier visit to match the one in N4.
The Carrier Visit form enables you to update the carrier visit for the selected EDI batch. The Update Carrier
Visit action is available for the STOWPLAN, LOADLIST, and DISCHLIST EDI message classes.
To update the carrier visit:
1. Open the Administration EDI Batches Batches view EDI Batch Inspector
Visit Carrier Visit form (on page 176), Carrier Visit form (on page 826).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Actions
Update Carrier
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
159
Part 1: EDI
Using EDI
Correcting EDI errors
2. From the Carrier Visit drop-down list, select the carrier visit you want to use for the EDI batch.
The drop-down list displays all carrier visits, including vessel visits, train visits, and truck visits; however, it does not
display carrier visits that are in the Closed, Canceled, or Archived visit phases.
3. Click Save.
After updating the carrier visit, you can use the Actions Post option in the EDI Batch Inspector (on page 175), EDI
Batch Inspector (on page 825) to post or repost the EDI batch.
1.5.7.6 Correcting common EDI errors
EDI processing requires you to perform troubleshooting and correct EDI errors on an ongoing basis to ensure that N4
processes EDI efficiently and correctly. N4 enables you to deal with EDI errors in various ways, including remapping
and reposting the EDI interchange or EDI batch or reposting only the error transactions. N4 supports error correction
either at the source EDI message or at the transaction level for added flexibility. In addition, when there are EDI
batches with errors, you can cancel the batches that do not need to be fixed, allowing you to easily view only the
batches that need to be fixed.
This section covers troubleshooting for common EDI errors that display in the EDI Errors view for the N4 supported
EDI messages. This does not provide assistance with unsupported EDI messages, modifications to the EDI file, or
XML mapping file.
For troubleshooting EDI errors that do not display in the EDI Errors view, see Troubleshooting EDI (on page
239).
If you need help configuring EDI in N4, see Configuring EDI (on page 40).
For more information on ANSI EDI standards, go to www.ansi.org. For EDIFACT EDI standards, go to
www.unece.org/trade/untdid/welcome.htm.
Some common EDI processing errors are:
• If the inbound EDI processing error is due to a missing routing point for the vessel visit in the EDI file, then add the
routing point to the carrier service in the Configuration Carriers Carrier Services Carrier Service form.
• If the inbound EDI processing error says it could not find a vessel visit for the call sign specified in the EDI file, then
correct the call sign for the vessel in the Configuration Carriers Vessel form and verify that the vessel visit
exists and is correct in the Operations Vessel Vessel Visits view.
• If the outbound EDI processing error is due to an invalid EDI mailbox directory or path, in the Administration EDI
EDI Mailboxes EDI Mailboxes view EDI Mailbox form (on page 202), EDI Mailbox form (on page 876) for
the selected EDI session, make sure that the path in the Directory field points to a valid location on the N4
application server and that N4 has permissions to access it, and then extract the EDI message again.
Below is a list of common EDI errors by EDI process and how to correct them.
Inbound EDI batch errors occurred
During which process did the error occur?
Load (on page 161)
Classify (on page 161)
Map (on page 162)
Post (on page 163)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
160
Part 1: EDI
Using EDI
Correcting EDI errors
Load errors
This section lists some common errors that can occur in N4 during the EDI load process, and some possible solutions.
System exception occurred: class=class java.lang.ArrayIndexOutOfBoundsException, message=68, root cause={2} /
{3}.
This error occurs if the EDI file is empty or contains no records.
To determine if an EDI file is empty:
• Review the EDI file to make sure data exists in the file.
▪ If data exists, make sure the EDI file follows the EDI standard.
▪ If no data exists or the EDI file does not follow the EDI standard, contact your trading partner for another EDI file.
If you were not able to resolve your problem, contact your regional Navis Support office.
Classify errors
This section lists some common errors that can occur in N4 during the EDI classify process, and some possible
solutions.
Exception occurred while Classifying, EDI Envelope or Header not found
This error occurs if any of the following apply:
• The header segments are missing
• The message type, version, and release number are missing from the EDI header
• The EDI file contains an incorrect delimiter which prevented N4 from loading the EDI file properly
To resolve this error:
1. In the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825), on the Segments tab, review the
segments to make sure that:
▪ The header segments exist.
▪ Each header segment starts with a valid segment identifier, such as ISA or GS for an ANSI standard EDI
message.
▪ The header segments contain the EDI message type, version, and release number per the EDI standard.
If this is not the case, contact your trading partner for another EDI file.
2. In the EDI Session form (on page 195), make sure the delimiter specified matches the delimiter displayed in the
EDI Interchange form (on page 171), EDI Interchange form (on page 821) and in the EDI file.
3. In the EDI Load form (on page 225), load the EDI file again.
If N4 has not assigned an EDI interchange number, you can find the associated interchange by searching for
the EDI file name in the EDI Interchanges view.
Exception occurred while Classifying, EDI Trading Partner “XXX” not found
This error occurs if the trading partner specified in the EDI file does not exist in N4.
The header segments of the EDI file, such as the ISA and GS segments for the ANSI standard, contain a code to
identify the trading partner. This code must match the trading partner specified in the EDI Session form.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
161
Part 1: EDI
Using EDI
Correcting EDI errors
To resolve this error:
1. In the EDI Session form (on page 195), make sure to specify XXX in the Trading Partner field.
2. In the EDI Load form (on page 225), load the EDI file again.
EDI session for Partner: XXX Message Id: ABC, Version and Release: DD1234 does not exist
This error occurs if the message type, version, and release number specified in the EDI file do not match the message
type for the selected EDI session, or if the message type is obsolete in N4.
To resolve this error:
1. In the Message Types view (on page 207), Message Types view (on page 878), make sure message type ABC,
version DD, and release 1234 exists and is active.
▪ If this message type does not exist but it is a supported message type, you can add the message type. For more
information on adding message types and a list of supported EDI messages, see EDI Message Type form (on
page 209), EDI Message Type form (on page 879).
▪ If the message type is obsolete, use the Actions
Recover Obsolete option to activate this message type.
2. In the EDI Session form (on page 195), make sure to specify the message type ABC, version DD, and release 1234
in the Message Type field.
3. In the EDI Load form (on page 225), load the EDI file again.
If you were not able to resolve your problem, contact your regional Navis Support office.
Mapping errors
This section lists some common errors that can occur in N4 during the EDI mapping process, and some possible
solutions.
Can not Transform, Error in Mapping cascade exception: com.xenos.transform.a.ak: cascade exception:
java.lang.NullPointerException
This error occurs if an EDI interchange contains a record that lacks mandatory segment data.
To resolve this error:
1. In the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825), on the Segments tab, make sure
that:
▪ All of the records start with a segment identifier and that there are no blank records, such as a record with a
delimiter and no other values.
If this is the case, make sure the delimiter specified matches the delimiter in the EDI file for loading.
▪ The EDI file follows the EDI standard.
If the EDI file does not follow the EDI standard, you can contact your trading partner for another EDI file or you
can customize your mapping file to accept the non-standard data.
▪ Make sure the EDI file includes all the mandatory data for a segment. For example, an EQD segment must
contain an equipment number.
If the file lacks mandatory data, contact your trading partner for another EDI file.
2. In the EDI Load form (on page 225), load the EDI file again.
Can not Transform, Error in Mapping cascade exception: com.xenos.transform.a.ak:
Code(transform.msg.edi.input.segment.delimiter.required): Segment delimiter is required. See input line# X, column#
XX.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
162
Part 1: EDI
Using EDI
Correcting EDI errors
This error occurs if the EDI file contains extra carriage returns.
To resolve this error:
1. In Word or a similar text editing program, review the EDI file and remove any carriage returns that are not at the end
of an EDI segment.
2. In the EDI Load form (on page 225), load the EDI file again.
Other errors
Other errors can occur that are not included in this guide. Typically, these errors occur if your mapping file fails to
properly map the EDI file data to the data in N4, or vise versa. If you have customized your mapping file, to resolve
these errors you can review and correct your mapping file using Xenos. If you are using the Navis provided mapping
file and the EDI file follows the EDI standard, in the Navis website submit a case and contact your regional Navis
Support office.
If you were not able to resolve your problem, contact your regional Navis Support office.
Posting errors
This section lists some common errors that can occur in N4 during the EDI posting process, and some possible
solutions.
Unrecognized SCAC Line Id: XXX Or
Invalid operator SCAC.
These errors occur if the SCAC code specified in the EDI file does not exist in N4 for the specified line.
To resolve this error:
1. In the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825), on the Segments tab, review the
line operator SCAC codes, such as APLU.
2. In the Line Operator form for the specified line operator, such as APL, make sure the value in the SCAC Code field
matches the SCAC code.
3. Use the EDI Batch Inspector
Actions
Post option to repost the EDI message.
rtgPOD1 [RoutingPointId:XXX] is not in the itinerary set for carrier visit ABC123. Or
eqoPol [RoutingPointId:XXX] is not in the itinerary set for carrier visit ABC123. Or
eqoPod1 [RoutingPointId:XXX] is not in the itinerary set for carrier visit ABC123.
These errors occur if the port of discharge or port of load specified in the EDI file does not exist in the itinerary in N4 for
the specified vessel visit.
To resolve this error:
1. In the Edit Port Rotation form, review the list of ports in the itinerary block for the ABC123 vessel visit.
▪ If the port XXX does not exist, add this port.
2. Use the EDI Batch Inspector
Actions
Post option to repost the EDI message.
Invalid unitRouting.rtgPOL : “XXX” Or
Invalid unitRouting.rtgPOD1 : “XXX” Or
Unknown location code ‘XXX’ for field ‘eqoPol’. Or
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
163
Part 1: EDI
Using EDI
Correcting EDI errors
Unknown location code ‘XXX’ for field ‘eqoPod1’.
These errors occur if the port of discharge or port of load specified in the EDI file is an invalid routing point, obsolete in
N4, or does not exist in N4.
To resolve this error:
1. In the EDI file, review the data and make sure the segment containing this data follows the EDI standard.
If the file does not follow the EDI standard, contact your trading partner for another EDI file.
2. If the EDI file follows the standard, make sure XXX is a valid routing point.
If XXX is not a valid routing point, you can add the invalid routing point to an EDI filter (on page 223), EDI filter (on
page 906) to map it to an existing routing point in N4.
3. If XXX is a valid routing point, in the Routing Points view, review the routing points and make sure routing point
XXX exists and is active.
▪ If XXX does not exist in N4, use the Routing Point form (on page 1202) to add routing point XXX.
▪ If XXX exists but is obsolete, use the Actions
4. Use the EDI Batch Inspector
Actions
Recover Obsolete option to recover routing point XXX.
Post option to repost the EDI message.
Could not find a Vessel Visit for convention [AAAA], value [XXX] with O/B Voyage [123].
This error occurs if the value XXX from the EDI file does not match the convention value for the specified vessel. For
example, if the convention AAAA is LLOYDS, then XXX must match the Lloyds number in N4 for the specified vessel.
To resolve this error:
1. In the Vessel form for the specified vessel, make sure to specify XXX as the convention value, such as the Lloyds
number.
2. Use the EDI Batch Inspector
Actions
Post option to repost the EDI message.
Type of equipment XXXU1234567 - [PropertyKey=atom.EquipNominalLengthEnum.NOM40.description] RS
[PropertyKey=atom.EquipNominalHeightEnum.NOM96.description] cannot be substituted for order item type
[PropertyKey=atom.EquipNominalLengthEnum.NOM40.description] RT
[PropertyKey=atom.EquipNominalHeightEnum.NOM96.description]"
This error occurs if the BOOKING EDI file contains equipment with an equipment type that does not match the order
item equipment type.
To resolve this issue:
• To allow equipment substitution for the non-matching equipment types, in the Equipment Type Equivalent form,
add an equipment type equivalent for these equipment types.
If you were not able to resolve your problem, contact your regional Navis Support office.
Outbound EDI batch errors occurred
During which process did the error occur?
Select (on page 165)
Unload (on page 165)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
164
Part 1: EDI
Using EDI
Remapping an EDI batch
Select errors
This section lists some common errors that can occur in N4 during the EDI select process, and some possible
solutions.
Extract failed as there are no units on-board or planned to vessel
This error occurs if there are no units on board or planned for the selected vessel visit for an outbound STOWPLAN
EDI message.
To resolve this error:
1. In the Vessel Inspector for the selected vessel visit, on the On-board tab, make sure there are units on board the
vessel.
2. If there are no units on board the vessel but you want to include units in the yard that are planned to the vessel, in
XPS make sure units are planned to the vessel.
3. Extract the EDI message again.
To include planned units in the extract, in the EDI Extract form, select the Future check box.
No data to extract for Carrier Visit: XXXXX
This error occurs if there is no performance data to extract for the selected vessel visit for an outbound
PERFORMANCE EDI message.
To resolve this error:
1. In the Vessel Inspector for the XXXXX vessel visit, on the Line Stats and Crane Stats tab, make sure
performance data exists.
2. Extract the EDI message again.
If you were not able to resolve your problem, contact your regional Navis Support office.
Unload errors
This section lists some common errors that can occur in N4 during the EDI unload process, and some possible
solutions.
Cannot unload the given file XXX.XXX
This error can occur when the path for the EDI mailbox local directory is invalid, or when N4 is not able to access the
local directory to save the extracted EDI file.
To resolve this error:
1. In the EDI Mailbox form (on page 202), EDI Mailbox form (on page 876) for the selected EDI session, make sure
that the path in the Directory field points to a valid location on the N4 application server.
2. Extract the EDI message again.
If you were not able to resolve your problem, contact your regional Navis Support office.
1.5.8 Remapping an EDI batch
After correcting EDI processing errors by editing an EDI message map, you can remap the EDI batch.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
165
Part 1: EDI
Using EDI
Remapping an EDI interchange
To remap an EDI batch:
1. Open the Administration
remap.
2. Select Actions
EDI
Batches
Batches view
EDI Batch Inspector for the EDI batch you want to
Remap.
When you select the Remap option, N4 picks the file already loaded for the batch, classifies the file, and remaps the
segments and creates transactions. That is, N4 creates a new Classify and Map process in the Processes tab.
While it creates new transactions for the segments, it also deletes the existing transactions associated with the
batch.
The Remap option is not available for those batches that were created by posting XML files.
1.5.9 Remapping an EDI interchange
You can remap an interchange from the Segment tab in the EDI Interchange form. However, before remapping an
EDI interchange, you need to make the necessary changes to correct the processing errors in the EDI mapping file.
For more information, see Creating and importing a message map (on page 45) or EDI Message Map form (on page
217), EDI Message Map form (on page 902).
To remap an EDI interchange:
1. Open the Administration EDI Interchanges Interchanges view EDI Interchange form
(on page 189), Segment tab (on page 839) for the interchange you want to remap.
Segment tab
2. Click Remap.
3. Click Repost.
If the Auto Post option is selected for the EDI session, the EDI interchange is automatically posted after you edit a
segment and Remap the EDI interchange.
1.5.10 Reposting an EDI batch
Once you have corrected the EDI processing errors, you can repost:
• Only the EDI transactions in a batch with errors.
• The entire EDI batch.
• Only the EDI transactions associated with an error type.
To repost the EDI transactions in a batch with errors:
1. Open the Administration
EDI
Batches
Batches view
2. Select the batch you want to repost in the Batches view or double-click on the batch you want to repost to open the
EDI Batch Inspector.
3. Select Actions
Repost Errors.
This option is only available when you select a batch with a status of ERRORS, otherwise N4 disables this
option. If you select multiple batch records, the Repost Errors option reposts only the batches with a status
ERRORS and ignores the others.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
166
Part 1: EDI
Using EDI
Re-extracting an ACTIVITY EDI session
To repost the entire EDI batch:
1. Open the Administration
repost.
2. Select Actions
EDI
Batches
Batches view
EDI Batch Inspector for the batch you want to
Post.
To repost the EDI transactions associated with an error type:
1. Open the Administration
EDI
EDI Errors
EDI Errors view.
2. Select the EDI error type that you want to repost.
3. Select Actions
Repost.
If you select more than one EDI error type, N4 determines which EDI batches are included and which transactions
to repost.
1.5.11 Re-extracting an ACTIVITY EDI session
If N4 successfully extracted an ACTIVITY EDI session but your EDI trading partner did not receive the EDI file. You can
optionally re-extract this EDI activity. To do so, you need to know the start time for the missing EDI extract.
If the missing EDI extract occurred a long time ago, re-extracting this EDI triggers N4 to re-extract all activity
between the start time of the missing EDI extract and the current time.To manually re-extract an ACTIVITY EDI session:
1. In the Administration
you want to extract.
EDI
EDI Sessions
EDI Sessions view, double-click on the ACTIVITY EDI session
The EDI Session form opens.
2. Optionally, in the Last Control Number field, enter the number to be used for the message control number sent to a
trading partner.
3. In the Last Run Time field, enter the date and time from when the extract must start.
You can modify the date and time value specified in the Last Run Time field to force the ACTIVITY EDI message
extract to start at a specified time.
To re-extract an ACTIVITY EDI message that was successful in N4, it is recommended that you update the
values in the Last Run Time field to start the extract at the same date and time as the previous extract. For
example, if an extract was successful for the last 2 hours of activity in N4 but the trading partner didn't
receive the EDI message, to re-extract the EDI message for the last 2 hours of activity you must update the
date and time values in the Last Run Time field to 2 hours ago.
4. Click Save.
The changes are saved and the EDI Session form is closed.
5. Open the EDI Session form again and click Extract.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
167
Part 1: EDI
Using EDI
Generate unit level discrepancy reports using I/B or O/B Carrier Visit as a filter criteria
1.5.12 Generate unit level discrepancy reports using I/B
or O/B Carrier Visit as a filter criteria
To generate a report that displays Unit level discrepancies between a Discharge list and a BAPLIE message, consider
the following business scenarios:
• If a unit is present in the Discharge list but not in the BAPLIE message, add a report design (on page 730), report
design (on page 1218) using the Unit - Holds/Permissions reporting entity with the following filter criteria:
▪ Discharge permission is granted
▪ Stowplan Posted flag is False
▪ Inbound Declared visit is the vessel visit under consideration
• If a unit is not present in the Discharge list but is present in the BAPLIE message, add a report design using the
Unit reporting entity with the following filter criteria:
▪ Unit Applied Holds/Permissions is NOT Discharge permission
▪ Stowplan Posted flag is True
▪ Inbound Declared visit is the vessel visit under consideration
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
168
1.6 Using EDI UI Help
In This Section
Interchanges view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Batches view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transactions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI History view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Sessions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Mailboxes view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trading Partners view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Configuration view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Types view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Filters view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Load form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Jobs view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Errors view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
170
172
191
193
194
201
204
205
207
223
225
227
237
169
Part 1: EDI
Using EDI UI Help
Interchanges view
1.6.1 Interchanges view
Administration
EDI
Interchanges
Interchanges view
The Interchanges view displays the EDI interchanges created when processing EDI messages. Each EDI file
exchanged with a trading partner creates an interchange for both inbound and outbound EDI.
The following diagram displays the relationship between an EDI file and the EDI interchange for inbound and outbound
EDI:
For each outbound EDI message,
• The data is read from N4.
• Using the mapping file it is organized into EDI segments and saved under one EDI interchange.
• The segment data in the EDI interchange is then written to a file and sent to your EDI partner.
For each inbound EDI message,
• The EDI file segment data is read and saved under one EDI interchange per the EDI load process.
• The segment data in the EDI interchange then goes through the mapping file and is created, updated, or deleted in
N4 per the posting process.
For example, if an inbound BAPLIE file is loaded successfully an EDI interchange will be created with the segment
data. If the BAPLIE file is also posted successfully the container data will be created in N4.
For inbound EDI interchanges, you can edit segments, remap, and repost the EDI interchange.
For an inbound EDI session, an interchange can contain mixed message types. For example, U.S. customs
sends manifest messages and customs release messages in the same EDI file or interchange.
For more information on EDI processes, see Processes tab (on page 176), Processes tab (on page 826).
To view the details of an EDI Interchange, To view the details of an EDI Interchange, double-click the record in the
Interchanges view or select the record and click
.
Interchanges Columns
Short Label
Long Label
In Filter?
Sorting?
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Delimiters
Delimiters
X
X
File Name
File Name
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
170
Part 1: EDI
Using EDI UI Help
Interchanges view
Short Label
Long Label
In Filter?
Sorting?
In/Out
Direction
X
X
Interchange
Interchange
X
X
Partner Name
Partner Name
X
X
Prepared date/time
Prepared date/time
X
X
Status
Status
X
X
1.6.1.1 EDI Interchange form
Administration
EDI
Interchanges
Administration
EDI
Batches
Interchanges view
Batches view
Actions
EDI Interchange form
Update EDI Interchange
EDI Interchange form
The EDI Interchange form displays the EDI interchange details. All the fields in the form are read-only, except the
Delimiters field.
In the File Name read-only field, N4 displays the file name created in the EDI Session form. The file name has the
current system time and date in a long number format followed by the name of the EDI session. And the file suffix that
is specified in the EDI session form in the File Extension.
A delimiter is a character used to separate the fields in an EDI interchange. The Delimiters field displays the delimiter
for the selected EDI interchange and defaults to the delimiter specified in the EDI standard used for the EDI message
type.
The individual segments in the selected EDI interchange are displayed on the Segment tab. For inbound EDI
interchanges, you can edit segments, Remap, and Repost the EDI interchange.
If the Auto Post option is selected for the EDI session, the EDI interchange is automatically posted after you
edit a segment and Remap the EDI interchange.
In the EDI Interchange form, you can use the Export Segments button to export the EDI interchange segments to a
file.
To see how the EDI interchange details fit into the rail process flow, see the Full Rail Operations and Lite Rail
Operations process flows.
Segment tab
Administration
EDI
Interchanges
Interchanges view
EDI Interchange form
Segment tab
The Segment tab displays the segments in the selected EDI interchange. If you have EDI processing errors for an
inbound EDI message, you can correct these errors and repost the selected EDI interchange on this tab. If you have
processing errors that require changes to the EDI mapping file, you can edit the EDI mapping file and then remap the
selected EDI interchange on this tab.
To view the details of or edit an EDI segment, double-click the record on the Segment tab or select the record and click
. N4 displays the EDI Segment form (on page 172), EDI Segment form (on page 822).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
171
Part 1: EDI
Using EDI UI Help
Batches view
To repost an inbound EDI interchange:
1. Make the necessary changes to correct the processing errors, as needed.
For example,
▪ If the inbound EDI processing error is due to a missing routing point for the vessel visit in the EDI file, then add the
routing point to the carrier service in the Configuration Carriers Carrier Services Carrier Service form.
▪ If the inbound EDI processing error says it could not find a vessel visit for the call sign specified in the EDI file,
then correct the call sign for the vessel in the Configuration Carriers Vessel form and verify that the vessel
visit exists and is correct in the Operations Vessel Vessel Visits view.
If you need to edit the segments in the EDI file to correct the processing errors, see EDI Segment form (on page
172), EDI Segment form (on page 822). If you need to edit the mapping file to correct the processing errors, see
how to remap an EDI interchange below.
2. Click Repost.
To remap an EDI interchange:
1. Make the necessary changes to correct the processing errors in the EDI mapping file.
For more information, see Creating and importing a message map (on page 45) or EDI Message Map form (on
page 217), EDI Message Map form (on page 902).
2. Click Remap.
3. Click Repost.
If the Auto Post option is selected for the EDI session, the EDI interchange is automatically posted after you edit a
segment and Remap the EDI interchange.
EDI Segment form
Administration
EDI
Interchanges
Interchanges view
EDI Interchange form
Segment tab
EDI Segment form
The EDI Segment form enables you to edit the selected segment in an inbound EDI interchange to correct processing
errors. You can then repost the EDI interchange in the EDI Interchange form (on page 171), EDI Interchange form
(on page 821).
To see how the EDI Segment form fits into the rail process flow, see the Full Rail Operations and Lite Rail Operations
process flows.
To edit an EDI segment:
1. Select the EDI segment you need to edit.
2. Click
.
3. In the Segment field, make the necessary changes to the EDI segment.
4. Click Save.
Wherever possible you should use an EDI Filter (on page 223), EDI Filter (on page 906) to correct data in an
EDI interchange.
1.6.2 Batches view
Administration
EDI
Batches
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Batches view
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
172
Part 1: EDI
Using EDI UI Help
Batches view
The Batches view displays the EDI batches processed by N4 and may be used for troubleshooting purposes. You can
view the details of an EDI batch, resolve processing problems, and then repost the batch.
An EDI Interchange is created for each EDI file loaded. The EDI file and EDI Interchange usually contain one EDI
message type, but sometimes an inbound EDI file may contain multiple EDI message types resulting in multiple EDI
message types in an EDI Interchange.
An EDI batch is created for each message type in an EDI interchange. Therefore, N4 may create one or more EDI
batches based on the number of message types in the EDI interchange. For example, if an EDI interchange from the
US Customs contains a mixture of ANSI 309 manifest messages (Bill of Lading) and ANSI 350 release messages, N4
creates two EDI batches for the EDI interchange.
The following diagram displays the relationship between an EDI file containing two message types, an EDI
Interchange, and the EDI Batches:
To view the details of an EDI batch:
• Double-click the record in the Batches view or select the record and click
.
The EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825) displays for the selected EDI batch.
You can post or repost an EDI batch from the Actions
Post option in the EDI Batch Inspector.
To view the details of the EDI Interchange associated with an EDI batch:
This requires the EDI Batch Interchange - Inspect privilege.
1. Right-click on an EDI batch record in the Batches view.
2. Select the Inspect EDI Interchange option.
The EDI Interchange form (on page 171), EDI Interchange form (on page 821) displays for the flat files in the batch.
When accessed via Batches view, the EDI Interchange form does not include the Remap, Repost, and Export
Segment buttons.In addition, you can use the Actions menu to:
• Post: Post or repost all the transactions in the selected EDI batch.This option is only available when you select a
single batch.
• Remap: Remap the segments for the selected EDI batch after fixing errors. When you select the Remap option, N4
picks the file already loaded for the batch, classifies the file, and remaps the segments and creates transactions.
That is, N4 creates a new Classify and Map process on the Processes tab in the Batch Inspector. While it creates
new transactions for the segments, it also deletes the existing transactions associated with the batch.
• Update Carrier Visit: Edit the carrier visit for the selected EDI batch.This option is only available for session classes
STOWPLAN, LOADLIST, and DISCHLIST.
• Update Notes (on page 174), Update Notes (on page 825): Add or edit notes for the selected batch record(s). This
requires the EDI Batch Actions - Update Notes privilege.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
173
Part 1: EDI
Using EDI UI Help
Batches view
• Cancel EDI Batch: Cancels the selected batch record(s). This requires the EDI Batch Actions - Cancel EDI Batch
privilege.
This option is only available when the batch or multiple batches selected include at least one in ERRORS status,
irrespective of the error type (Classify or Map or Post Error); otherwise, N4 disables this option. If you select multiple
batch records, the Cancel EDI Batch option updates only the batches with ERRORS status and ignores the others.
• Repost Errors: Reposts the selected batch record(s).
This option is only available when you select a batch with a status of ERRORS, otherwise N4 disables this option. If
you select multiple batch records, the Repost Errors option reposts only the batches with a status ERRORS and
ignores the others. N4 displays only the error or warning records pertaining to the current posting and updates the
previous posting errors to ‘Obsolete’ status, and the new errors to ‘Active’ status and displays only the ‘Active’
errors in the EDI Errors view (on page 237).
Restrict EDI batch access to a filtered list
N4 prevents an unfiltered view of EDI batches when the EDI Batch Actions – Deny Unfiltered View privilege is
assigned to a role. You need to add this privilege to a user role so that they can only see the filtered Batches view. For
example, you can add this privilege to a user role to allow vessel-related operations staff to view and edit vessel codes
and voyages for Baplies without allowing access to other EDI types.
Users with this privilege assigned can see only a filtered list of EDI batches. They cannot use a filter search,
filter options, or saved filters in the Batches view.
Batches Columns
Short Label
Long Label
In Filter?
Sorting?
Batch Number
Batch Number
X
X
Batch Carrier Visit
Batch Carrier Visit
X
X
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Direction
Direction
X
X
Interchange
Interchange
X
X
Interchange Partner Name
Interchange Partner Name
X
X
Notes
Notes
X
X
Reprocess Count
Reprocess Count
X
X
Segments
Segments
X
X
Session Class
Session Message Class
X
X
Session Message Map
Session Message Map
X
X
Session Name
Session
X
X
Status
Status
X
X
Transactions
Transactions
X
X
Group
Routing
1.6.2.1 Batch Notes form
Administration
EDI
Batches
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Batches view
Actions
Update Notes
Batch Notes form
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
174
Part 1: EDI
Using EDI UI Help
Batches view
Batch Notes form enables you to add a note or edit an existing one for the selected batch record(s). This is especially
useful when keeping track of an EDI cleanup process. You can view existing notes in the Notes column in the Batches
view.
To add a note:
1. In the Batch Notes form, enter the note for the selected batch record(s).
2. Click Save.
1.6.2.2 EDI Batch Inspector
Administration
EDI
Batches
Batches view
EDI Batch Inspector
The EDI Batch Inspector displays the details of the selected batch and provides a view of all the processes,
transactions, and segments in a batch. You can keep the EDI Batch Inspector open at all times as you work in other
views and forms, and you can move and resize it as needed.
To see how the EDI Batch Inspector fits into the rail process flow, see the Full Rail Operations and Lite Rail
Operations process flows.
Use the Actions menu to:
• Post: Post or repost all the transactions in the selected EDI batch.
• Repost Errors: Repost the EDI transactions, in the selected batch, with ERRORS status.
For example, if you have a BAPLIE with some errors, you can fix the errors and select Actions
and N4 only reposts the EDI transactions with ERRORS status.
Repost Errors
• Remap: Remap the segments for the selected EDI batch after fixing the errors. When you select the Remap option,
N4 picks the file already loaded for the batch, classifies the file, and remaps the segments and creates transactions.
That is, N4 creates a new Classify and Map process in the Processes tab. While it creates new transactions for the
segments, it also deletes the existing transactions associated with the batch.
The Remap option is not available for those batches that were created by posting XML files.
• Update Carrier Visit (on page 176), Update Carrier Visit (on page 826): Edit the carrier visit for the selected EDI
batch. This action is available on for STOWPLAN, LOADLIST, and DISCHLIST EDI message classes.
When you update the selected batch, N4 automatically refreshes the information displayed in the EDI Batch
Inspector.
The EDI Batch Inspector displays the basic information for an EDI batch in the following areas:
• EDI Batch Monitor: The left area displays the batch number of the selected batch.
• Batch Details: The central area displays the details such as the status of the batch, the interchange, number of
transactions and segments in the batch, and the date the batch was created.
• Configuration: The area on the right displays the configuration used by the batch including the direction, message
class, trading partner, EDI session, message map, and the carrier visit.
The Details pane (on page 176), Details pane (on page 826) displays additional information below the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
button.
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
175
Part 1: EDI
Using EDI UI Help
Batches view
To display the Details pane:
1. Click
.
From the list on the left, select the type of information to display.
To perform actions:
1. Click Actions to display the menu.
2. Select the required menu option.
Carrier Visit form
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Actions
Update Carrier Visit
Carrier Visit form
The Carrier Visit form enables you to update the carrier visit for the selected EDI batch. The Update Carrier Visit
action is available for the STOWPLAN, LOADLIST, and DISCHLIST EDI message classes.
To update the carrier visit:
1. From the Carrier Visit drop-down list, select the carrier visit you want to use for the EDI batch.
The drop-down list displays all carrier visits, including vessel visits, train visits, and truck visits; however, it does not
display carrier visits that are in the Closed, Canceled, or Archived visit phases.
2. Click Save.
After updating the carrier visit, you can use the Actions Post option in the EDI Batch Inspector (on page 175), EDI
Batch Inspector (on page 825) to post or repost the EDI batch.
Details pane in the EDI Batch Inspector
Administration
EDI
Batches
Batches view
EDI Batch Inspector
The Details pane in the EDI Batch Inspector displays additional information, for the selected EDI batch, in the
following tabs:
• Processes (on page 176), Processes (on page 826): List of processes for the selected batch.
• Transactions (on page 189), Transactions (on page 839): List of transaction associated with the batch.
• Segments (on page 189), Segments (on page 839): List of all the segments in the batch.
Processes tab
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Administration
EDI
Batches
Batches view
EDI Batch form
Processes tab
Processes tab
The Processes tab displays the processes for the selected EDI batch, including the start and end time, number of
records, and the status of each process. The Processes tab also displays the errors, if any, for each process in the
selected EDI batch.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
176
Part 1: EDI
Using EDI UI Help
Batches view
To view the details of an EDI process and any exceptions, double-click the record on the Processes tab or select the
record and click
.
In addition, you can use the Actions
Post option to post or repost the selected EDI batch.
Inbound EDI message
The following diagram displays the processes for an Inbound EDI message:
For more information, see Inbound EDI processes (on page 28), Inbound EDI processes (on page 178), Inbound EDI
processes (on page 828).
Outbound EDI message
The following diagram displays the processes for an Outbound EDI message:
For more information, see Outbound EDI processes (on page 35), Outbound EDI processes (on page 185), Outbound
EDI processes (on page 835).
N4 moves the EDI files to the archive sub-directory located in an EDI mailbox after a successful post for
inbound EDI sessions, or a successful delivery for outbound EDI sessions. When archiving, N4 checks for
matching files in the archive folder. If a matching file already exists in the archive folder, N4 changes the EDI file
name to add a counter and an expression (__) before it is archived. For example, if a file ABC.edi already exists
in the archive folder, the next file with the same name will be archived as 1__ABC.edi. If a third ABC.edi is to be
archived, it will be archived as 2__ABC.edi and so on.
EDI Batch Process form
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Processes tab
EDI Batch Process form
The EDI Batch Process form displays the details of an EDI batch process such as the batch number, session name,
process, status, and start and end time for the EDI batch process. Additionally, the Exceptions tab displays any
exceptions (errors or warnings) for the selected EDI batch process.
Exceptions tab
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Processes tab
EDI Batch Process form
Exceptions tab
The Exceptions tab displays the exceptions (errors or warnings) for the selected EDI batch process.
To view the details of an EDI exceptions, double-click the record on the Exceptions tab or select the record and click
.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
177
Part 1: EDI
Using EDI UI Help
Batches view
EDI Error form
Administration
EDI Error form
EDI
Batches
Batches view
EDI Batch Inspector
Processes tab
EDI Batch Process form
Exceptions tab
The EDI Error form displays the complete error message for the selected EDI exception.
Inbound EDI processes
When you post an Inbound EDI message, you can post only containers. N4 does not support posting a container on a
chassis through any EDI message. The inbound EDI processes are:
• Load: N4 creates the EDI interchange using the following steps:
▪ If you are using the EDI job schedule and FTP or SFTP, the Scheduler gets the EDI file from the client
communication folder located on the FTP server and places the EDI file in the local EDI mailbox folder for
processing. If you are using the EDI job schedule and email, you must place the inbound EDI file in the local EDI
folder. N4 uses the EDI folder you specify in the EDI Mailbox form (on page 202), EDI Mailbox form (on page
876).
You can also manually load an EDI file using the Administration
information, see EDI Load form (on page 225).
EDI
EDI Load option. For more
▪ N4 parses the UNA or the ISA segments of the incoming EDI file to identify the delimiters for the EDI message.
▪ If N4 does not find a delimiter in the EDI file, N4 uses the delimiter specified for the associated EDI session (on
page 195).
▪ If the EDI session does not specify a delimiter, N4 uses the default delimiter for the EDI Message Standard
(ANSI or UN/EDIFACT) of the EDI message type (on page 209), EDI message type (on page 879).
▪ If N4 does not find a delimiter for the EDI message type, N4 displays an error.
▪ N4 divides the EDI file into segments using the segment delimiter, and then writes the segments to the Segments
table for an EDI interchange. You can view the segments in an EDI interchange on the Segment tab (on page
171), Segment tab (on page 821).
• Classify: N4 determines the contents of the EDI interchange and segregates the segments into individual batches
based on the message types included in the EDI interchange:
▪ N4 searches the UNH or the ISA header segment to determine the EDI standard, such as UN/EDIFACT or ANSI,
and to identify the EDI trading partner (on page 206), EDI trading partner (on page 844).
▪ N4 determines the EDI message type, version, and release number and then uses the appropriate EDI session.
N4 validates the value in the Version field against the UNH 0052 data element in the EDI file.
Consequently, what appears in the 0052 UNH segment must match what is specified for the EDI message
type for all associated EDI messages. For example, you enter D in the Version field, the EDI file must
include "D" in the 0052 data segment after the message ID as follows: UNH
+32454295-001+COPARN:D:95B:ITG13. If these version values do not match, N4 displays an error. In
earlier versions of N4, the version number was driven off of the 0057 data element, but this is no longer the
case.
• Map: N4 creates the EDI transactions (on page 191), EDI transactions (on page 841) using the following steps:
a. N4 reads the segments from the Segments table, and then translates the segments into XML using the mapping
file. For more information on mapping files, see EDI Message Map form (on page 217), EDI Message Map form
(on page 902).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
178
Part 1: EDI
Using EDI UI Help
Batches view
b. N4 creates the EDI transactions for all of the segments found, and then applies EDI filters (on page 223), EDI
filters (on page 906) to the transactions.
You can now define the transship port in the LOC+13 segment in the COPARN message.
• Post: N4 creates an EDI batch for each EDI message type in an EDI interchange. If you selected the Autopost
option for the EDI session, N4 posts the batches automatically. You can also manually post an EDI interchange
using the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825) Actions Post option.
N4 posts EDI messages in the order that the messages are received.
Also see How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message (on
page 29), How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message (on
page 179), How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message
(on page 829).
For more information on inbound EDI processes, see STOWPLAN (on page 30), STOWPLAN (on page 179),
STOWPLAN (on page 829), BOOKING (on page 31), BOOKING (on page 181), BOOKING (on page 831), or
ACKNOWLEDGEMENT EDI processes (on page 34), ACKNOWLEDGEMENT EDI processes (on page 184),
ACKNOWLEDGEMENT EDI processes (on page 834).
How N4 determines to search the inbound vessel visit when you post the EDI COARRI activity message?
When you post the EDI Container Loading Discharging Order (COARRI) activity inbound message with
'inOperatorVoyageNbr' value, then N4 searches the inbound vessel visit based on the line voyage number (Inbound),
line operator, and other vessel/vessel visit values. When you post the same message with 'inVoyageNbr' value, then
N4 searches the inbound vessel visit based on the voyage number and other vessel/vessel visit values.
When you post the COARRI inbound message with an invalid operator voyage number, N4 does not process
the message and displays errors.
Inbound STOWPLAN EDI processes
An inbound STOWPLAN EDI message, such as a BAPLIE message, describes a vessel visit and lists the containers
arriving on the vessel and their location on the vessel, including the container number, equipment type, line operator,
gross weight, and any seal numbers or hazardous information. The EDI message only contains information for one
vessel visit.
When processing an inbound STOWPLAN EDI message, the following information must exist in N4:
• Vessel visit
In addition, the vessel visit Lloyds ID or call number must exist in N4.
• Port of load and port of discharge
• Container number
• Line operator
• Equipment type (ISO code)
• Stowage position
N4 checks if each container in the BAPLIE contains Stowage position (LOC+147 segment). If not, N4 stops processing
in the classify stage itself and logs error message 'No LOC+147 segment found for the container <ICTR2012140 >' to
indicate the LOC+147 is missing for the container.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
179
Part 1: EDI
Using EDI UI Help
Batches view
If the ARGOBAPLIE004 (on page 134), ARGOBAPLIE004 (on page 865) setting is set to False for the selected EDI
session, N4 uses the following posting logic to determine the category of the container based on the port of discharge.
• If the port of discharge is equal to one of the following, N4 sets the category to Import:
▪ The current facility's routing point
▪ A sub-point in the vessel visit itinerary for current facility's routing point
• If the port of discharge is not equal to the above and the EDI file specifies a transshipment port that is equal to the
current facility's routing point, then N4 sets the category to Transship. Otherwise, N4 sets the category to Through.
You can set the Posting rule (on page 70), Posting rule (on page 908) for Category property group for the
STOWPLAN class. If the Existing Source is Dischargelist, then you can use the posting rule to Ignore the
updates to the category. For example, in the Posting Rules view (on page 70), Posting Rules view (on
page 908), select the Stowplan group and set a posting rule for Category with the existing datasource as
Discharge List EDI, and then ignore the update. After posting the COPRAR Discharge List EDI message
with category as Import, when you set ARGOBAPLIE004 to True and then post the BAPLIE EDI message
with category as Through, N4 retains the import the category since the COPRAR DISCHARGE exists for a
unit.
If the ARGOBAPLIE004 setting is set to False and the EDI file specifies the transshipment port, for the
posting logic to work correctly you may need to map the portid attribute in the transshipPort element in your
mapping file to the segment in the EDI file that specifies the transshipment port.
When successful, N4 creates the units onboard the vessel specified in the BAPLIE file.
If a unit's port of discharge is not the current facility's routing point but is a sub-point of the facility's routing point in the
vessel visit itinerary, and a facility relay exists from the current facility to the unit's port of discharge, then N4 updates
the:
• Category to import
• Intended outbound carrier to a generic carrier, such as GEN_VESSEL or GEN_TRUCK, based on the Default
Carrier Mode defined in the facility relay
• Declared outbound carrier to GEN_TRUCK
If ARGOBAPLIE004 (on page 134), ARGOBAPLIE004 (on page 865) setting is set to True and you post an EDI
BAPLIE with barge vessel, booking number, and container category set to EXPORT, N4 creates the unit with the
following properties:
• Category: Export (if the container POD that was posted in the EDI is the current port)
• I/B Visit: The vessel visit obtained from the BAPLIE
• O/B Visit: The booking's vessel visit
• OPL: The POL obtained from the BAPLIE
• POL: The current port terminal
• POD: The booking's POD
In the mapping file, if N4 finds a SCAC and BIC code in the EDI file, N4 does not consider the line operator code. For
example, the extracted XML has the below details in the container operator node:
<argo:containerOperator argo:operator="AAA">
<argo:organizationCodes argo:Id="XXX" argo:scacCode="XXX" argo:bicCode="XXX" />
</argo:containerOperator>
N4 first checks for the SCAC code in the mapping (.mgt) file. If the SCAC code is not available, N4 checks for the BIC
code. If both codes are not available, N4 considers the operator value. Because the above example contains both the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
180
Part 1: EDI
Using EDI UI Help
Batches view
SCAC code and the BIC code, N4 does not consider the operator value. To test this, remove the SCAC code and BIC
code for the line operator and then extract the BAPLIE file; N4 displays the operator value from the filter in the EDI file.
Inbound BOOKING EDI processes
An inbound BOOKING EDI message, such as IFTMCS or 301, describes a Booking including the booking number,
outbound vessel visit, load port, discharge port, shipper, and consignee. For each Booking, the EDI message includes
a list of equipment types specifying the number of containers for each type and any commodity or reefer requirements.
In addition, the EDI message can include an optional list of pre-advised containers for each equipment type.
For domestic bookings, the BOOKING EDI message must contain the booking category.
When you post a BOOKING EDI message, N4 validates the information provided in the EDI message against the
current data. N4 displays an error message if any of the following is true:
• The container operator in the EDI message does not exist.
• The Facility in the EDI message does not exist.
• The POL and POD1 in the EDI message are not in the itinerary for the vessel visit.
• The Origin in the EDI message is not in the itinerary for the vessel visit.
• N4 cannot find or create a new trucking company using the details in the EDI message.
• The Hazard Flash Point unit in the EDI message is other than C (Celsius) or F (Fahrenheit) as per the Navis
standard schema.
• The ISO code for the order or the order item in the EDI message does not exist.
• The container ID is null (not specified) in the EDI message.
• The Dispatch Reserved value in the EDI message is other than FIRST or ONLY as per the Navis standard
schema.
• N4 finds more than one vessel visit using the information in the EDI message.
• The vessel visit in the EDI message is in the wrong visit phase.
• If a temperature value exists in the EDI message, then equipment type must be a reefer equipment type.
N4 also displays an error when pre-advising a container with an ISO group that does not match the ISO group
specified for the booking in the EDI message.
The header of the BOOKING EDI message contains an action code also known as the message function, indicating
whether the line operator sent the EDI message to create a new booking, add details, delete details or change header
in an existing booking.
The most consistently used codes for the possible set of UN/EDIFACT message function codes are:
• O: Creates a new booking.
• A: Add details to an existing booking.
• E: Delete details from an existing booking.
• U: Change header in an existing booking.
• X: Replace the entire existing booking.
• R or D: Cancel the entire existing booking.
Depending on the action codes your EDI trading partner sends, you may need to map the msgFunction
attribute in your mapping file to an action code that Navis N4 recognizes, such as a D for a cancel action.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
181
Part 1: EDI
Using EDI UI Help
Batches view
Because these action codes are typically inconsistent between line operators, N4 determines the appropriate action
based on the existing booking data.
If booking numbers are always unique for a line operator, N4processes the action code as follows:
• New or update: If the booking does not exist already, N4 creates a new booking, otherwise updates the existing
booking. An Update message is typically used to update the booking and item details. Any equipment in an Update
message should already be linked to the booking. If not, N4 displays the error message "Equipment order does not
exist for the unit" and does not process the message further.
• Add details: If the booking already exists, N4 adds details to the existing booking.
• Delete: If no empty, export, or domestic containers are associated with the booking, N4 deletes the existing
booking. This includes empty containers delivered against a booking and export or domestic containers pre-advised
but not yet received against the booking.
• Change: If the booking already exists, N4 changes the header (for example, ,vessel/voyage) or item / container
details (For example, temp setting, OOG).
• Replace: If the booking already exists, N4 compares the booking items in the inbound EDI message with the
booking items in N4 and replaces the booking item quantity and preadvised units as follows:
Booking
Qty in
Booking
Item form
Pre-advised
units in
Booking Item
form
Booking
Qty
Preadvised
Units
Booking
Qty in
Replace
EDI
message
Units in Replace EDI message
(<edi:ediBookingEquipment>)
Results after
posting
Booking
Replace EDI
message
(Message
Function 'X')
10
10
10
None
8
None
5
5
5
7
8
7
8
8
8
15
15
15
N4 removes all the existing hazards information and adds the hazards information specified in the message at the
booking and order item level.
If a line operator can reuse booking numbers, then booking numbers are not unique for that line operator. To update an
existing booking the line operator must send a delete action code before a new or update action code. N4 processes
the action code as follows:
• New or update: If preceded by a delete action code, N4 updates the existing Booking; otherwise, it creates a new
Booking.
If Booking with the same booking number for the same line operator already exists and the line operator
does not send a delete action code first, N4 creates a new Booking with the same booking number.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
182
Part 1: EDI
Using EDI UI Help
Batches view
• Delete: If no empty, export, or domestic containers are associated with the Booking in N4, it deletes the existing
Booking.
This includes empty containers delivered against the Booking and export or domestic containers pre-advised but not
yet received against the Booking.
To determine if booking numbers are unique for a line operator, N4 checks the Booking Unique setting on
the Booking Rules tab in the Line Operator form.
When successful, N4 creates, updates, or deletes the Booking per the EDI message. To make sure the booking data in
N4 matches the line operator data, N4 always updates the Booking regardless of the phase of the associated vessel
visit. But N4 may or may not update the containers associated with the Booking if a vessel visit is past cutoff or has a
departed phase. This depends on the configuration of the Booking Rules tab for the line operator. For more
information, see Roll a booking in the online help.
When required to replace an existing booking item with a new one, N4 deletes the existing booking item before
creating the new one. However, if the existing booking item has units or truck transactions against it, then N4 does not
delete it. It instead updates the existing booking item quantity to zero and then creates a new booking item. In this
case, during the ingate stage, N4 displays two booking items with one record having the quantity as 0. This scenario is
applicable only if you have selected the Order Item Not Unique option in the Booking Rules tab of the Line Operator
form.
N4 records a UNIT_ROLL event when updating the booking for a pre-advised unit via the Configurable Pre-advise form
or EDI.
When you update a booking, to add more than one booking item for the same booking, make sure the booking
items with subsequent sequence numbers contain the edi:msgFunction="A" attribute in the
edi:bookingTransaction node. The ‘booking.xsd’ file contains the element
bkgItemEquipmentSeqNbr.You can map the bkgItemEquipmentSeqNbr element to the booking item
sequence number in the mapping file and set the ‘Order Item Not Unique’ option to ‘True’ on the Booking
Rules tab of the Line Operator form. By doing this, N4 links the units to their corresponding equipment order
items when you post an EDI message with sequence numbers.
If a line operator includes a list of containers in the BOOKING EDI message, you can configure N4 to create these preadvised containers and update these containers per the EDI message, or to ignore the containers in the EDI message.
For more information, see ARGOBOOKING002 (on page 123), ARGOBOOKING002 (on page 855). For information on
other BOOKING EDI settings, see Inbound BOOKING EDI settings (on page 123), Inbound BOOKING EDI settings (on
page 854).
If a BOOKING EDI message contains trucking company information, N4 performs the following actions to try to
determine the trucking company:
• N4 searches for an existing trucking company with an ID or SCAC that matches either the trucking company name
or SCAC code in the EDI message.
• If N4 is unable to find an existing trucking company and both the name and SCAC are included in the EDI message,
N4 tries to create the trucking company using the name as the trucking company name and the SCAC as the
trucking company ID and SCAC code.
When successful, N4 records the trucking company for the associated export booking. The trucking company ID
displays in the Booking form. In addition, new trucking companies display in the Trucking Companies view. When
unsuccessful, N4 produces a warning message and continues to post the EDI file.
If the line operator's voyage number provided in the TDT segment for a line sharing a vessel visit is different
than the vessel visit voyage number in N4, you can update your mapping file to use the
outOperatorVoyageNbr attribute in the baseMapping.xsd schema to map the operator voyage number
from the EDI message to the appropriate vessel visit in N4.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
183
Part 1: EDI
Using EDI UI Help
Batches view
In N4, a booking EDI message can specify the following information:
• Whether Owned Only or Leased Only containers must be used for the booking
• The requested equipment grade and equipment feature for each booking item
To use the Owned Only/Leased Only feature, you must set up the equipment prefixes to accurately show the owner of
the containers with a specific prefix. XPS uses this information to construct container ranges, which it then uses to
select an empty container.
The current standard booking maps for IFTMBC, COPARN, and ANSI301 to not support this feature. Since
specifying OWNED or LEASED containers is not a part of the common EDI standards, it is usually implemented
using the free text segment. Therefore, a custom map is required to transform the free text segment into the
Owned only or Leased only indicators in the Navis standard XML.
Inbound ACKNOWLEDGEMENT EDI processes
An inbound ACKNOWLEDGEMENT EDI message is an application error and acknowledgment message that an EDI
trading partner sends to:
• Acknowledge that they received an EDI message you sent.
• Inform you that their application accepted or rejected the EDI message during processing.
The EDI trading partner must include a message function code in the BGM segment of the ACKNOWLEDGEMENT
EDI message to indicate whether they accepted or rejected the EDI message. The Navis standard mapping file maps
the following message function codes:
• AP: The trading partner accepted the EDI message
• Any other code or blank: The trading partner rejected the EDI message
The EDI trading partner should also include the following primary key, and any optional information, in the RFF
segment of the ACKNOWLEDGEMENT EDI message based on the class of the inbound EDI message they
processed:
EDI Message Class
Primary Key
Optional Information
STOWPLAN
Container number
Vessel name and container's line operator
ACTIVITY
Container number
Container's line operator and activity type
PERFORMANCE
Vessel name
N4 uses this information to determine the associated outbound EDI transactions.
Depending on the message function codes and the information your EDI trading partner sends, you may need
to edit the mapping file so that N4 will map them correctly.
The Navis supported ACKNOWLEDGEMENT EDI message is the APERAK EDI message.
After processing an ACKNOWLEDGEMENT EDI message, N4 displays the processed EDI data in the Transactions
view and on Transactions tab for the associated EDI transactions. For example, if you receive APERAK messages in
response to outbound ACTIVITY EDI messages, then N4 displays the processed APERAK data in the Transactions
view and on Transactions tab for the associated outbound ACTIVITY EDI transactions. For more information, see
Transactions view (on page 191), Transactions view (on page 841).
To determine if you need to send an outbound EDI message in response to a rejected ACKNOWLEDGEMENT EDI
message, you must monitor the Transactions view or on Transactions tab. For example, if you receive a rejected
APERAK EDI message, you must correct the error and then manually send the associated outbound EDI message to
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
184
Part 1: EDI
Using EDI UI Help
Batches view
the EDI trading partner. To resend an outbound ACTIVITY EDI message, see EDI Session form (on page 195). To
resend an outbound EDI message for a vessel visit, such as a STOWPLAN EDI message, see Outbound EDI tab.
For more information on the APERAK EDI message, go to http://www.unece.org/trade/untdid/d00a/trmd/
aperak_c.htm.
Outbound EDI processes
The outbound EDI process has the following states in N4:
• Select: N4 selects the events, for a single operator or multiple operators that occurred between the last extract time
and the current date and time. In addition, N4 creates an EDI interchange but does not create the EDI segments yet.
• Extract: N4 creates the EDI transactions (in the XML format) for all the events found, and then applies EDI filters
(on page 223), EDI filters (on page 906) to the transactions.
For BAPLIE EDI messages only, to process the extract faster N4 combines the select process with the
extract process and does not create EDI transactions.
• Mapping: N4 translates the EDI transactions into EDI segments using the mapping file. For more information on
mapping files, see EDI Message Map form (on page 217), EDI Message Map form (on page 902).
• Unload: N4 splits the EDI segments using the delimiter specified for the EDI session and write the segments to the
Segments table for an EDI interchange. N4 writes the EDI file from the EDI interchange and places the file in the
local EDI mailbox specified for the EDI session.
• Send: N4 sends the EDI file to the associated EDI trading partner through FTP, SFTP, or email. For more
information on defining mailboxes for EDI trading partners, see EDI Trading Partner form (on page 206), EDI
Trading Partner form (on page 844).
If you have configured an EDI job schedule, the Scheduler Task (OutboundSession or Communication Manager)
sweeps the outbound local EDI mailboxes and sends each EDI file found to the associated EDI trading partner.
After the Unit Model Refactor, N4 no longer retires a unit if it is attached to another unit. For example, if you bundle two
or more flat racks or mount a container on a chassis, N4 does not retire the bundled units or the chassis unit.
The Activity and Stowplan EDI Extracts have been modified to ensure that each Primary unit is extracted as a
separate transaction (as before) and any attached equipment, such as a Payload, Carriage, or Accessory units are
extracted under the AttachedEquipment section of the transaction (as before).
Outbound STOWPLAN EDI processes
An outbound STOWPLAN EDI message, such as a BAPLIE message, describes a vessel visit and lists the containers
departing on the vessel and their location on the vessel, including the container number, equipment type, line operator,
gross weight, and any seal numbers or hazardous information.
By default, the extracted EDI message contains data only for the selected vessel visit. In addition, you can define
session criteria (on page ) in the EDI Session form (on page 195) to further restrict the data in the extract. For
example, if you only want to extract containers on the vessel that are owned by a specific line operator you can define
session criteria to limit the extracted data to the specified line operator.
After the Unit Model Refactor, the ACTIVITY and STOWPLAN EDI Extracts have been modified to ensure that each
Primary unit is extracted as a separate transaction and any attached equipment, such as a Payload, Carriage, or
Accessory units are extracted under the AttachedEquipment section of the transaction.
Outbound ACTIVITY EDI processes
An outbound ACTIVITY EDI message, such as a CODECO message, confirms that the units specified have been
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
185
Part 1: EDI
Using EDI UI Help
Batches view
delivered or picked up by an inland carrier (road, rail, or barge). In addition, you can use this message to report loading
and discharging, container movements at the facility, or a change in the status of a container while at the facility.
To determine which units N4 includes in the ACTIVITY EDI message based on the events, you must define session
criteria (on page ) in the EDI Session form (on page 195) to restrict the data in the extract to the events specified
for the Event Type attribute. For example, if you only want to report on units with gate activity, you must create session
criteria with the Event Type attribute set to include only the UNIT_DELIVER and UNIT_RECEIVE events. For
examples, see Session Criteria examples (on page 53), Session Criteria examples (on page 200).
After the Unit Model Refactor, the ACTIVITY and STOWPLAN EDI Extracts have been modified to ensure that each
Primary unit is extracted as a separate transaction and any attached equipment, such as a Payload, Carriage, or
Accessory units are extracted under the AttachedEquipment section of the transaction.
You must select only the event types that are supported by the EDI message map (on page 217), EDI message
map (on page 902) associated with the EDI session. Before defining session criteria, we recommend that you
review the event types listed in the mapping file for the selected EDI message map.
In addition, the event types listed in the mapping file use the event type names prior to the N4 1.4 release. For
example, the DELIVER_CONTAINER event in a mapping file is the same as the UNIT_DELIVER event in N4.
To determine which event codes N4 sends to your trading partner in the EDI message, you must edit the mapping file
for the selected EDI message map.
The following table lists the supported event types that you can use in your mapping file, the associated event types in
N4 that you can use in the session criteria, and the default event codes N4 sends for a CODECO, COARRI, and 322
EDI message:
Mapping File Event Type
Session Criteria Event Type
CODECO
Code
COARRI
Code
322
Code
DELIVER_CONTAINER
UNIT_DELIVER
36
98
OA
DELIVER_GOODS
UNIT_DELIVER
36
98
OA
RECEIVE_CONTAINER
UNIT_RECEIVE
34
270
I
RECEIVE_GOODS
UNIT_RECEIVE
34
270
I
DISCH_CONTAINER
UNIT_DISCH
44
98
UV
DISCH_GOODS
UNIT_DISCH
44
98
UV
LOAD_CONTAINER
UNIT_LOAD
46
270
AE
LOAD_GOODS
UNIT_LOAD
46
270
AE
RAMP_CONTAINER
UNIT_RAMP
AL
RAMP_GOODS
UNIT_RAMP
AL
DERAMP_CONTAINER
UNIT_DERAMP
UR
DERAMP_GOODS
UNIT_DERAMP
UR
BRING_BACK_INTO_YARD
UNIT_BRING_BACK_INTO_YARD
T
T
BRING_BACK_TO_COMMUNITY UNIT_BRING_TO_COMMUNITY
SHIFT_ON_CARRIER
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
UNIT_SHIFT_ON_CARRIER
270
AE
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
186
Part 1: EDI
Mapping File Event Type
Using EDI UI Help
Batches view
Session Criteria Event Type
CODECO
Code
COARRI
Code
322
Code
YARD_MOVE
UNIT_YARD_MOVE
T
POSITION_CORRECTION
UNIT_POSITION_CORRECTION
T
STRIP_CONTAINER
UNIT_STRIP
SA
STUFF_CONTAINER
UNIT_STUFF
SB
STUFF_GOODS
UNIT_STUFF
SB
TRANSLOAD_CONTAINER
UNIT_TRANSLOAD
SA
TRANSLOAD_GOODS
UNIT_TRANSLOAD
SA
SEAL_UNIT
UNIT_SEAL
NT
When processing an outbound ACTIVITY EDI session, N4 first searches for the units that have these events in their
event history with a Created Date between the Last Run Time in the EDI session and the current date and time. Then,
N4 filters this data per the session criteria for the selected EDI session.
When you post the COARRI XML file, N4 extracts the COARRI activity event (UNIT_DISCH) date and time and
displays the same on the History, Events tab in the Unit Inspector. This behavior applies only to EDI activity
messages.
When you post a CODECO XML file, N4 extracts the CODECO activity events (UNIT_RECEIVE and UNIT_IN_GATE)
date and time and displays the same on the History, Events tab in the Unit Inspector. This behavior applies only to
UNIT_RECEIVE and UNIT_IN_GATE events. For all other events, N4 uses the system date and time.
When searching for events, by default N4 searches based on the event's Created Date. However, you can
configure N4 to instead search based on the event's Apply Date by setting ARGOACTIVITY003
(USE_APPLY_DATE_FOR_EXTRACT) (on page 142), ARGOACTIVITY003
(USE_APPLY_DATE_FOR_EXTRACT) (on page 872) to true.
When successful, the extracted EDI message contains the units and the unit event types that satisfy the session
criteria, and the event codes, as specified in the mapping file, for the unit event types. The event code displays in either
the Q5 segment for the X.12 standard, or the BGM segment for the EDIFACT standard, as specified in the mapping
file.
When you extract a 322 EDI message with equipment that includes accessory or chassis information, that information
will populate the W2 segment.
Outbound ACKNOWLEDGEMENT EDI processes
An outbound ACKNOWLEDGEMENT EDI message is an application error and acknowledgment message that N4 can
send to an EDI trading partner to:
• Acknowledge that N4 received an EDI message.
• Inform the EDI trading partner that N4 accepted or rejected the EDI message during processing.
To determine which inbound EDI messages for an EDI trading partner that you want N4 to send an outbound
ACKNOWLEDGEMENT message, you must add session criteria to the EDI session. You can filter by the class and
status of the inbound EDI messages for an EDI trading partner. For example, you can add session criteria to send
outbound ACKNOWLEDGEMENT messages only when an inbound BOOKING EDI message processes with
ERRORS. For more information, see EDI Session form (on page 195) and Session Criteria examples (on page 53),
Session Criteria examples (on page 200).
After processing an inbound EDI message that satisfies the session criteria for an outbound ACKNOWLEDGEMENT
EDI session, N4 processes the outbound ACKNOWLEDGEMENT EDI message. N4 displays the Interchange Number
with the Message Sequence Number from the EDI Session for the outbound Acknowledgment message and
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
187
Part 1: EDI
Using EDI UI Help
Batches view
increments based on the transactions that is in the acknowledged ISA file. N4 includes the following message function
codes in the BGM segment of the ACKNOWLEDGEMENT EDI message per the Navis standard mapping file:
• AP: N4 accepted the inbound EDI message
• RE: N4 rejected the inbound EDI message
The Navis supported ACKNOWLEDGEMENT EDI message is the APERAK EDI message.
Also, per the Navis standard mapping file, N4 includes the following primary key and optional information in the RFF
segment based on the class of the inbound EDI message:
EDI Message Class
Primary Key
Optional Information
STOWPLAN
Container number
Vessel name and container's line operator
PREADVISE
Container number
Vessel name and container's line operator
LOADLIST
Container number
Booking number, vessel name, and container's
line operator
DISCHLIST
Container number
Vessel name and container's line operator
RELEASE
Release number
Vessel name and line operator
BOOKING
Export booking number Vessel name and line operator
MANIFEST
Bill of lading number
Vessel name
N4 sends this information so that the EDI partner can determine the associated EDI message.
If N4 rejected the inbound EDI message, N4 also includes an error code in the ERC segment and an error message in
the FTX segment in the ACKNOWLEDGEMENT EDI message.
Depending on the message function and error codes your EDI trading partner requires, you may need to edit
the mapping file so that N4 will send the correct codes.
In addition, N4 displays the processed EDI data in the Transactions view and on Transactions tab for the associated
inbound EDI transactions. For example, if you send APERAK EDI messages in response to inbound BOOKING EDI
messages, N4 displays the processed APERAK data in the Transactions view and on Transactions tab for the
associated inbound BOOKING EDI transactions. For more information, see Transactions view (on page 191),
Transactions view (on page 841).
For more information on the APERAK EDI message, go to http://www.unece.org/trade/untdid/d00a/trmd/
aperak_c.htm.
Outbound INVENTORY EDI processes
An INVENTORY EDI session is an outbound EDI session that uses the INVENTORY EDI class. You can use an
INVENTORY EDI session to extract unit data for all of the units in a complex or facility into an XML file to send to
another system, such as a mainframe system. This enables you to synchronize unit data in N4 with another system.
This is not a standard EDI message, therefore an EDI message type for the INVENTORY EDI class does not exist and
N4 does not require a mapping file in the EDI session. N4 formats the extracted XML file according to the snx.xsd
schema file. For more information on SNX, see SNX Importer form (on page 1003).
By default, the extracted XML file contains each unit facility visit that is visible in XPS for the current complex. In
addition, you can define session criteria (on page ) in the EDI Session form (on page 195) to restrict the data
included in the extract EDI message. For example, if you only want to extract export containers for a specific facility
you can define session criteria to limit the extracted data to the specified facility and category.
N4 does not extract incremental changes; each extract contains all of the unit facility visit data that is visible in XPS for
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
188
Part 1: EDI
Using EDI UI Help
Batches view
the current complex and that satisfies the session criteria in the EDI session, if specified. A typical output XML file
contains several thousand records.
To manually extract an INVENTORY EDI session, see EDI Session form (on page 195). In addition, you can add an
EDI job to schedule automatic extracts. For more information, see EDI Job form (on page 229), EDI Job form (on page
912).
When successful, N4 sends the XML file according to the EDI mailbox (on page 202), EDI mailbox (on page 876)
specified in the EDI session.
You can also use the Actions Export SNX File option in some list views to export data into an XML file. For
more information, see Export SNX File (on page 1109).
Segments tab
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Administration
EDI
Batches
Batches view
EDI Batch form
Segments tab
Segments tab
The Segments tab displays the segments in the interchange for the selected EDI batch. If you have EDI processing
errors for an inbound EDI message due to errors in the EDI file, you can edit the segments to correct these errors and
then repost the selected EDI batch.
To view the details of or to edit an EDI segment, double-click on the record in the Segments tab or select the record
and click
. N4 displays the EDI Segment form (on page 172), EDI Segment form (on page 822).
After editing and saving the details of a segment using the EDI Segment form, you cannot post an EDI
interchange from the EDI Batch Inspector. You need to remap and repost it using the EDI Interchange form.
(on page 171), EDI Interchange form. (on page 821)
To repost an EDI batch:
1. Make the necessary changes to correct the processing errors, as needed.
2. In the EDI Batch Inspector, select Actions
Repost or Actions
Post.
If you need to edit the mapping file to correct the processing errors, you can remap an EDI interchange on
the Segment tab (on page 171), Segment tab (on page 821).
3. N4 displays only the error or warning records pertaining to the current posting and updates the previous posting
errors to ‘Obsolete’ status, and the new errors to ‘Active’ status and displays only the ‘Active’ errors in the EDI
Errors view. (on page 237)
Transactions tab
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Administration
EDI
Batches
Batches view
EDI Batch form
Transactions tab
Transactions tab
The Transactions tab displays the transactions for the selected EDI batch. Each individual business transaction in an
EDI interchange is represented as an EDI transaction.
To view or edit the details of an EDI transaction and any exceptions, double-click the record on the Transactions tab or
select the record and click
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
.
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
189
Part 1: EDI
Using EDI UI Help
Batches view
ACKNOWLEDGEMENT EDI Message
If you send or receive ACKNOWLEDGEMENT EDI messages, N4 displays processed EDI data in the following
columns:
• Ack Count: The number of acknowledgment messages N4 received or sent for the associated EDI transaction.
Each time N4 processes an inbound or outbound acknowledgment message for an EDI transaction, this column is
incremented by one.
• Ack Error: For an inbound acknowledgment message with an Ack Type of REJECTED, the acknowledgment error
code and the error description.
• Ack Date: The time and date N4 processed the last acknowledgment message for the associated EDI transaction.
• Ack Direction: The direction of the acknowledgment message as follows:
▪ SEND
▪ RECEIVE
• Ack Reference: For an inbound acknowledgment message, the following, if provided, displays in a coma separated
list:
▪ Batch number
▪ Interchange number
▪ Container number
▪ Booking number
• Ack Type: The type of acknowledgment message as follows:
▪ ACCEPTED
▪ REJECTED
CUSCAR EDI Message
For a CUSCAR EDI message (on page 214), N4 displays the BL Number or the Container Number from the SGP
segment in the Primary Keyword column.
EDI Transaction form
Administration
EDI
Batches
Batches view
Administration
EDI
Transaction
EDI Batch Inspector
Transactions view
Transactions tab
EDI Transaction form
EDI Transaction form
The EDI Transaction form enables you to edit an EDI transaction in the N4 standard XML file. By directly making the
changes in the XML file, you can simply post the file without having to remap it. Editing a transaction is not
recommended unless you understand the corrections that need to be made.
To edit an EDI transaction:
1. In the EDI Transaction form, click on Edit Contents button. N4 allows you to edit the Contents Edit Area.
2. Make the necessary changes to correct the processing errors.
3. Click Save.
4. Click Post. N4 posts the XML file.
You can repost a single transaction in a batch even if that batch is already completed.
EDI Transaction form - Inspector
Administration
EDI
Batches
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Batches view
EDI Batch Inspector
Transactions tab
EDI Transaction form
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
190
Part 1: EDI
Administration
Using EDI UI Help
Transactions view
EDI
Transaction
Transactions view
EDI Transaction form
The EDI Transaction form enables you to edit an EDI transaction in the N4 standard XML file. By directly making the
changes in the XML file, you can simply post the file without having to remap it. Editing a transaction is not
recommended unless you understand the corrections that need to be made.
To edit an EDI transaction:
1. In the EDI Transaction form, click on Edit Contents button. N4 allows you to edit the Contents Edit Area.
2. Make the necessary changes to correct the processing errors.
3. Click Save.
4. Click Post. N4 posts the XML file.
You can repost a single transaction in a batch even if that batch is already completed.
Exceptions tab
Administration
EDI
Batches
Batches view
EDI Batch Inspector
Transactions tab
EDI Transaction form
Exceptions tab
The Exceptions tab displays the exceptions (errors or warnings) for the selected EDI Transaction. To view the details
of an EDI exceptions, double-click the record on the Exceptions tab or select the record and click
.
1.6.2.3 EDI Batch form
Administration
EDI
Batches
Batches view
EDI Batch form
The EDI Batch form displays the details of the selected batch. This is a view-only form. To update the carrier visit, use
the Carrier Visit form (on page 176), Carrier Visit form (on page 826).
The EDI Batch form also displays additional details, for the selected EDI batch, in the following tabs:
• Processes (on page 176), Processes (on page 826): List of processes for the selected batch.
• Transactions (on page 189), Transactions (on page 839): List of transaction associated with the batch.
• Segments (on page 189), Segments (on page 839): List of all the segments in the batch.
1.6.3 Transactions view
Administration
EDI
Transaction
Transactions view
The Transactions view displays the EDI transactions processed at the current scope level. Each individual business
transaction in an EDI interchange is represented as an EDI transaction.
To view the details of an EDI transaction, double-click the record in the Transactions view or select the record and
click
.
You can right-click the record in the Transactions view and select the Inspect EDI Batch option to access the EDI
Batch Inspector (on page 175), EDI Batch Inspector (on page 825) for the selected EDI transaction. This option is
also available from the Actions menu.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
191
Part 1: EDI
Using EDI UI Help
Transactions view
If you send or receive ACKNOWLEDGEMENT EDI messages, N4 displays processed EDI data in the following
columns:
• Ack Count: The number of acknowledgment messages N4 received or sent for the associated EDI transaction.
Each time N4 processes an inbound or outbound acknowledgment message for an EDI transaction, this column is
incremented by one.
• Ack Error: For an inbound acknowledgment message with an Ack Type of REJECTED, the acknowledgment error
code and the error description.
• Ack Date: The time and date N4 processed the last acknowledgment message for the associated EDI transaction.
• Ack Direction: The direction of the acknowledgment message as follows:
▪ SEND
▪ RECEIVE
• Ack Reference: For an inbound acknowledgment message, the following, if provided, displays in a coma separated
list:
▪ Batch number
▪ Interchange number
▪ Container number
▪ Booking number
• Ack Type: The type of acknowledgment message as follows:
▪ ACCEPTED
▪ REJECTED
Transactions Columns
Short Label
Long Label
In Filter?
Sorting?
Ack Count
Acknowledgement Count
X
X
Ack Date
Acknowledgement Date
X
X
Ack Direction
Acknowledgement Direction
X
X
Ack Error
Acknowledgement Error Message
X
X
Ack Reference
Acknowledgement Reference Number
X
X
Ack Type
Acknowledgement Type
X
X
Batch Carrier Visit
EDI Transaction Batch Carrier Visit Ref
X
X
Batch Created
EDI Transaction Batch Created
X
X
Batch Interchange
EDI Transaction Batch Interchange
X
X
Batch Interchange Partner Name EDI Transaction Batch Interchange Partner
Name
X
X
Batch Number
EDI Transaction Batch Number
X
X
Batch Session Class
EDI Transaction Batch Session Message Class
X
X
Batch Session Name
EDI Transaction Batch Session Name
X
X
Batch Status
EDI Transaction Batch Status
X
X
Changed
Changed
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Group
Details
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
192
Part 1: EDI
Using EDI UI Help
EDI History view
Short Label
Long Label
In Filter?
Sorting?
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Keyword 2
Keyword 2
X
X
Keyword 3
Keyword 3
X
X
Keyword 4
Keyword 4
X
X
Primary Keyword
Primary Keyword
X
X
Sequence
Sequence within batch
X
X
Status
Status
X
X
Group
1.6.4 EDI History view
Administration
EDI
EDI History
EDI History view
The EDI History view displays the outbound EDI events that exist at the current scope level. An EDI event is defined
as a serviceable event and can be used in creating notification requests for specific EDI sessions. The four EDI events
defined in N4 are:
• EDI_EXTRACT: EDI extract is completed successfully.
• EDI_EXTRACT_FAILED: EDI extract has errors.
• EDI_POST: EDI post was completed successfully.
• EDI_POST_FAILED: EDI post has errors.
To view the details of an EDI event, double-click the record in the EDI History view or select the record and click
.
EDI History Columns
Short Label
Long Label
In Filter?
Sorting?
Applied To Id
Applied To Id
X
X
Apply Date
Apply Date
X
X
Carrier
Carrier
Event Type
Event Type
X
X
Note
Note
X
X
Run Time
Run Time
X
Transactions
Transactions
X
X
X
1.6.4.1 EDI Event form
Administration
EDI
EDI History
EDI History view
EDI Event form
The EDI Event form displays detailed information about the selected EDI event, related EDI session, date/time when
the session was run, number of transactions in the EDI session, and the EDI Batch.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
193
Part 1: EDI
Using EDI UI Help
EDI Sessions view
You cannot edit any information displayed in the EDI Event form.
1.6.5 EDI Sessions view
Administration
EDI
EDI Sessions
EDI Sessions view
The EDI Sessions view displays the EDI sessions that exist at the current scope level. You can locate a specific
session and edit the details or delete the session from this view. You can also create an EDI session from this view and
associate it with a trading partner. This session becomes available in the EDI Configuration view (on page 205), EDI
Configuration view (on page 843) against the corresponding trading partner.
In addition, you can use the Actions
recover deleted EDI sessions.
Recover Obsolete (on page 208), Recover Obsolete (on page 1177) option to
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).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
EDI Sessions Columns
Short Label
Long Label
In Filter?
Sorting?
Auto Post
Auto Post
X
X
Changed
Changed
X
X
Changer
Changer
X
X
Check Interchange Number
Check Interchange Number
X
X
Class
Message Class
X
X
Complex
Complex
X
X
Control Number
Last Control Number
X
X
Created
Created
X
X
Creator
Creator
X
X
Delimiter
Delimiter
X
X
Description
Description
X
X
Extract Extension Name
Extract Code Extension Name
X
X
File Extension
File Extension
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
194
Part 1: EDI
Using EDI UI Help
EDI Sessions view
Short Label
Long Label
In Filter?
Sorting?
In/Out
In/Out
X
Life Cycle State
Life Cycle State
X
X
Load Extension Name
Load Code Extension Name
X
X
Message Map
Message Map
X
X
Msg Seq Number
Message Sequence Number
X
X
Name
Name
X
X
Partner Nm
Trading Partner Name
X
X
Post Extension Name
Post Code Extension Name
X
X
Status
Last Run Status
X
X
Time
Last Run Time
X
X
1.6.5.1 EDI Session form
Administration
EDI
EDI Configuration
Administration
EDI
EDI Sessions
EDI Configuration view
EDI Sessions view
EDI Session form
EDI Session form
The EDI Session form enables you to add and edit an EDI session and add additional mailboxes, EDI settings (on
page 118), EDI settings (on page 850), and EDI filters for the selected EDI session.
For outbound EDI sessions, you can use session criteria to restrict the data included in the extracted EDI message.
This differs from an EDI filter, which you can use to map data from one value to another value. For example, you can
use session criteria to restrict the data to only include units for a specific line operator, such as ABC. For the same EDI
session, you can use an EDI filter to map the line operator ID of ABC to ABB in the extracted EDI file. For more
information on EDI filters, see EDI Filter form (on page 223), EDI Filter form (on page 906).
You must define session criteria for outbound ACKNOWLEDGEMENT and ACTIVITY EDI sessions. For more
information, see the steps below.
Before adding an EDI session, you must first define at least one EDI mailbox, a message type, and an EDI message
map for the selected trading partner.
To add or edit an EDI Session:
1. In the Session Details area, in the Name field, enter a name that uniquely identifies the EDI session.
N4 includes the session name as part of the file name, which consists of the system time + session name +
session file extension, for the file that the EDI session creates. Therefore, do not use any special characters
in the Name field that your operating system may not support as part of a file name.
2. Optionally, in the Description field, enter a short description for the EDI session.
3. From the Complex drop-down list, select the complex for which the EDI session will be set up.
If you are logged in at the complex or a lower scope level, you can set up EDI sessions only for the current complex.
4. From the Direction drop-down list, select Receive or Send depending on whether the session is for an inbound or
outbound EDI message.
▪ Receive: The trading partner will send the data as an EDI message file to N4 for posting. Use for an inbound EDI
session.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
195
Part 1: EDI
Using EDI UI Help
EDI Sessions view
▪ Send: The data will be extracted from N4, mapped into an EDI message file and sent to the selected trading
partner. Use for an outbound EDI session.
5. From the Message Class drop-down list, select the message class for the EDI session.
6. Optionally, from the Message Map drop-down list, select an EDI message map (on page 217), EDI message map
(on page 902) for the EDI session.
The drop-down list displays all the EDI message maps for the selected EDI message type for the selected EDI
direction (receive/send).
N4 does not require a message map if you select INVENTORY for the message class in step 5, or if you
process inbound EDI messages that contain a one to one mapping of the elements in the schema.
Otherwise, you must select a message map.
7. From the Trading Partner drop-down list, select the trading partner with whom an EDI message will be exchanged
for this session.
If you open this form from the EDI Configuration view, then the Trading Partner drop-down list is not
available since you have already selected the trading partner in the EDI Configuration view.
8. From the Primary Mailbox drop-down list, select the EDI mailbox for the specified trading partner.
The drop-down list displays the mailboxes defined for the EDI trading partner for the selected EDI direction (receive/
send).
9. Optionally, in the File Extension field, enter a file extension for the EDI session.
▪ For an inbound EDI session, N4 uses this extension to identify the file to use for the EDI session.
▪ For an outbound EDI session, N4 appends the file extension to the name of the file created by the EDI session.
If you do not specify an extension, for an inbound or outbound EDI session, N4 uses .edi as the file
extension.
10. Optionally, in the Delimiters field, enter a character that will be used as a delimiter for all outbound EDI messages.
If the EDI output file type is FLATFILE, you must specify a delimiter for the EDI session.
Some EDI files use apostrophe (‘) as a segment terminator. If the EDI file also contains the apostrophe as
part of the data, you must add an EDI_LOAD_INTERCEPTOR code extension (on page 992) to remove the
apostrophe from the data.
11. Optionally, in the Last Control Number field, enter a number that you want N4 to use as the starting point for the
EDI transaction control number for the EDI session. The EDI transaction control number is used at the UNH - UNT
(EDIFACT) or the SE - ST (ANSI) level and gets incremented for every EDI transaction.
By default, the EDI transaction control number starts at one, but you can use this field to specify a different starting
point for a specific EDI session for a trading partner.
12. Optionally, you can edit the Message Sequence Number automatically generated by N4.
This number is part of the interchange number and increments with each session extraction.
You can map the Message Sequence Number to the UNB segment of your mapping file.
13. Optionally, from the Load Code Extension, Post Code Extension, and Extract Code Extension drop-down lists,
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
196
Part 1: EDI
Using EDI UI Help
EDI Sessions view
you can select the groovy code extensions of type EDI_LOAD_INTERCEPTOR, EDI_POST_INTERCEPTOR, or
EDI_EXTRACT_INTERCEPTOR respectively for the EDI session.
For more information on code extension types, see Extension Type Registry view and Code Extensions view (on
page 992).
14. For inbound EDI messages, select the Auto Post check box if you want the received EDI messages to be posted
directly to N4.
If you do not select the Auto Post option, a received EDI message will be mapped and loaded but not posted in N4.
You will have to open the EDI batch and manually post the EDI session.
15. Optionally, select the Check Interchange Number check box to send a notification e-mail if the received message
envelope interchange number is not one larger than that of the previous message.
When you select Check Interchange Number, N4 validates the Message Sequence Number. If the current
envelope sequence number is not one larger than that of the previous message sent by the trading partner,
N4 sends a notification e-mail.
16. In the Filter Criteria area, for outbound EDI sessions, you can define session criteria (on page ) to restrict the
data included in the extract EDI message. By default, an outbound STOWPLAN EDI message includes the data for
the selected vessel and an outbound INVENTORY EDI session includes all of the unit facility visit data for the
current complex.
The session criteria differs from an EDI filter (on page 223), EDI filter (on page 906), which you can use to
map data from one value to another value.
For an ACTIVITY EDI session, N4 includes all of the existing data, therefore you must create session criteria to
restrict the data in the extract to the line operators and events you want. In addition, you must also create session
criteria for outbound ACKNOWLEDGEMENT (on page 38), outbound ACKNOWLEDGEMENT (on page 187),
outbound ACKNOWLEDGEMENT (on page 837) EDI sessions.
For an ACTIVITY EDI session, you must only select event types that are supported by the EDI message map
associated with the EDI session. Before defining session criteria, we recommend that you review the event
types listed in the mapping file for the selected EDI message map.
For examples, see Session Criteria examples (on page 53), Session Criteria examples (on page 200).
The Filter Criteria pane is not available until there are values for all required Session Details.
17. Click Save.
You must save the EDI session before you can add additional mailboxes, EDI settings, and EDI filters for the EDI
session.
For inbound EDI messages the EDI session must be unique by trading partner, direction, and EDI message
type.
To manually extract an ACTIVITY EDI session:
• Click Extract.
The Last Run Status field is updated automatically each time an EDI session is run.
When you run an ACTIVITY EDI session extract, the activity data in N4 is extracted from the date and time stored in
the Last Run Time field to the current date and time. If an Activity EDI session extract is successful, the date and
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
197
Part 1: EDI
Using EDI UI Help
EDI Sessions view
time of the last successful run is stored in the Last Run Time field. If the extraction is unsuccessful, the date and
time values are not updated for the erroneous extract.
The maximum number of days that can be extracted is last seven days (from the current date) to avoid
performance issues.
To extract EDI by email, make sure that the EDIEMAIL001 (EMAIL_FROM) (on page 113) and
EDIEMAIL002 (EMAIL_REPLY_TO) (on page 114) settings are set correctly for your scope level. N4
validates the email address when you create or edit the EDI configuration (on page 205), EDI configuration
(on page 843). For more information, see EDI settings (on page 101).
To re-extract an ACTIVITY EDI session:
1. Optionally, in the Last Control Number field, enter the number to be used for the message control number sent to a
trading partner.
2. In the Last Run Time field, enter the date and time from when the extract must start.
You can modify the date and time value specified in the Last Run Time field to force the ACTIVITY EDI message
extract to start at a specified time.
To re-extract an ACTIVITY EDI message that was successful in N4, it is recommended that you update the
values in the Last Run Time field to start the extract at the same date and time as the previous extract. For
example, if an extract was successful for the last 2 hours of activity in N4 but the trading partner didn't
receive the EDI message, to re-extract the EDI message for the last 2 hours of activity you must update the
date and time values in the Last Run Time field to 2 hours ago.
3. Click Save.
The changes are saved and the EDI Session form is closed.
4. To manually extract the EDI session, double-click the EDI session in the Sessions view and click Extract.
To extract EDI for a vessel, such as a stowplan or load list EDI message type, see Outbound EDI tab.
Additional Mailboxes tab
Administration
EDI
EDI Configuration
EDI Configuration view
EDI Session form
Additional Mailboxes tab
The Additional Mailboxes tab displays the additional (secondary) mailboxes available for the selected outbound EDI
session. You can create additional mailboxes for an outbound EDI session to send a copy of an outbound message,
created by the EDI session, to other trading partners.
On this tab, you can add or delete additional mailboxes associated with an outbound EDI session.
Additional Mailbox form
Administration
Mailbox form
EDI
EDI Configuration
EDI Configuration view
EDI Session form
Additional Mailboxes tab
Additional
The Additional Mailbox form enables you to associate additional mailboxes with the selected outbound EDI session.
The additional mailboxes enable you to send copies of all the outbound messages generated by an EDI session to
other trading partners.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
198
Part 1: EDI
Using EDI UI Help
EDI Sessions view
To associate an additional mailbox with an EDI session:
1. From the Trading Partner drop-down list, select a trading partner.
2. From the Primary Mailbox drop-down list, select an EDI mailbox associated with the trading partner.
3. Click Save.
Settings tab
Administration
EDI
EDI Configuration
Administration
EDI
EDI Sessions
EDI Configuration view
EDI Sessions view
EDI Session form
EDI Session form
Settings tab
Settings tab
The Settings tab displays the EDI settings used for the selected EDI session. The EDI settings available for an EDI
session are determined by the EDI class of the message type and the direction of the EDI session.
EDI Setting form
Administration
EDI
EDI Configuration
EDI Configuration view
EDI Session form
Settings tab
EDI Setting form
The EDI Setting form enables you to add and edit EDI settings for the selected EDI session (on page 195). For an EDI
session, the available EDI settings are determined by the Message Class and the Direction specified in the EDI
Session form (on page 195). For more information on EDI message class, see EDI Message Type form (on page
209), EDI Message Type form (on page 879).
For the corresponding EDI batch to post quickly, you must add the ARGOEDI008
(EDI_POST_NUM_PARALLEL_JOBS) (on page 105) configuration setting (using the Administration >
Settings view) to each individual EDI BAPLIE session instead of setting it at the Global scope level. The
recommended default value as 4.
To add an EDI setting to an EDI session:
1. From the Setting drop-down list, select an EDI setting.
Additional fields are displayed based on the EDI setting selected in step 1.
2. Enter any additional information required for the EDI setting, such as the events to be extracted or the equipment
operator, or select true or false option buttons.
3. Click Save.
Filters tab
Administration
EDI
EDI Configuration
EDI Configuration view
EDI Session form
Filters tab
The Filters tab displays the EDI filters associated with the selected EDI session.
EDI Session Filter form
Administration
EDI
EDI Configuration
EDI Configuration view
EDI Session form
Filters tab
EDI Session Filter form
The EDI Session Filter form enables you to associate EDI filters with the selected EDI session. An EDI filter translates
data from one value to another when N4 extracts or before N4 posts an EDI message. For outbound EDI sessions an
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
199
Part 1: EDI
Using EDI UI Help
EDI Sessions view
EDI filter does not restrict the data included in an extracted EDI file, to restrict data you must define session criteria in
the EDI Session form (on page 195).
You can only associate EDI filters that exist at the current scope level. To create an EDI filter, see EDI Filter form (on
page 223), EDI Filter form (on page 906).
An EDI filter created to map an Interchange Sender for an inbound EDI session applies even if the filter is not
associated with the EDI session.
To add a filter to the selected session:
1. From the EDI Filter drop-down list, select an EDI session filter.
2. Click Save.
Session Criteria examples
The following lists some examples of session criteria for the EDI Session form (on page 195):
Example 1: An outbound ACTIVITY EDI session for gate activity for a line operator
For example, to include only units with a line operator of ABC and only deliver and receive container gate activity in an
extract, you can define the following session criteria for an outbound ACTIVITY EDI session:
Example 2: An outbound ACTIVITY EDI session for vessel activity for a line operator
For example, to include only vessel activity (container loads or discharges) in an extract for units that have any of the
following:
• ABC as the line operator
• ABC as the equipment operator
• ABC as the vessel operator, to include alliance partners on an inbound or outbound ABC vessel
You can define the following session criteria for an outbound ACTIVITY EDI session:
Example 3: An outbound STOWPLAN EDI session
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
200
Part 1: EDI
Using EDI UI Help
EDI Mailboxes view
For example, to include only units with a line operator of ABC or ANL in an extract, instead of all of the units on a
vessel, you can define the following session criteria for an outbound STOWPLAN EDI session:
Example 4: An outbound ACKNOWLEDGEMENT EDI session
For example, to send outbound APERAK EDI messages back to the associated EDI trading partner when N4
processes inbound BOOKING EDI transactions with ERRORS, you can define the following session criteria for an
outbound ACKNOWLEDGEMENT (on page 38), outbound ACKNOWLEDGEMENT (on page 187), outbound
ACKNOWLEDGEMENT (on page 837) EDI session using the APERAK EDI message type:
Example 5: An outbound INVENTORY EDI session
For example, to include only unit facility data located in the MAIN facility, you can define the following session criteria
for an outbound INVENTORY (on page 39), outbound INVENTORY (on page 188), outbound INVENTORY (on page
838) EDI session:
1.6.6 EDI Mailboxes view
Administration
EDI
EDI Mailboxes
EDI Mailboxes view
The EDI Mailboxes view displays the EDI mailboxes that exist at the current scope level. You can locate a certain
mailbox and edit the details or delete a mailbox from this view. You can also add an EDI mailbox from this view and
associate it with a trading partner so it becomes available in the EDI Configuration view (on page 205), EDI
Configuration view (on page 843).
In addition, you can use the Actions
Recover Obsolete option to recover deleted EDI mailboxes.
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).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
201
Part 1: EDI
Using EDI UI Help
EDI Mailboxes view
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
EDI Mailboxes Columns
Short Label
Long Label
In Filter?
Sorting?
Address
Address
X
X
Comm. Type
Communication Type
X
X
Complex
Complex
X
X
Directory
Directory
X
X
FTP Folder
FTP Folder
X
X
FTP UserId
FTP User Id
X
X
In/Out
In/Out
LifeCycleState
Life Cycle State
X
X
Mailbox Name
Mailbox Name
X
X
Partner Nm
Trading Partner Name
X
X
Receiver Id
Receiver Id
X
X
Receiver Qualifier
Receiver Qualifier
X
X
Sender Id
Sender ID
X
X
Sender Qualifier
Sender Qualifier
X
X
X
1.6.6.1 EDI Mailbox form
Administration
EDI
EDI Configuration
Administration
EDI
EDI Mailboxes
EDI Configuration view
EDI Mailboxes view
EDI Mailbox form
EDI Mailbox form
The EDI Mailbox form enables you to add and edit an EDI mailbox. Each EDI mailbox corresponds to a trading
partner/message type combination. You must add separate EDI mailboxes for inbound and outbound EDI messages
for each trading partner.
To add or edit an EDI mailbox:
1. In the Mailbox Name field, enter a mailbox name.
Use a short and clear name.
2. In the Trading Partner drop-down list, select the trading partner with whom an EDI message will be exchanged
using this mailbox.
If you open this form from the EDI Configuration view, then the Trading Partner drop-down list is not
available since you have already selected the trading partner in the EDI Configuration view.
3. From the Complex drop-down list, select the complex for which the EDI mailbox is set up.
If you are logged in at a complex or a lower scope level, you can add EDI mailboxes only for the current complex.
4. From the Direction drop-down list, select Send if this is a mailbox for an outbound message (meaning, N4 extracts
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
202
Part 1: EDI
Using EDI UI Help
EDI Mailboxes view
the data, maps it into an EDI message file, and sends it to the selected trading partner) or Receive if this is a
mailbox for an inbound message.
Once saved, you cannot edit the direction for an EDI mailbox.
5. In the Directory field, enter the absolute path of the folder where the EDI messages will be stored locally for your
site.
N4 automatically creates a folder on the local server using the absolute path entered in the Directory field.
You cannot set Directory to a root directory, such as C:/ in Windows.
6. From the Communication Type drop-down list, select a transfer method for the EDI messages sent to or received
by the terminal:
▪ FTP: The message file is transferred using the standard file transfer protocol. To use this method, you specify the
following additional information:
▪ FTP Address: IP address or host name of the FTP server used to transfer EDI files. Also, if you are using a
port other than the default (21) you would specify this at the end of the IP address, preceded by a colon ([IP
address]:[Port Number]
▪ For example, if the file path is 101.101.101.101/home/SPARCSN4/test/TST/IN, the IP address is
101.101.101.101. If you're using port 2001 instead of the default of 21, you would indicate the port as follows:
101.101.101.101:2001.
The port number specified in the FTP Address field must be configured on the FTP/SFTP server.
▪ The FTP server host name is preferred because the host name does not change while the IP address can
change.
The default port for the FTP communication type is 21.
▪ FTP User Id: User ID for the FTP server.
▪ FTP Password: Password for the FTP server. To confirm the FTP password, you must retype the same
password in the second field.
▪ FTP Folder: Absolute path of the folder on the FTP server where EDI message files are placed for
transmission. For example, if the full file path is 101.101.101.101/home/SPARCSN4/test/TST/IN, the absolute
path would be /home/SPARCSN4/test/TST/IN.
▪ Binary Mode: Un-select the Binary Mode check box if you do not want N4 to switch the FTP file transfer
mode from ASCII to binary. By default, the check box is selected for FTP. For all other communication types,
the check box is disabled.
▪ SFTP: The message file is transferred using the secure file transfer protocol. To use this method, you must
specify the same additional information, such as the IP address, port, user ID, password, and folder, as for FTP.
To use SFTP, both the terminal and the trading partner must support the technology.
The default port for the SFTP communication type is 22.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
203
Part 1: EDI
Using EDI UI Help
Trading Partners view
▪ Email: N4 transfers the message file as an email attachment. The email address used is specified in the Email
Address field.
If a scheduled EDI job runs but the mailbox is empty, N4 sends an email message stating that mailbox is
empty.
You can use a comma-separated list to specify multiple email addresses when configuring an EDI mailbox
with the direction Send.
When an EDI message file is sent as an attachment, it is moved to the archive folder on the local file server.
To transfer EDI by email, make sure you have configured the EDI configuration settings. See the EDI
Settings form in the N4 client: Administration EDI EDI Configuration EDI Configuration view
EDI Session form Settings tab EDI Setting form.
▪ SOAP: The message file is transferred using the simple object access protocol. For outgoing messages, N4
provides a Web Service for the EDI partner to dynamically request an outbound EDI extract. N4 returns the
results of the extract in response to the Web Service request.
N4 only supports processing of outbound vessel extract EDI via web services API using SOAP
communication type.
▪ NONE: The file communication is not controlled within N4.
Click Save.
1.6.7 Trading Partners view
Administration
EDI
Trading Partners
Trading Partners view
The Trading Partners view displays the EDI trading partners defined for your site. A trading partner is a business
entity with which you exchange EDI messages.
You can use the Trading Partners view to add, edit, or delete trading partners. In addition, you can use the Actions
menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted trading partner records.
• Purge (on page 208), Purge (on page 1215): Permanently delete trading partner records.
• Export SNX File (on page 1109): Export the selected trading partner records as an XML file using the snx.xsd
format.
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.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
204
Part 1: EDI
Using EDI UI Help
EDI Configuration view
2. Do one of the following:
▪ Click
to edit a selected record.
▪ Click
to delete the selected record(s).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
1.6.8 EDI Configuration view
Administration
EDI
EDI Configuration
EDI Configuration view
The EDI Configuration view displays the EDI configurations for the current scope level. You can add EDI trading
partners, mailboxes, sessions and job schedules from this view.
In addition, you can use the Actions menu to:
• Export SNX File (on page 1109): Export the selected entity as an XML file using the snx.xsd format.
If you do not select any entity in the left pane or if you select the complex before you select Actions Export SNX
File, N4 exports all the entities in one XML file.
If you select a node, such as a trading partner, and then select Actions Export SNX File, N4 exports only the
selected entity in the XML file.
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted EDI configurations.
The EDI configuration tree in the left pane of this view displays the EDI trading partners for each operator, and the
associated EDI mailboxes and EDI sessions for each trading partner. Also, the existing EDI job schedules are
displayed for each EDI session. Click the plus to the left of the folder you wish to view to expand the tree.
Each operator using EDI must have at least one EDI trading partner defined. For information on defining EDI trading
partners, see EDI Trading Partner form (on page 206), EDI Trading Partner form (on page 844).
Each EDI trading partner defined must have:
• At least one EDI mailbox defined. An EDI mailbox can be associated to one or more EDI sessions for the same
direction, such as an outbound mailbox associated to one or more outbound sessions. For more information on
defining EDI mailboxes, see EDI Mailbox form (on page 202), EDI Mailbox form (on page 876).
• At least one EDI session defined. An EDI session must be associated with one primary mailbox, and can also be
associated with additional mailboxes if necessary. For more information on defining an EDI session, see EDI
Session form (on page 195).
Optionally, each EDI session can have one or more EDI job schedules defined. For more information on defining EDI
jobs, see EDI Job form (on page 229), EDI Job form (on page 912).
In the EDI Configurations view, you must select a operator to add an EDI trading partner, select an EDI trading
partner to add an EDI mailbox or EDI session, and select an EDI session to add an EDI job schedule.
For more information on EDI processes, see Processes tab (on page 176), Processes tab (on page 826).
To add an entity below a selected hierarchy level:
1. In the left pane, select the hierarchy level below which you need to add an entity.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
205
Part 1: EDI
Using EDI UI Help
EDI Configuration view
2. Click Add.
The Add button displays the name of the entity that you can add at the selected level. For example, if you select an
operator, the Add EDI Trading Partner button is displayed.
If the Add... button is displayed, it indicates that you can add different types of entities at the same hierarchical level.
To display the list of entity types that you can add at the selected level, click the Add... button. For example, if you
select an EDI Trading Partner in the left pane, you can add an EDI mailbox, or an EDI session for the selected
trading partner.
To expand the hierarchy tree in the left pane and view the new entity, click the plus sign to the left of the
selected entity.
To edit or delete an entity:
1. In the left pane, select the entity that you want to edit or delete.
2. Click Edit to edit an entity, or - Delete to delete the entity.
If you delete an entity at a higher level, all the associated entities are also deleted. For example, if you delete an EDI
session, the associated EDI job schedules are also deleted.
1.6.8.1 EDI Trading Partner form
Administration
EDI
EDI Configuration
Administration
EDI
Trading Partners
Administration
EDI
Batches
EDI Configuration view
Trading Partners view
Batches view
Actions
EDI Trading Partner form
EDI Trading Partner form
Update EDI Trading Partner
EDI Trading Partner form
The EDI Trading Partner form enables you to add and edit an EDI trading partner and assign EDI mailboxes to it.
This form does not display when you login to N4 at a facility or yard scope level.
You must create at least one EDI trading partner and assign it at least one EDI mailbox to send or receive EDI
messages.
To add or edit an EDI trading partner:
1. In the Partner Name field, enter a name that uniquely identifies the trading partner.
2. From the Partner Business Unit drop-down list, select the master organization (business) for the trading partner.
3. From the Complex drop-down list, select the complex that defines the scope for the trading partner.
If you are logged in at a complex or a lower scope level, you can add trading partners only for the current complex.
4. Click Save.
You must save the EDI trading partner before you can assign an EDI mailbox to it.
To mark an EDI trading partner record as inactive, select the Retired check box in the EDI Trading Partner
form.
If you access the EDI Trading Partner form using the Administration EDI EDI Configuration view, the following
read-only fields are also displayed:
Field Label
Description
Created
The date and time the EDI trading partner record was created.
Creator
The ID of the user who created the EDI trading partner record.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
206
Part 1: EDI
Using EDI UI Help
Message Types view
Field Label
Description
Changed
The date and time the EDI trading partner record was last updated.
Changer
The ID of the user who last updated the EDI trading partner record.
1.6.9 Message Types view
Administration
EDI
Message Types
Message Types view
The Message Types view displays the EDI message types that exist at the current scope level. You can add, edit, and
delete EDI message types from this view.
In addition, you can use the Actions menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted message types.
• Purge (on page 208), Purge (on page 1215): Purge message types.
• Copy Reference Set (on page 1191): Copy message types from another entity set.
• Export SNX File (on page 1109): Export the selected message types as an XML file using the snx.xsd format.
To add the standard EDI message types and the associated EDI message maps, see Set-up Database
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).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
Message Types Columns
Short Label
Long Label
In Filter?
Sorting?
Agency
Responsible Agency
X
X
Changed
Changed
X
X
Changer
Changer
X
X
Class
Class
X
X
Created
Created
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
207
Part 1: EDI
Using EDI UI Help
Message Types view
Short Label
Long Label
In Filter?
Sorting?
Creator
Creator
X
X
Description
Description
X
X
Id
Id
X
X
Life Cycle
Life Cycle State
X
X
Release Number
Release Number
X
X
Standard
Standard
X
X
Version
Version
X
X
1.6.9.1 Purge
A list view with reference data
Actions
Purge
The Purge option enables you to purge reference data for the selected view. You can select the Actions Purge
option only if you have the RECOVER_OBSOLETE privilege. For more information, see Privileges view (on page
795).
We recommend that you assign the RECOVER_OBSOLETE privilege to users with an administrator role only.
For permanently purging user accounts in the Users view, there is a separate USER_PURGE privilege. To prevent a
user from accessing N4, you can make the user inactive by selecting No from the Active drop-down list in the User
form.
In the list views, if you use the
button, N4 will make the entities obsolete, but the Purge option will permanently
delete the selected entity or entities. The Recover Obsolete (on page 208), Recover Obsolete (on page 1177) option
recovers only obsolete entries that were deleted.
In the list view, display the Lifecycle column to identify the Active and Obsolete entities. For more information
on displaying a column in a list view, see Hiding and displaying columns (on page ).
To purge reference data:
1. In the list view, select the entity or entities you want to purge.
You can select active or obsolete entities.
2. From the Actions menu, select Purge.
If you select an entity that has any existing data dependencies in N4, an error occurs and N4 will not purge
the selected entity.
3. In the list view, click
to refresh the data and view the results of the purge.
If you purge a unit that is associated with a gate transaction, N4 detaches the unit from the gate transaction, deletes
the unit, and leaves the gate transaction in the current state.
1.6.9.2 Recover Obsolete or Inactive records
A list view with reference data
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Actions
Recover Obsolete
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
208
Part 1: EDI
Using EDI UI Help
Message Types view
In N4, entities, such as line operators, trucking companies, shippers and consignees, are considered as reference data
or reference entity. When you delete a record for a reference entity, N4 does not delete the record from the database.
Instead, it sets the Life Cycle State of the entity as Obsolete and makes the record inactive. N4 does not include an
Obsolete entity in any form or list for a user to select. In case, you want to use an obsolete (or inactive) entity again,
you can use the Actions Recover Obsolete option in the list view for the entity to make the record active again. N4
does not display the obsolete entities in a list view, by default. To display the obsolete and active entities in a list view,
select the Display Show All option.
Prerequisites
• The Recover Obsolete privilege
In the list view, display the Lifecycle column to identify the Active and Obsolete entities. For more information
on displaying a column in a list view, see Hiding and displaying columns (on page ).
To recover an obsolete entity:
1. In the list view, select the obsolete entity that you want to recover.
2. Select Actions
3. Click
Recover Obsolete.
to refresh the data displayed in the list view.
You can use the Actions Purge (on page 208), Purge (on page 1215) option in a reference entity list view
to delete a record permanently.
1.6.9.3 EDI Message Type form
Administration
EDI
Message Types
Message Types view
EDI Message Type form
The EDI Message Type form enables you to add and edit EDI message types. The EDI message type defines the type
of information such as activity or booking data, the standard for which the information is organized, such as X.12 or
EDIFACT, and the version of the EDI standard for messages transferred to or from your EDI partner.
You can add the supported EDI message types, or you can define your own. For each new message type you define,
you must specify the EDI message map (on page 216), EDI message map (on page 901) used. The EDI message map
specifies the mapping file and data dictionary file used.
In addition, you can export the schema files from the EDI Message Types form to use as a reference when
customizing an EDI message map for the selected EDI message type.
To add or update all of the supported EDI message types and respective standard EDI message maps, see
Set-up Database view.
To export the schema files:
1. Click Export XSD File.
N4 displays the Export XSD File button for existing message types only. For a new EDI message type, you
must add the message type before you can export the schema files.
2. In the Export XSD File dialog box, select the location for the schema files and click Open.
When successful, N4 exports the baseMapping.xsd file and the appropriate schema file for the EDI class of the
selected EDI message type, such as the activity.xsd file for an ACTIVITY EDI message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
209
Part 1: EDI
Using EDI UI Help
Message Types view
To add or edit an EDI message type:
1. In the Id field, enter a message type ID.
For supported EDI message types, the ID must match the ID in the list of Supported message types (on
page 23), Supported message types (on page 211).
2. Optionally, in the Description field, enter a description of the EDI message type.
3. From the Class drop-down list, select an EDI message class for the message type.
An EDI class specifies the type of information that will be conveyed in the EDI message.
If you are using EDI to perform scheduled SNX imports, select the SNX class.
4. From the Standard drop-down list, select a standard that specifies the set of EDI message definitions for the
message type:
▪ X.12: Specifies the message types in the ST segment as three digit transaction type identifiers.
▪ EDIFACT: Specifies the message types in the UNH segment (the standard starting segment).
▪ Navis standard XML: Transmits the EDI messages as an XML file based on the Navis standard schema.
This standard does not need a mapping file.
▪ FLATFILE: Transmits the EDI messages as files with fixed field positions and no delimiters.
EDI message types with the FLATFILE standard use a flat text dictionary file instead of an XML data
dictionary file. For more information, see EDI Message Map form (on page 217), EDI Message Map form
(on page 902).
▪ Misc. standard or proprietary: Other EDI standards defined by institutes, such as ACOS (Australian Chamber of
Shipping).
If you are using a custom mapping file to read proprietary XML files, select Misc. standard or proprietary.
5. In the Version field, enter the version of the EDI message type.
For ANSI 301 version C2/9, enter C2.
N4 validates the value in the Version field against the UNH 0052 data element in the EDI file. Consequently,
what appears in the 0052 UNH segment must match what is specified for the EDI message type for all
associated EDI messages. For example, you enter D in the Version field, the EDI file must include "D" in the
0052 data segment after the message ID as follows: UNH+32454295-001+COPARN:D:95B:ITG13. If these
version values do not match, N4 displays an error. In earlier versions of N4, the version number was driven
off of the 0057 data element, but this is no longer the case.
You must enter a value in this field, even for Navis standard XML or proprietary XML from a customer.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
210
Part 1: EDI
Using EDI UI Help
Message Types view
6. In the Release Number field, enter a release number for the message type. The release number is a secondary
version issued by the agency responsible for maintaining the EDI standard.
The version and the release number are a part of the EDI message envelope (UNH for EDIFACT):
▪ For an inbound EDI message, the version and release number in the message envelope must match the values
specified in the EDI Message Type form.
▪ For an outbound EDI message, N4 automatically inserts the values specified in the EDI Message Type form into
the message envelope.
For ANSI 301 version C2/9, enter /9.
For a complete list of version and release numbers supported by Navis, see Supported message types (on
page 23), Supported message types (on page 211). If you require a version or release number that is not
supported, see EDI Message Map form (on page 217), EDI Message Map form (on page 902) for more
information on editing EDI message maps.
You must enter a value in this field, even for Navis standard XML or proprietary XML from a customer.
7. From the Responsible Agency drop-down list, select the agency responsible for maintaining the EDI standard.
8. Click Save.
You must save the EDI message type before you can specify the EDI message maps for the EDI message type.
If you add a supported EDI message, N4 automatically adds the respective standard EDI message map.
Supported Message Types
The following table lists the version and release numbers of message types supported by the standard set of mapping
files and data dictionary files provided by Navis:
ID
Description
Class
Standard
Version
Release
Number
Responsible
Agency
301
Inbound 301
message
BOOKING
X.12
00
4020
American
National
Standards
Institute
309
Inbound 309
message
MANIFEST
X.12
00
4020
American
National
Standards
Institute
310
Inbound 310
message
MANIFEST
X.12
00
4020
American
National
Standards
Institute
322
Outbound 322
message
ACTIVITY
X.12
00
4010
American
National
Standards
Institute
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
211
Part 1: EDI
ID
Using EDI UI Help
Message Types view
Description
Class
Standard
Version
Release
Number
Responsible
Agency
322
Outbound 322
message
ACTIVITY
X.12
00
4020
American
National
Standards
Institute
323
Outbound 323
message
VESSELACTIVITY
X.12
00
4020
American
National
Standards
Institute
323
Outbound 323
message
VESSELACTIVITY BY
CARRIER
X.12
00
4020
American
National
Standards
Institute
417
Inbound 417
message
RAILWAYBILL
X.12
00
4020
American
National
Standards
Institute
418
Inbound 418
message
RAILCONSIST
X.12
00
4010
American
National
Standards
Institute
418
Outbound 418
message
RAILCONSIST
X.12
00
4010
American
National
Standards
Institute
418
Inbound 418
message
RAILCONSIST
X.12
00
4020
American
National
Standards
Institute
418
Outbound 418
message
RAILCONSIST
X.12
00
4020
American
National
Standards
Institute
APERAK
Outbound
APERAK
message
ACKNOWLEDGEMENT
EDIFACT
D
96B
United Nations
APERAK
Inbound
APERAK
message
ACKNOWLEDGEMENT
EDIFACT
D
96B
United Nations
BAPLIE
BAPLIE
message
version 1.5
STOWPLAN
EDIFACT
1.5
95B
United Nations
BAPLIE
BAPLIE
message
version 1.5
STOWPLAN
EDIFACT
1.5
91.1
United Nations
BAPLIE
BAPLIE
message
version 2.0
STOWPLAN
EDIFACT
2.0
95B
United Nations
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
212
Part 1: EDI
ID
Using EDI UI Help
Message Types view
Description
Class
Standard
Version
Release
Number
Responsible
Agency
BAPLIE
BAPLIE
message
version 2.2
STOWPLAN
EDIFACT
2.2
95B
United Nations
COARRI
Outbound
COARRI
message
ACTIVITY
EDIFACT
D
95B
United Nations
COARRI
Outbound
COARRI
message
version 1.6
ACTIVITY
EDIFACT
D
95B
United Nations
CODECO
Inbound
CODECO
message
ACTIVITY
EDIFACT
D
00A
United Nations
CODECO
Inbound
CODECO
message
version 1.6
ACTIVITY
EDIFACT
D
95B
United Nations
COHAOR
Inbound
COHAOR
message
INVENTORY UPDATES
EDIFACT
D
04B
United Nations
COPARN
Inbound
COPARN
message
BOOKING
EDIFACT
D
00B
United Nations
COPARN
Inbound
COPARN
message
BOOKING
EDIFACT
D
95B
United Nations
COPINO
Inbound
COPINO
message
APPOINTMENT
EDIFACT
D
95A
United Nations
COPINO
Inbound
COPINO
message
PREADVISE
EDIFACT
D
95B
United Nations
COPRAR
Inbound
COPRAR
message
LOADLIST
EDIFACT
D
95B
United Nations
COPRAR
Inbound
COPRAR
message
DISCHLIST
EDIFACT
D
95A
United Nations
COPRAR
Inbound
COPRAR
message
DISCHLIST
EDIFACT
D
00B
United Nations
CUSCAR
Inbound
CUSCAR
message
MANIFEST
EDIFACT
D
95B
United Nations
CUSRES
Inbound
CUSRES
message
RELEASE
EDIFACT
D
96B
United Nations
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
213
Part 1: EDI
ID
Using EDI UI Help
Message Types view
Description
Class
Standard
Version
Release
Number
Responsible
Agency
IFTSAI
Inbound IFTSAI
message
VESSEL SCHEDULE
EDIFACT
D
00B
United Nations
IFTMBC
Inbound
IFTMBC
message
BOOKING
EDIFACT
D
94B
United Nations
IFTMBC
Inbound
IFTMBC
message
BOOKING
EDIFACT
D
98B
United Nations
IFTMCS
Inbound
IFTMCS
message
BOOKING
EDIFACT
D
95B
United Nations
LOADLIST
Inbound
LOADLIST
message
LOADLIST
Misc.
standard or
proprietary
A
A
Nonstandard
LOADLIST
Outbound
LOADLIST
message
LOADLIST
Misc.
standard or
proprietary
A
A
Nonstandard
SAUDILDP
Inbound
SAUDILDP
message
SAUDILDP
Proprietary
Saudi Load
Permit
Order
30
--
Nonstandard
SAUDIMNFT Inbound
SAUDIMNFT
message
SAUDIMANIFEST
Proprietary
Saudi
Manifest
30
--
Nonstandard
TPFREP
Outbound
TPFREP
message
version 3.0
PERFORMANCE
EDIFACT
30
00B
United Nations
VERMAS
Inbound
VERMAS
message
VERMAS
EDIFACT
D
16A
United Nations
VERMAS
Outbound
VERMAS
message
VERMAS
EDIFACT
D
16A
United Nations
In addition N4 supports the ACTIVITY (inbound), LOADLIST (outbound COPRAR), and RELEASE (COREOR)
message types along with XML posting for HAZARD, RAILORDER, SNX, INVENTORY, INVOICE, and
RELEASE (350 ANSI) message types. However, standard mapping files are not provided for these messages.
CUSCAR (Customs Cargo Report) EDI Message
In N4, you can use EDI messages to create and maintain cargo data, including Bill of Lading (BL), BL Item, and Cargo
Lots, using Bills of Lading, Manifests, and other electronic documents.
N4 supports the EDIFACT standard CUSCAR message, release D, and version 95B. It supports the original message
function as per the CUSCAR D 95B message standard.
A CUSCAR EDI message enables you to transfer data from a carrier to a Customs administration to meet Customs
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
214
Part 1: EDI
Using EDI UI Help
Message Types view
cargo reporting requirements. CUSCAR EDI contains all the Equipment Details (EQD segment) followed by the
Consignment Details (CNI segment). This message does not contain any information about the location of the
equipment on the vessel. It assumes that the location information is available through BAPLIE.
In the CUSCAR message, all the Equipment details come before any Consignment details. The CNI segment contains
the actual BL number. The GID segment contains information about the BL Item and the Item Number. A CNI segment
can have multiple GID segments. An SGP segment with the GID segment specifies the placement of the goods with
respect to the container.
You can configure both inbound and outbound messages so that you can record and retrieve cargo data from N4.
In addition, N4 provides generic EDI message maps to support cargo business practices for bulk, break-bulk, and other
services. You can use these message maps as starting points and modify them to meet your specific requirements.
You must use the Administration DBA Set-up Database view
to get the built-in maps for the CUSCAR EDI message.
Set-up EDI Message Types and Maps button
COREOR Replace message
When you post an COREOR EDI message with the message function (9) with some order items, N4 creates the import
delivery order (IDO). Then, if you post an COREOR Replace message with message function (5) without any order
items, N4 detaches the already attached order items from the IDO and logs the event UNIT_CANCEL_RESERVE in
the Batches (on page 172), Batches (on page 823). However, if the unit is already departed or currently being delivered
(ECOUT status) against the IDO, then N4 displays an error message.
EDI Message Class
The following table lists the EDI message classes, schema, message types, and mapping files supported by N4:
EDI Message Class
XML Schema
EDI Message Type
Mapping File
ACKNOWLEDGEMENT
acknowledgement.xsd APERAK
aperak_10_96B.mgt
aperakout_10_96B.mgt
ACTIVITY
activity.xsd
322
COARRI
CODECO
ansi322_00_4010.mgt
ansi322_00_4020.mgt
ansi322_Inbound.mgt
coarri_D_95B.mgt
codeco_D_95B.mgt
codeco_in_D_95B.mgt
ACTIVITY BY CARRIER
activity.xsd
COARRI
coarri_D_95B.mgt
APPOINTMENT
appointment.xsd
COPINO
copino_D_95A.mgt
BOOKING
booking.xsd
301
COPARN
IFTMBC
IFTMCS
ansi301_00_4020.mgt
coparn_D_00B.mgt
coparn_D_95B.mgt
iftmbc_D_95B.mgt
iftmcs_D_95B.mgt
DISCHLIST
dischlist.xsd
COPRAR
copar(discharge)_D_95A.mgt
dischargelist.mgt
HAZARD
hazard.xsd
DGMNFT.XML
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
215
Part 1: EDI
Using EDI UI Help
Message Types view
EDI Message Class
XML Schema
EDI Message Type
Mapping File
INVOICE
invoice.xsd
Navis XML standard
LOADLIST
loadlist.xsd
COPRAR
coprar(load)_D_95B.mgt
coprar_D_95B.mgt
loadlist.mgt
MANIFEST
manifest.xsd
309
310
CUSCAR
ansi309_00_4020.mgt
ansi310_00_4020.mgt
cuscar_D_95B.mgt
PERFORMANCE
performance.xsd
TPFREP
tpfrep_30_00B.mgt
PREADVISE
preadvise.xsd
322
COPINO
322_preadvise.mgt
copinodropoff_D_95B.mgt
RAILCONSIST
railconsist.xsd
418
ansi418_00_4010.mgt
ansi418out_00_4010.mgt
ansi418_00_4020.mgt
ansi418out_00_4020.mgt
RAILORDER
railorder.xsd
Navis XML Standard
RAILWAYBILL
railwaybill.xsd
204
417
ansi417_00_4020.mgt
RELEASE
release.xsd
CUSRES
COREOR
350
cusres_D_96B.mgt
SNX
snx.xsd
Navis XML standard
STOWPLAN
stowplan.xsd
BAPLIE
VERMAS
vermas.xsd
VERMAS D 16A
VESSELACTIVITY
vesselschedule.xsd
323
ansi323_00_4020.mgt
VESSELACTIVITY BY CARRIER vesselschedule.xsd
323
ansi323_00_4020.mgt
baplie_15_95B.mgt
baplieout_15_95B.mgt
baplie_20_95B.mgt
baplieout_20_95B.mgt
baplie_15_911.mgt
baplieout_15_911.mgt
Message Map tab
Administration
EDI
Message Types
Message Types view
EDI Message Type form
Message Map tab
The Message Map tab displays the EDI message maps used for the selected EDI message type. An EDI message
map is a mapping file created using the GoXML mapping utility licensed from Xenos. This file controls the mapping
process of data between the EDI message and N4.
For inbound EDI, the mapping file determines where the data from the EDI message is posted in N4.
For outbound EDI, the mapping file determines where the data extracted from N4 is written in the EDI message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
216
Part 1: EDI
Using EDI UI Help
Message Types view
The following diagram displays the function of the mapping file for both inbound and outbound EDI:
A mapping file matches the segments in an EDI Interchange with corresponding fields in the database.
The mapping file references a data dictionary file, which defines the structure of the EDI message. N4 provides a
standard set of mapping files and data dictionary files that you can customize as necessary using the GoXML mapping
utility. For information about using the GoXML mapping utility from Xenos, see the documentation that comes with the
product, or go to http://www.xenos.com/.
To add or update all of the supported EDI message types and respective standard EDI message maps, see
Set-up Database view.
If an EDI message map references a Navis standard mapping file and data dictionary file, a bullet displays in the BuiltIn column on the Message Map tab.
You can add, edit, or delete an EDI message map on this tab.
If you are editing an EDI message map, you can export the schema files for the selected EDI message type to
use as a reference. For more information, see EDI Message Map form (on page 217), EDI Message Map form
(on page 902).
To add an EDI message map:
• Click
.
To edit an EDI message map:
• Select an EDI message map in the list view and click
.
If you select a standard or built-in EDI message map, N4 does not display the Save button in the EDI
Message Map form.
To delete an EDI message map:
• Select an EDI message map in the list view and click
.
If the functionality is not available or you do not have the associated privileges, the
are grayed out.
,
, or
buttons
EDI Message Map form
Administration
EDI
Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Message Types view
EDI Message Type form
Message Map tab
EDI Message Map form
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
217
Part 1: EDI
Using EDI UI Help
Message Types view
The EDI Message Map form enables you to add and edit an EDI message map and link a mapping file and data
dictionary file with it. The EDI message map controls data transformation between the EDI file and N4 during the
mapping process. For more information on EDI processes, see Processes tab (on page 176), Processes tab (on
page 826).
N4 provides a standard set of mapping files and data dictionary files that you can customize for individual clients using
the GoXML mapping utility licensed from Navis.
You can edit a mapping file to receive and send data for unit flex fields in an EDI message. The following schema files
support flex fields:
• stowplan.xsd
• booking.xsd
• activity.xsd
• preadvise.xsd
• release.xsd
• vermas.xsd
• snx.xsd
To export the schema files, see EDI Message Type form (on page 209), EDI Message Type form (on page 879).
To add or update all of the supported EDI message types and respective standard EDI message maps, see
Set-up Database view.
To add an EDI message map:
1. In the Map Id field, enter a name that uniquely identifies the EDI message map.
You can create multiple maps for an EDI message as trading partners may use different implementations of the EDI
message.
2. From the Direction list, select the direction of the EDI message.
3. To import the data dictionary file that defines the EDI message structure, click Import DIC.
4. In the Import XML Configuration dialog box, select the data dictionary file and click Open.
XML data dictionary files have the extension .dic and flat text dictionary files have the extension .fxd.
The EDI Message Map Dictionary File field displays --loaded-- in the text box to indicate that a data dictionary file
is linked with the EDI message map.
5. To import the mapping file that defines the EDI map, click Import MGT.
6. In the Import XML Configuration dialog box, select the mapping file and click Open.
Mapping files have the extension .mgt.
The EDI Message Map File field displays --loaded-- in the text box to indicate that a mapping file is linked with the
EDI message map.
7. Optionally, in the Description field, enter a description of the map.
8. Click Save.
To remove a loaded file, click Clear.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
218
Part 1: EDI
Using EDI UI Help
Message Types view
To edit a custom EDI message map:
1. To export a custom or standard data dictionary file, click Export DIC.
2. In the Export XML Configuration dialog box, specify a name for the data dictionary file and click Save.
To save an XML data dictionary file, you must enter a name and the extension (.dic).
To save a flat text dictionary file for a FLATFILE EDI message, you must enter a name and the extension (.fxd).
3. To export a custom or standard mapping file, click Export MGT.
4. In the Export XML Configuration dialog box, specify a name for the mapping file and click Save.
To save a mapping file, you must enter a name and the extension (.mgt).
5. Edit and save the mapping file and data dictionary file as needed using the GoXML mapping utility.
You cannot import an edited mapping file or data dictionary file for a standard or built-in EDI message map.
6. If you edited the data dictionary file, to import your edited data dictionary file, click Import DIC.
If you do not import an edited data dictionary file, N4 uses the standard data dictionary file for the selected EDI
message type, if available.
7. In the Import XML Configuration dialog box, select the edited data dictionary file and click Open.
8. To import the edited mapping file, click Import MGT.
9. In the Import XML Configuration dialog box, select the edited mapping file and click Open.
10. Click Save.
If you select a standard or built-in EDI message map, N4 does not display the Save button.
To remap an EDI interchange:
1. Make the necessary changes to correct the processing errors in the EDI mapping file.
For more information, see EDI Message Map (on page 217), EDI Message Map (on page 902).
2. Click Remap.
3. Click Repost.
If the Auto Post option is selected for the EDI session, the EDI interchange is automatically posted after you
edit a segment and Remap the EDI interchange.
Dynamic flex fields in EDI Message Map
By default, N4 supports built-in flex fields for all the entities. These built-in flex fields can be added to the variforms.
When the required built-in fields are not sufficient, you can add the DFFs to various entities in N4 like flex fields. The
EDI post interceptor and EDI extract interceptor supports the custom code extension in posting and extracting of DFFs.
You can extract the data in DFFs of an entity into an outbound EDI message and post the data to the DFF of an entity
through an EDI inbound message. N4 EDI functionality supports the following DFFs through the custom code
extensions EdiPostInterceptor and EdiExtractInterceptor that has an existing EDI schema:
• shipperAgent
• ediNextFacility
• ediHazard
• ediEquipment
• carrierService
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
219
Part 1: EDI
Using EDI UI Help
Message Types view
• consignee
• ediBlItemPieceDetail
• ediTrainVisit
• Damage
• shippingLine
• saudiContainer
• ediTruckVisit
• ediTruck
• truckingCompany
• saudiBillOfLading
• ediVesselVisit
• ediDriver
• railroad
• eqoOrderPurpose
• shipper
• ediRailCarVisit
• reeferRqmnts
• ediOwner
• ediAgent
• ediRailCar
• port
• EdiOperator
• truckingCompanyLine
• ediFacility
• ediRouting
• ediBooking
• ediImportDeliveryOrder
• ediCargoLot
• bookingAgent
• ediBillOfLading
• ediContainer
• ediBlItem
• Document
• ediCommodity
• ediChassis
• ediAttachedEquipment
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
220
Part 1: EDI
Using EDI UI Help
Message Types view
Release Map tab
Administration
EDI
Message Types
Message Types view
EDI Message Type form
Release Map tab
The Release Map tab is displayed in the EDI Message Type form (on page 209), EDI Message Type form (on page
879) only if the EDI class for the selected EDI message type is Release.
The Release Map tab displays the release maps associated with the selected EDI message type. A release map
associates an EDI release map code, received from a trading partner such as the customs department, with a hold/
permission. It also indicates if a hold is added/released or a permission is required/granted.
You can add, edit, or delete release maps on this tab.
EDI Release Map form
Administration
EDI
Message Types
Message Types view
EDI Message Type form
Release Map tab
EDI Release Map form
The EDI Release Map form enables you to add and edit release maps for the selected EDI message type. A release
map associates an EDI release map code, received from a trading partner such as the customs department, with a
hold/permission. It also indicates if the intention of the EDI message is to hold or release a container.
You can add a release map only if the EDI class for the selected EDI message type is Release.
When you post an EDI release message that does not have a configured release map, N4 finds an Active
Export Unit instead of creating a new Advised Export UFV. When an existing Export unit exists with the
UnitFacilityVisit Transit State beyond Inbound (that is EcIn, Yard, EcOut, or Loaded), then N4 creates a new
Advised Export unit in the same facility if both of the following are true: the preadvise through an EDI booking
message or the UI is for a different visit and the outbound visit is not generic.
To add or edit a release map:
1. From the Hold/Permission drop-down list select the hold/permission for which you want to create the release map.
2. In the Map Code field, enter the EDI release map code received from the trading partner for the selected hold/
permission.
3. The Apply a Hold check box is selected by default, indicating that the container is on hold. If the intention of the EDI
message is to release the container, you must clear the Apply a Hold check box.
If you are posting a COREOR RELEASE message with message function D to cancel a permission, you
must uncheck the Apply a Hold check box to ensure that N4 cancels the permission.
4. The Negative Indicator check box option is used to make the quantity negative.
5. The Match Unit By option is used to identify which visit of the container the EDI message is for. Usually, the
message contains a vessel and a voyage and the release is specific to that visit of the container. In some cases, the
vessel and/or the voyage are not present in the message, or they are there for some other purpose and cannot be
used to identify the container. From the Match Unit By drop-down list, select one of the following options to identify
the unit(s), the hold/permission applies to:
▪ Id Only - Simple match by unit id and inbound mode: The release is applicable for the specified unit ID and
inbound mode, for example, an import or a transship arriving on any vessel.
▪ Id+Visit - Match by unit id and vessel/voyage: The release is applicable only for the specified unit ID, vessel
visit, and voyage.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
221
Part 1: EDI
Using EDI UI Help
Message Types view
▪ Id+Outbound Visit - Match by unit id and Outbound vessel/voyage: The release is applicable for the specified
unit ID, inbound/outbound vessel visit, and voyage.
6. The Guardian option for import release is independent of the vessel visit. For export containers, the release may
only provide permission to load the cargo to a specific vessel visit and voyage or any voyage of a vessel. From the
Guardian drop-down list, select the one of the following options:
▪ None - Independent of vessel/visit: The release is independent of the vessel visit.
▪ Visit - Release by visit, match on vessel + voyage: The release is applicable to the vessel visit and voyage
specified in the message.
▪ Visit* - Release by visit, match on vessel only: The release is applicable to the current vessel visit irrespective
of the voyage.
▪ Carrier - Release by vessel: The release is applicable to the current or any future visit of the vessel.
7. The Match Quantity option is used to denote the basis by which the quantity needs to be compared for a BL
release. The computation for the BL hold or release quantity is either dependent on the reference number or the
manifested quantity. That is, N4 matches the quantity by either the reference ID received in the EDI message or the
quantity available in the bill of lading to calculate the quantity for a BL hold or release.
From the Match Quantity drop-down list, select one of the following options to specify the criteria by which N4
should match the quantity:
▪ Match Quantity By Reference - Matches quantity by reference Id received in the EDI message.
▪ Match Quantity By Manifest - Matches quantity by manifested quantity available in the bill of lading.
8. The Dependent Codes list box is enabled when you select Match Quantity By Reference from the Match
Quantity list. The Excluded list contains all disposition codes that are configured for the message type. You can
include or exclude the dependent disposition codes with the arrow buttons provided.
The Dependent Codes list box and the Negative Indicator check box work as follows:
▪ For Hold messages:
- If one or more disposition codes are included, then N4 considers the reference number match. For example, if
you configure 4A and post it with the reference number, N4 checks if a prior record, such as 1B, 1C or 4C, exists
with the 4A reference number match. If a match exists, then N4 adds or subtracts the quantity based on the
selection of the Negative Indicator and applies a hold. Otherwise , N4 marks the release as information message
and does not apply a hold.
- If you do not include any disposition codes in the list box, then N4 assumes that the reference number match
checking is not required and applies the hold without checking any reference number.
▪ For Release messages:
- If one or more disposition codes are included, then N4 considers the reference number match. If Match
Quantity of the release map is Match Quantity By Reference, then N4 checks if the BL release exists for the
given reference number and matches with the release map flag type and map code as in the dependent codes. If
a match exists, then N4 creates the BL release with the given quantity and release map's quantity type. If a match
does not exists, then N4 creates the BL release with the given quantity and release map type as NULL.
9. The Modify Quantity option is used to indicate the type of quantity that needs to be modified as a result of the
calculation of hold or release quantities.
From the Modify Quantity drop-down list, select one of the following options:
▪ Entered Quantity: Adds to or subtracts from the quantity that is on hold.
▪ Released Quantity: Adds to or subtracts from the quantity released by the US customs.
▪ Information Only: Records the message with quantity but does not use the value to compute the entered or
released quantity for the Bill of Lading.
10. Click Save.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
222
Part 1: EDI
Using EDI UI Help
Filters view
1.6.10 Filters view
Administration
EDI
Filters
Filters view
The Filters view displays the EDI session filters that exist at the current scope level. You can add, edit and delete EDI
filters from this view.
In addition, you can use the Actions menu to:
• Export SNX File (on page 1109): Export the selected filters as an XML file using the snx.xsd format.
• Copy Reference Set (on page 1191): Copy filters from another entity set.
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).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
Filters Columns
Short Label
Long Label
In Filter?
Sorting?
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
In/Out
Direction
X
X
Name
Filter Name
X
X
1.6.10.1 EDI Filter form
Administration
EDI
Filters
Filters view
EDI Filter form
The EDI Filter form enables you to add and edit an EDI filter. An EDI filter maps a field value in an inbound or
outbound EDI message to a field value you specify. The filter can be used to:
• Translate field values between the facility and its EDI trading partners in order to maintain consistency.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
223
Part 1: EDI
Using EDI UI Help
Filters view
• Convert values in an EDI interchange to the values used by the facility or trading partner, such as a port ID or
container operator code.
• Correct erroneous values, such as an incorrect ISO code.
For outbound EDI sessions an EDI filter does not restrict the data included in an extracted EDI file, to restrict
data you must define filter criteria in the EDI Session form (on page 195).
To add or edit an EDI filter:
1. In the Filter Name field, enter a name that uniquely identifies the EDI filter.
2. From the Direction drop-down list, select one of the following values:
▪ Send: Create an EDI filter for outbound EDI sessions
▪ Receive: Create an EDI filter for inbound EDI sessions.
3. Click Save.
You must save an EDI filter before you can add filter entries that map field values in inbound and outbound EDI
messages.
Filter Entry tab
Administration
EDI
Filters
Filters view
EDI Filter form
Filter Entry tab
The Filter Entry tab displays the fields associated with the selected EDI filter and their corresponding values.
EDI Filter Entry form
Administration
EDI
Filters
Filters view
EDI Filter form
Filter Entry tab
EDI Filter Entry form
The EDI Filter Entry form enables you to create and edit field mappings for an EDI filter. An EDI filter can consist of
any number of individual field mappings. You need to create separate EDI filters for inbound and outbound EDI
sessions, see EDI Filter form (on page 223), EDI Filter form (on page 906).
An EDI filter enables you to maintain consistency, convert values in an EDI interchange to the values used by the
facility or trading partner, and correct erroneous values. For example, the standard code for Kaohsiung, Taiwan is
"TWKHH", but one line operator always sends and expects to receive "TWKHA" in the BAPLIE messages. Create two
EDI filters, one for the inbound EDI session and one for the outbound EDI session to make the conversion in all EDI
interchanges with the line operator.
You cannot duplicate the To Value for an EDI filter created for an Interchange Sender.
To create a filter entry:
1. From the Field Id drop-down list, select a field for mapping.
For example, select Port ID to create a filter that corrects the port ID specified in an EDI interchange.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
224
Part 1: EDI
Using EDI UI Help
EDI Load form
2. In the From Value field, enter the field value to be changed.
For example, for an inbound EDI filter, enter TWKHA to specify the non-standard port ID to be changed.
3. In the To Value field, enter the new field value.
For example, for an inbound EDI filter, enter TWKHH to specify the standard port ID.
Either the From Value or To Value must be filled in or there will be an error.
4. Click Save.
For an outbound EDI filter, you convert the standard port ID "TWKHH" to the non-standard port ID "TWKHA".
1.6.11 EDI Load form
Operations
Vessel
Administration
EDI
EDI Load
EDI Load
EDI Load form
EDI Load form
Prerequisites
• To access this form, you need to assign the EDI - Upload privilege to your user role.
• You have to set the setting ARGORAILCONSIST002 (RC_EQUIP_CATEGORY) to True to accept the category
from the inbound message.
The EDI Load form enables you to manually load an EDI message file. For example, if you receive a BAPLIE on a disk
or as an email, you can use the EDI Load form to manually load that file.
Navis supports custom delimiters in EDI messages.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
225
Part 1: EDI
Using EDI UI Help
EDI Load form
When you post a EDI COPRAR Load list file, N4 sets the flag ufvVerifiedForLoad to True for all containers included in
the message and automatically selects the Is Verified For Load check box in the Sparcs Details form. If there is any
load list discrepancy record, N4 sets the flag ufvVerifiedForLoad to False.
To see how manually loading an EDI message file fits into the rail process flow, see the Full Rail Operations and Lite
Rail Operations process flows.
Prerequisites
• You must set the setting ARGORAILCONSIST002 (RC_EQUIP_CATEGORY) to True to accept the category from
the inbound message.
To load an EDI message file:
1. From the EDI Session drop-down list, select an inbound EDI session.
The EDI Session drop-down list contains only the EDI sessions defined under the EDI Configuration. Each entry in
the drop-down list displays the EDI Session name followed by the EDI message type ID in parentheses.
2. Click Browse, to locate the file on your computer or network.
3. In the EDI Load dialog box, select the EDI message file. The complete path and the name of the selected file is
displayed in the EDI File field.
4. Optionally, select the Post Immediate check box, to post the EDI file immediately.
5. If you do not select the check box, the file is posted when the selected EDI session is posted. If the Auto Post
option is selected for the EDI session, the file is posted automatically. For more information, see EDI Session form
(on page 195).
6. Optionally, select the Additions Only check box and post a STOWPLAN message so that N4 checks for the new
containers and adds only the new containers, if any, and ignores the other containers. The Additions Only option
works only when you post a STOWPLAN message manually and does not work for EDI Jobs. Also, this option is not
applicable when setting ARGOEDI012 (EDI_STOWPLAN_REPLACE_CONTAINERS) (on page 107) is set to true.
For example, if you select the option Additions Only and post a stowplan manually for the containers C1, C2, C3,
and C4, in which C3 and C4 are already available, then N4 adds the new containers C1 and C2 and ignores
containers C3 and C4, which are already available.
7. Optionally, select the check box Positions Only and post a STOWPLAN message so that N4 creates and updates
the positions only for the new containers in the message. For already existing containers, N4 checks if there are any
changes in the positions, and updates only the change in position for the existing containers. N4 records the event
UNIT_POSITION_CORRECTION when the position update occurs. The Positions Only option works only when
you post a STOWPLAN message manually and does not work for EDI Jobs. Also, this option is not applicable when
setting ARGOEDI012 (on page 107) is set to true.
For example, if you select the Positions Only option and post a stowplan message manually for the containers C1,
C2, C3, and C4, in which C3 and C4 are already available, then N4 executes the following:
▪ Creates C1 and C2 and updates the positions only.
▪ Checks for the positions only for C3 and C4 and updates the positions alone and skips if any other updates are
present.
8. Optionally, select the Discharge Only check box and post the STOWPLAN message, so that N4 posts only the
import and transshipment containers that must be discharged at the current port. The Discharge Only option works
only for manual stowplan and does not work for EDI Jobs.
How this works: If you select Discharge Only check box and post a stowplan message, with category 'THRGH' for
import containers, N4 completes the batch with a warning message stating that the batch is skipped. However, if the
Discharge only check box is not selected, then N4 completes the batch by creating new units for the 'THRGH'
import containers.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
226
Part 1: EDI
Using EDI UI Help
EDI Jobs view
9. Click Load.
Notes
• Use Discharge Only check box option with caution, since the outbound Stowplan will be extracted with only Export
and Transshipment containers that will be loaded in the current port. Through containers will not be sent in the
Stowplan message.
1.6.12 EDI Jobs view
Administration
EDI
EDI Jobs
EDI Jobs view
The EDI Jobs view displays the EDI jobs that exist at the current scope level. You can use an EDI job to define a
schedule for N4 to execute a specified EDI session at timed intervals.
For example, you can use a scheduled EDI job to have N4 execute an outbound ACTIVITY EDI session for ABC line
operator at the end of each day and send the EDI message to the EDI mailbox specified in the EDI session. We
recommend launching EDI Jobs from the complex scope level.
You must set up at least one EDI session to schedule an EDI job. For more information on EDI sessions, see EDI
Sessions form (on page 195).
You can add, edit, and delete EDI jobs from this view.
In addition, you can use the following Actions menu options to:
• Schedule Job: Schedule an EDI job or jobs
Once scheduled, N4 displays the EDI job in the Background Jobs view (on page 929) and executes the EDI job at
the specified times.
If an EDI job is scheduled, a bullet displays in the Is Scheduled column.
• Unschedule Job: Unschedule a scheduled EDI job or jobs
Once unscheduled, N4 removes the EDI job from the Background Jobs view and will no longer execute the EDI
job until you schedule it again or use the Execute Now (once) option.
You can also use the Actions Halt Job option in the Background Jobs view to unschedule an EDI job.
For example, if an EDI job is running when you unschedule it in the EDI Jobs view, the EDI Scheduler will
continue processing the EDI job until it is complete unless you halt the EDI job in the Background Jobs
view.
Execute Now (once): Execute a specific EDI job on demand. You cannot execute jobs that are already running per a
schedule.If you do not select an EDI job in the list view, the above options are disabled and cannot be selected.
To add an EDI job:
• Click
.
To edit an EDI job:
• Select an EDI job in the list view and click
.
If you select a scheduled EDI job for editing, N4 prompts you to select one of the following options:
▪ Yes: To unschedule the EDI job and open the EDI Job form to edit the EDI job.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
227
Part 1: EDI
Using EDI UI Help
EDI Jobs view
▪ No: To leave the EDI job scheduled, and open the EDI Job form in a view-only mode.
If you select No, the entire EDI Job form displays in the view-only mode except the Execution Logs tab (on page
933). You can view and delete execution logs on this tab.
To delete an EDI job:
• Select an EDI job in the list view and click
.
If the functionality is not available or you do not have the associated privileges, the
grayed out.
,
, or
buttons are
EDI Jobs Columns
Short Label
Long Label
In Filter?
Sorting?
Cluster Mode
Runs in Cluster Mode
X
X
Complex
Complex
X
X
Defined Occurrence
Occurrence in the Month
X
Description
Description
X
X
Email Subject
Email Message Subject
X
X
End Date
End Date
X
X
Error Email
Error Recipient Email
X
X
Expression
Cron Expression
X
X
Frequency
Frequency
X
X
Hours
Execution Hour(s)
X
X
Id
Id
X
X
Interval Days
Repeat Interval Days
X
X
Interval Hours
Repeat Interval Hours
X
X
Interval Mins
Repeat Interval Mins
X
X
Job Class Name
Job Class Name
X
X
Last Day
Last Day of Month
X
X
Last Occurrence
Last Occurrence in the Month
X
X
Mailbox Name
Mailbox
X
X
Mins
Execution Minute(s)
X
X
Node
Execution Node
X
X
On Workday
Closest Workday
X
X
Recipient Email
Success Recipient Email
X
X
Repeats
Repeat Count
X
X
Reprocess
Reprocess Count
X
X
Scheduled
Is Scheduled
X
Session Name
Session
X
X
Start Date
Start Date
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
228
Part 1: EDI
Using EDI UI Help
EDI Jobs view
1.6.12.1 EDI Job form
The EDI Job form enables you to add an EDI job definition that specifies a schedule to run EDI sessions at specified
time intervals.
For example, you can use a scheduled EDI job to have N4 execute an outbound ACTIVITY EDI session for ABC line
operator at the end of each day and send the EDI message to the EDI mailbox specified in the EDI session.
To add or edit an EDI job:
1. In the General area, in the Id field, enter a unique ID for the EDI job.
2. Optionally, in the Description field, enter a short description for the EDI job.
3. From the Job Execution Group drop-down list, select the Job Group that must be used to execute the EDI job. It's
a best practice to have a Job Group with only one node that is dedicated to EDI jobs. See Job Groups view for more
information. This is a required field. For information about deleting a job group, see How to remove a Job Group (on
page 247).
4. In the Job Target area, optionally, from the Partner Name drop-down list, select the EDI trading partner.
5. From the Job Class Name drop-down list, select a job class:
▪ InboundSession
▪ OutboundSession
▪ CommunicationSession (send only without any other processing)
▪ ReprocessSession (retry the selected inbound session if posting failed)
6. If you selected InboundSession or OutboundSession in the Job Class Name drop-down list, select an EDI session
from the Session drop-down list.
▪ The options you see in the Session drop-down list depend on the job class and the EDI trading partner, if any.
▪ The Session drop-down list does not display outbound sessions that are based on the carrier visit since it is not
possible to provide carrier information when you set up an EDI job. Therefore, you cannot schedule an EDI job to
extract EDI based on carrier information (vessel or rail visit). Examples of carrier based EDI include Stowplan,
LoadList, DischargeList, etc.
7. If you selected CommunicationSession in Job Class Name drop-down list, select an EDI mailbox from the Mailbox
drop-down list.
8. If you selected ReprocessSession in the Job Class Name drop-down list, select an inbound EDI session from the
Session drop-down list.
9. From the Complex drop-down list, select the complex for the EDI job.
If you are logged in at the complex or a lower scope level, you can only set up EDI jobs for the current complex.
10. On the Scheduling tab (on page 230), Scheduling tab (on page 913), Scheduling tab (on page 939), define a
schedule to execute the EDI job. If you do not enter a scheduled time, by default the job will execute every minute.
Do not use the Scheduling tab for ReprocessSession jobs.
11. Optionally, on the Notification tab (on page 235), Notification tab (on page 918), Notification tab (on page 944),
specify the e-mail address of the recipients that want to receive notification from N4 when an EDI job succeeds or
fails. For example, you can specify your e-mail address if you want to receive an e-mail when an EDI job fails to
process.
▪ For outbound EDI sessions, N4 sends the EDI message to the Primary Mailbox and any Additional Mailboxes
specified in the EDI Session form (on page 195).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
229
Part 1: EDI
Using EDI UI Help
EDI Jobs view
12. If you selected ReprocessSession in the Job Class Name drop-down list, enter the number of times N4 should
attempt to process the EDI job.
▪ You cannot reprocess a session more than five times.
13. Click Save.
When you add an EDI job, N4 will not schedule it automatically. In the EDI Jobs view, you must select the Actions
Schedule option to schedule the EDI job.
Each time N4 executes an EDI job, N4 adds a record to the Execution Logs tab (on page 933). The three states of
execution of a reporting job are: In Progress, Succeeded, and Failed.
Scheduling tab
Administration
System
Administration
EDI
Reporting Jobs
EDI Jobs
Reporting Jobs view
EDI Jobs view
EDI Job form
Reporting Job form
Scheduling tab
Scheduling tab
The Scheduling tab enables you to set up a schedule for the selected job. After you set up a schedule on the
Scheduling tab, you must select the Actions Schedule Job option in the respective view to schedule the job.
To set up a schedule for a job:
1. From the Frequency drop-down list, select one of the following options:
▪ On Demand: To execute the job only when a user selects the Actions
Execute Now (once) option.
This indicates that no schedule is set up for the job and a user will have to manually select the Actions
Execute Now (once) option to execute the job each time.
▪ Daily (on page 65), Daily (on page 231), Daily (on page 914), Daily (on page 940), Daily (on page 955): To
execute the job daily at a specified time or repeat after specified time intervals.
For example, you can set this frequency if you want to generate a report at 10:00 pm everyday or if you want to
generate a report everyday at an interval of five hours.
▪ By Day of Week (on page 67), By Day of Week (on page 232), By Day of Week (on page 915), By Day of
Week (on page 941), By Day of Week (on page 957): To execute the job only on specific weekdays. If you select
this frequency, you can still specify the time and the repeat interval for executing the job on the specified
weekdays.
For example, you can set this frequency if you want to generate a report every Monday and Wednesday at 10:00
pm.
▪ By Day of Month (on page 68), By Day of Month (on page 234), By Day of Month (on page 917), By Day of
Month (on page 943), By Day of Month (on page 958): To execute the job only on specific days of a month. If
you select this frequency, you can still specify the time and the repeat interval for executing the job on the
specified day of the month.
For example, you can set this frequency if you want to generate a report on the 1st and 15th of every month at
10:00 pm.
▪ Cron Expression (on page 69), Cron Expression (on page 235), Cron Expression (on page 918), Cron
Expression (on page 944), Cron Expression (on page 959): To use a cron expression to define the schedule to
execute the job.
The other frequencies, Daily, By Weekday, and By Day of Month, internally create a cron expression that
displays in the Expression column in the Reporting Jobs view or EDI Jobs view.
2. Specify the time and/or repeat interval information for the selected frequency option.
Click Save to save the changes and close the form.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
230
Part 1: EDI
Using EDI UI Help
EDI Jobs view
To include a entity, you can do any of the following:
• Double-click the entity in the Excluded field.
• Select the entities in the Excluded field and click
.
Press and hold the Shift key to select adjoining entities and the Ctrl key to select non-adjoining entities.
• Use your mouse to drag and drop the entity from the Excluded field to the Included field.
Click
to include all entities.
To exclude a entity, you can do any of the following:
• Double-click the entity in the Included field.
• Select the entities in the Included field and click
.
• Use your mouse to drag and drop the entity from the Included field to the Excluded field.
Click
to exclude all entities.
If you want to edit a scheduled EDI Job, you should first unschedule or halt the EDI job. For more information, see EDI
Jobs view (on page 227), EDI Jobs view (on page 910) or Background Jobs view (on page 929).
Daily
The following table lists the date and time fields available if you select the Daily option from the Frequency drop-down
list:
Field
Label
Description
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute according
to the schedule that you set up until you manually unschedule the job using the
Actions Unschedule option.
Execution
Hour(s)
Enter the hour(s) of the day that you want the job to execute.
The valid hour values are from 0 to 23, with 0 representing 12:00 midnight.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
For example:
• 0: The job will execute at midnight.
• 0,10,20: The job will execute at midnight, 10 A.M., and 8 P.M.
• 10-20: The job will execute every hour starting 10 A.M and ending 8 P.M.
• 5,10,15-20: The job will execute at 5 A.M., at 10 A.M, and then every hour
starting 3 P.M. and ending 8 P.M.
If you do not enter a value in this field, the job will execute every hour of the day at the
minutes defined in the Execution Minute(s) fields.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
231
Part 1: EDI
Using EDI UI Help
EDI Jobs view
Field
Label
Execution
Minute(s)
Description
Enter the minute(s) of the hour that you want the job to execute.
The valid minute values are from 0 to 59.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
The time of execution of a job is calculated by combining the values entered in the
Execution Hour(s) and Execution Minute(s) fields.
For example:
• 0: The job will execute at the hour specified in the Execution Hour(s) field.
• 0,10,20: The job will execute at the hour, and then at 10 minutes past, and 20
minutes past the hour specified in the Execution Hour(s) field.
• 10-20: The job will execute every minute starting 10 minutes past the hour and
ending 20 minutes past the hour specified in the Execution Hour(s) field.
• 5,10,15-20: The job will execute at 5 minutes past, 10 minutes past, and then
every minute starting 15 minutes past and ending at 20 minutes past the hour
specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute every minute of the hour(s)
specified in the Execution Hour(s) field.
Repeat
Interval
Hours
Repeat
Interval
Mins
Enter the number of hours after which the job execution must be repeated.
The valid range of values is 1 to 23.
For example, if you enter 2, the job execution will be repeated every two hours
starting at the hour specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
Enter the number of minutes after which the job execution must be repeated.
The valid range of values is 0 to 59.
The number of minutes can be combined with the number of hours to specify the
repeat interval.
For example:
• If you enter 20 in the Repeat Interval Mins field, the job execution will be repeated
every twenty minutes.
• If you enter 2 in the Repeat Interval Hours field and 20 in the Repeat Interval
Mins field, the job execution will be repeated every two hours at 0, 20, and 40
minutes (assuming that the value in the Execution Minute(s) field is 0).
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
By Day of Week
The following table lists the date and time fields available if you select the Day of Week option from the Frequency
drop-down list:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
232
Part 1: EDI
Using EDI UI Help
EDI Jobs view
Field Label
Description
Day of Week
Include the days of the week you want the job to execute. For more information, see
the steps below to include or exclude an entity.
For example, if you include Monday and Thursday, the job is executed on Monday
and Thursday of the week at the time specified.
Occurrence
in the Month
Select the occurrence of the selected weekday(s) in a month.
For example, if you want to execute the job every third Monday of the month, select
Third from the Occurrence in the Month drop-down list and include Monday in
the Day of Week field.
Last
Occurrence
in the Month
Select the check box to execute the job on the last occurrence of the day in the
month.
For example, if you want to execute the job on the last Monday of every month,
select the check box and include Monday in the Weekday field.
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute
according to the schedule that you set up until you manually unschedule the job
using the Actions Unschedule option.
Execution
Hour(s)
Enter the hour(s) of the day that you want the job to execute.
The valid hour values are from 0 to 23, with 0 representing 12:00 midnight.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
For example:
• 0: The job will execute at midnight.
• 0,10,20: The job will execute at midnight, 10 A.M., and 8 P.M.
• 10-20: The job will execute every hour starting 10 A.M and ending 8 P.M.
• 5,10,15-20: The job will execute at 5 A.M., at 10 A.M, and then every hour
starting 3 P.M. and ending 8 P.M.
If you do not enter a value in this field, the job will execute every hour of the day at
the minutes defined in the Execution Minute(s) fields.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
233
Part 1: EDI
Using EDI UI Help
EDI Jobs view
Field Label
Execution
Minute(s)
Description
Enter the minute(s) of the hour that you want the job to execute.
The valid minute values are from 0 to 59.
You can enter multiple values separated by comma and also enter ranges using a
hyphen (-).
The time of execution of a job is calculated by combining the values entered in the
Execution Hour(s) and Execution Minute(s) fields.
For example:
• 0: The job will execute at the hour specified in the Execution Hour(s) field.
• 0,10,20: The job will execute at the hour, and then at 10 minutes past, and 20
minutes past the hour specified in the Execution Hour(s) field.
• 10-20: The job will execute every minute starting 10 minutes past the hour and
ending 20 minutes past the hour specified in the Execution Hour(s) field.
• 5,10,15-20: The job will execute at 5 minutes past, 10 minutes past, and then
every minute starting 15 minutes past and ending at 20 minutes past the hour
specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute every minute of the
hour(s) specified in the Execution Hour(s) field.
Repeat
Interval
Hours
Repeat
Interval Mins
Enter the number of hours after which the job execution must be repeated.
The valid range of values is 1 to 23.
For example, if you enter 2, the job execution will be repeated every two hours
starting at the hour specified in the Execution Hour(s) field.
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
Enter the number of minutes after which the job execution must be repeated.
The valid range of values is 0 to 59.
The number of minutes can be combined with the number of hours to specify the
repeat interval.
For example:
• If you enter 20 in the Repeat Interval Mins field, the job execution will be
repeated every twenty minutes.
• If you enter 2 in the Repeat Interval Hours field and 20 in the Repeat Interval
Mins field, the job execution will be repeated every two hours at 0, 20, and 40
minutes (assuming that the value in the Execution Minute(s) field is 0).
If you do not enter a value in this field, the job will execute only at the hour and
minute(s) specified in the Execution Hour(s) and Execution Minute(s) fields.
By Day of Month
The following table lists the date and time fields available if you select the By Day of Month option from the
Frequency drop-down list:
Field Label
Day of
Month
Description
Include the days of a month you want the job to execute. For more information, see
the steps below to include or exclude an entity.
For example, if you include 1, 15, and 30, the job is executed on the selected days
of the month at the time specified.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
234
Part 1: EDI
Using EDI UI Help
EDI Jobs view
Field Label
Description
Last Day of
Month
Select the check box if you want to execute the job at the last day of the month.
Closest
Workday
Select the check box if you want to execute the job on the closest workday if the
selected day(s) of the month falls on a weekend.
For example, if you include 15 in the Day of Month field and select the check box,
the job will execute:
• On Friday the 14th, if 15th is a Saturday, and
• On Monday the 16th, if 15th is a Sunday.
Repeat
Interval
Days
Enter the number of days after which the job execution must be repeated.
The valid range of values is 1 to 30.
For example, if you enter 2, the job execution will be repeated every two days.
If you do not enter a value in this field, the job will execute only on the day(s)
selected in the Day of Month field.
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the first
possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute according
to the schedule that you set up until you manually unschedule the job using the
Actions Unschedule option.
Cron Expression
The following table lists the date and time fields available if you select the Cron Expression option from the
Frequency drop-down list.
Field Label
Description
Start Date
Enter the date you want the job to execute for the first time.
If you do not enter a date, the current date is assumed as the start date.
If you enter a date older than the current date, N4 starts executing the job at the
first possible time depending on the time schedule.
End Date
Enter the date you want the job to stop executing.
If you do not enter a date, once scheduled, the job will continue to execute
according to the schedule that you set up until you manually unschedule the job
using the Actions Unschedule option.
Cron
Expression
Enter the UNIX cron expression to define a schedule for the job. For more
information on cron expressions, go to a website such as http://
wiki.opensymphony.com/display/QRTZ1/CronTriggers+Tutorial.
Notification tab
Administration
System
Administration
EDI
Reporting Jobs
EDI Jobs
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Reporting Jobs view
EDI Jobs view
EDI Job form
Reporting Job form
Notification tab
Notification tab
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
235
Part 1: EDI
Using EDI UI Help
EDI Jobs view
The Notification tab enables you to specify the email address of the recipients for the reporting job outputs. You can
specify the recipient for successful execution of a report as well as a recipient for a failure message.
Optionally, on the Notification tab, you can specify the email address of the recipients that want to receive notification
from N4 when an EDI job succeeds or fails. For example, you can specify your email address if you want to receive an
email when an EDI job fails to process.
For an EDI job that executes an outbound EDI session, N4 sends the EDI message to the Primary Mailbox and any
Additional Mailboxes specified in the EDI Session form (on page 195).
To set up the email notification for a job:
1. Optionally, in the Email Message Subject field, enter text to be displayed as the subject of the email notification
sent to the recipient.
For example, you can specify the name of the report being sent as the subject of the email.
2. Optionally, in the Success Recipient Email field, enter the email address to be used if the job runs successfully.
To add multiple recipients, specify multiple email addresses separated by a semi-colon (;).
N4 requires a success recipient email address for a reporting job.
3. Optionally, in the Success Message Prefix field, enter any text you want to appear as part of the body of the email
message.
If you do not enter any text in this field, only the default template for the email message will be used.
4. Optionally, in the Error Recipient Email field, enter the email address to be used if the job is not completed
successfully.
To add multiple recipients, specify multiple email addresses separated by a semi-colon (;).
5. Optionally, in the Error Message Prefix field, enter any text you want to appear as part of the body of the email
message if the job is not completed successfully.
6. Click Save to save the changes and close the form.
Reprocess tab
Administration
EDI
EDI Jobs
EDI Jobs view
EDI Job form
Reprocess tab
The Reprocess tab enables you to control the re-run of an inbound or an outbound EDI job that has failed. You can
reprocess an EDI job the number of times you specify in the Reprocess Max (1-N) field. Based on the count specified,
N4 automatically reprocesses the job.
This tab appears in the form only if you select either the OutboundSession or the ReprocessSession as the Job Class
Name.
Reprocessing an inbound EDI Job:
When you specify a reprocess count for an inbound EDI job, N4 processes the failed batch the specified number of
times and posts the failed transactions again. The Reprocess Count column in the Batches view (on page 172),
Batches view (on page 823) indicates the number of times an inbound session has been processed and posted. When
the job succeeds, N4 creates a new batch record with the COMPLETE status.
To reprocess an inbound EDI job:
1. Enter the details in the EDI Job form.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
236
Part 1: EDI
Using EDI UI Help
EDI Errors view
2. In the Job Class Name field, select ReprocessSession.
3. From the Session drop-down list, select the inbound session that you need to reprocess.
4. Click on the Reprocess tab.
5. In the Reprocess Max field, enter a number.
Reprocessing an outbound EDI job:
When specifying the reprocess count for an outbound EDI job, N4 runs the session extract based on the batch status.
That is, if the last batch run was successful, as indicated by either WARNINGS or COMPLETE in the EDI Batch
Inspector (on page 175), EDI Batch Inspector (on page 825), the recount process remains at zero until the first
incidence of extract failure. The batch recount starts only when the batch fails to extract as indicated by the ERRORS
status.
For instance, when an outbound EDI job fails the first time, N4 increments the batch reprocess count to 1 and creates a
batch record with ERRORS status. On a subsequent job execution, if the extract process fails again, N4 increments the
batch reprocess count to 2 and creates another batch record with ERRORS status. This process continues until either
the success of the extract or the completion of the reprocess count specified in the EDI Job form, whichever is earlier.
If after fixing the batch errors and extracting the session, the job succeeds, then N4 creates a new batch record with
the COMPLETE status and increments the batch reprocess count to 3.
When you reprocess the failed jobs from the Reprocess tab, after reaching the maximum count, N4 displays the job
status with the warning message 'EDI job reprocess reached the maximum count {0}'. And the EDI session status
appears as "Warning".
To reprocess an outbound EDI job:
1. Enter the details in the EDI Job form.
2. In the Job Class Name field, select OutboundSession.
3. From the Session drop-down list, select the outbound session that you need to reprocess.
4. From the Complex drop-down list, select the complex for the EDI job.
5. Click on the Reprocess tab.
6. In the Reprocess Max field, enter a number.
1.6.13 EDI Errors view
Administration
EDI
EDI Errors
EDI Errors view
The EDI Errors view displays EDI error types that exist at the current scope level for an EDI batch. Each row in this
view represents a type of EDI error that occurred for one or more EDI transactions in an EDI batch.
For example, if an EDI batch has ten EDI transactions with errors, but only three different types of EDI errors occurred,
then the EDI Errors view displays three rows, one for each EDI error type in the EDI batch. Use this view to locate EDI
errors by the error type, making the process of fixing and reposting EDI errors easier and more efficient.
When you create the transactions and post the batch with errors, N4 displays only the error or warning records
pertaining to the current posting and updates the previous posting errors to ‘Obsolete’ status, and the new errors to
‘Active’ status and displays only the ‘Active’ errors in the EDI Errors view. When you repost a batch after fixing a few
errors using EDI Errors view, N4 displays only the ‘Active’ errors in the EDI Errors view. Also, when you repost a
batch after fixing all the errors using EDI Errors view, N4 does not display any records in the EDI Errors view. You can
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
237
Part 1: EDI
Using EDI UI Help
EDI Errors view
select the Actions Repost option to repost the EDI transaction(s) associated with the selected EDI error type(s).
You must have the EDI_POST privilege to access the Actions Repost option.
If you select more than one EDI error type, N4 determines which EDI batches are included and which transactions to
repost. The EDI Errors view displays the number of EDI transactions associated with each EDI error type in the
Transactions column.
Use the is (=) condition instead of the matches (==) condition when filtering for the message key. The is (=) condition is
not case sensitive.
Some N4 versions include both the Message Params column and the Message Text column until the latter is
deprecated. If both columns display, use the Message Params column for sorting. The Message Text column
is not sortable.
EDI Errors Columns
Short Label
Long Label
Filter?
Sorting?
Batch Number
Batch Number
X
X
Created
Created
X
X
Key
Key
X
X
Message Params
Message Parameter
X
X
Parameters
Parameters
X
X
Process
Process
X
X
Session Class
Session Class
X
X
Session In/Out
Session In/Out
X
X
Session Name
Session Name
X
X
Session Partner Nm
Session Partner Name
X
X
Severity
Severity
X
X
Transactions
Transactions
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
238
1.7 Troubleshooting EDI
EDI processing requires you to perform troubleshooting on an ongoing basis to ensure that N4 processes EDI
efficiently and correctly. For assistance in dealing with EDI errors in the EDI Errors view, see Correcting common EDI
errors (on page 160).
This section covers troubleshooting for potential problems when processing EDI in N4 that do not result in an EDI error
in the EDI Errors view.
If you need help configuring or processing EDI in N4, see Configuring EDI (on page 40) or Using EDI (on page 147).
For more information on ANSI EDI standards, go to www.ansi.org. For EDIFACT EDI standards, go to
www.unece.org/trade/untdid/welcome.htm.
Listed below are some of the common problems that can occur when processing EDI.
EDI issues are varied and arise from many different factors. This information in this topic provides guidelines for next
steps when you encounter an EDI failure, but actual solutions will vary depending on your system configuration,
business processes, and whether custom work is required.
General EDI Issues
This table lists common EDI issues and the most likely underlying causes
Issue
Possible Root Cause
For more information
Scheduled EDI job
doesn't run
Make sure the Execution Minutes for the EDI
job is set properly so that there's a space
between EDI sessions.
Cannot post a
message by session
Make sure the job is scheduled (on page 64)
Defining a schedule for an EDI job (on
and that the trading partner is synched between page 64)
the session, mailbox, and job.
Create an EDI session
N4 is unable to read
EDI file, stops at
mapping stage with
no errors
If N4 is stuck at the mapping stage without any
errors, one of the EDI filters may be missing a
value.
In the Entry Filter tab of the EDI Filter
form (on page 223), EDI Filter form (on
page 906), make sure that the From
Value and To Value fields contain a value.
Delete any EDI filter entries that are
missing a value and then try posting the
EDI file again
EDI extraction issue
Possible mapping issue. You may need
customization help from Navis Technical
Services.
Check EDI configuration.
Creating and importing a message map
(on page 45)
Configure a message map
Editing an EDI message map (on page
157)
Creating EDI Session (on page 16)
EDI Posting slowness Check if there is a node issue. Restart may
help.
EDI doesn't execute
Check your network.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Defining a schedule for an EDI job (on
page 64)
Node Problems
Infrastructure Problems
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
239
Part 1: EDI
EDI Posting Error
Can't resolve the EDI
message from the
XML document
Troubleshooting EDI
EDI Errors view
Possible mapping issue. You may need
customization help from Navis Technical
Services.
Check EDI Configuration
Creating and importing a message map
(on page 45)
Configure a message map
Editing an EDI message map (on page
157)
Creating EDI Session (on page 16)
No Posting Error
Check to make sure the various EDI validation
settings are set properly.
If there is no setting to enable a posting error,
customization may be required.
EDI doesn't post error - EDI validation
settings
Field not populated
Possible mapping issue. You may need
customization help from Navis Technical
Services.
Creating and importing a message map
(on page 45)
Configure a message map
Editing an EDI message map (on page
157)
Segment not
Possible mapping issue. You may need
processed correctly
customization help from Navis Technical
Services.
Data not parsed
correctly
Wrong data passed in
EDI message
Creating and importing a message map
(on page 45)
Configure a message map
Editing an EDI message map (on page
157)
Missing Segments
after generating
Outbound EDI
Prior to 3.4.4, segments got generated even if
Message Type standard was defined as XML.
This was fixed so that now customers have to
define the standard as FLAT FILE for N4 to
generate and save the segments
Message looping
incorrectly
Possible mapping issue. You may need
customization help from Navis Technical
Services.
EDI file failed to
upload
File may be too large. Need to limit EDI upload
to 1 mg.
Creating and importing a message map
(on page 45)
Configure a message map
Editing an EDI message map (on page
157)
EDI not sent or
May need to rebuild indexes
containers not sent in
EDI message
Detect fragmentation
Error when data
exceeds the
maximum for a
particular field.
Map the element to a unit flex field.
Configure a flex field in N4 (on page 1066)
AN EDI batch as an
UNKNOWN status
An EDI batch has an UNKNOWN status when An EDI batch has an UNKNOWN status
either you or N4:
(on page 243)
Load an inbound EDI file but N4 has not posted
the EDI batch.
Post an inbound EDI batch that fails without
errors.
Extract an outbound EDI batch that fails with no
errors.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
240
Part 1: EDI
Troubleshooting EDI
EDI Errors view
Trading partner did
not receive an
outbound EDI file
If your trading partner did not receive an
Your trading partner did not receive an
outbound EDI file, and there are no errors
outbound EDI file (on page 245)
displayed in N4 for the selected EDI batch, then
either the communication setup is incorrect or
N4 cannot access the FTP folder.
Specific EDI Errors
Issue
Error: Container ID
"XXXX" may have
wrong check digit
Possible Root Cause
Set ARGODOUBLEBLIND003
(CHECK_DIGIT_CORRECTION) as false.
More Information
ARGODOUBLEBLIND003
Error "BL Nbr XXX ARGOEDI008 may be set to high. Try setting to 1.
already exists for
the Line XXX" when
importing EDI
discharge list
Unable to Create
Needed to set ARGORAILCONSIST005 at global
ADVISED Rail Units level.
using the EDI 322
INBOUND
PREADVISE:
ARGORAILCONSIST005
(RC_USE_DEFAULT_RAILCAR_TYPE) (on
page 145), ARGORAILCONSIST005
(RC_USE_DEFAULT_RAILCAR_TYPE) (on
page 874)
System exception
The wrong EDI node was specified for the job.
occurred:
class=class
java.io.IOException,
message=The
system cannot find
the path specified
See Job Groups form
COREOR didn't
release a container
for a particular line
Equipment pools weren't set up properly.
Set up and manage work pools (for ECN4)
Unit POL is not the
same as BL POL
CGOCargoValidation002 and
CGOCargoValidation003 changed to be
Value='False' and Scope='Global'.
CGOCargoValidation002
(MATCH_BL_UNIT_POD)
Unavailable port
location error
CGOCargoValidation002 and
CGOCargoValidation003 from 'true' to 'false'
resolved the issue.
CGOCargoValidation002
(MATCH_BL_UNIT_POD)
CGOCargoValidation003
(MATCH_BL_UNIT_POL)
EDI322 Pre-Advise
Transaction fails if
booking does not
previously exist
By enabling the Booking Ad Hoc option on the
Line Operator Booking Rules tab, a booking is
created for any preadvise EDI that is processed
for a booking that does not already exist in the
system.
Booking Rules tab
Erroneous retired
rail units created
Set
ARGOPREADVISE006
ARGOPREADVISE006=ACTIVE_AND_ADVISED (CANCEL_PREADVISE_NOT_RETIRE_UNIT)
(on page 112)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
CGOCargoValidation003
(MATCH_BL_UNIT_POL)
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
241
Part 1: EDI
Troubleshooting EDI
EDI Errors view
An outbound
N4 does not create an EDI batch if there are no
ACTIVITY EDI batch events in N4 to extract for the selected EDI
does not exist in N4 session.
An outbound ACTIVITY EDI batch does not
exist in N4
N4 only posts
import and
transshipment
containers
If you select Discharge Only check box from the N4 only posts import and transshipment
EDI Load form (on page 225) and post a
containers (on page 246)
stowplan message, then N4 posts only the import
and transshipment containers that must be
discharged at the current port.
EDI RELEASE
message doesn’t
release a container
from a different line
You are trying to modify the equipment's owner or
line operator through EDI. N4 is validating the
equipment owner and not letting you release a
container.
Check ARGORELEASE001
(RLS_VALIDATE_LINE_OPERATOR) (on page
146), ARGORELEASE001
(RLS_VALIDATE_LINE_OPERATOR) (on page
875).
If ARGORELEASE001 is set to ‘False’ and you
are still seeing the error ‘Equipment {xxxxx}
owned by ‘xxxxx’ cannot be used by ‘xxxxx’’,
check the value of INVSECURITY002
(SECURITY_ENFORCE_EQ_STATE_MODIFY).
N4 displays the above error message
irrespective of whether you are using
the Gate forms, EDI, or Web Service
APIs to modify the equipment's owner
or line operator.
An inbound EDI batch does not exist in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
An EDI batch has an UNKNOWN status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transshipment records are being retired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPARN updates IB and OB Carrier of THROUGH Containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPRAR DISCHARGE EDI does not create units if the vessel is departed. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Your trading partner did not receive an outbound EDI file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error "BL Nbr XXX already exists for the Line XXX" when importing EDI discharge list. . . . . . . . . . . . . . . . . . . .
Upload multiple transactions in one EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
N4 is unable to read EDI file, stops at mapping stage with no errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
N4 only posts import and transshipment containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to remove a job group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Missing Segments after generating Outbound EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User can edit the EDI session in the EDI Sessions form without the EDI_MANAGEMENT privilege. . . . . . . . . .
COPARN Replace message - Incorrect final booking quantity and units associated with different booking items
Warning message is displayed on extracting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Missing Segments after generating Outbound EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Second UFV created after posting the Loadlist/Dischlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Posting rules for O/B Carrier not considered for Stowplan EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
N4 purge job takes six seconds to locate the unit record to be deleted. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
N4 does not evaluate the posting rules to apply or ignore carrier details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DischargeList EDI with different POD updates category from Import to Transshipment. . . . . . . . . . . . . . . . . . . .
Bento server displays 'Job has multiple triggers' error message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI batch is sent with error status although the EDI file is sent and archived correctly. . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
243
243
244
244
245
245
246
246
246
246
247
247
247
247
247
248
248
248
249
249
249
249
250
242
Part 1: EDI
Troubleshooting EDI
An inbound EDI batch does not exist in N4
1.7.1 An inbound EDI batch does not exist in N4
This problem can occur if the EDI file does not follow the EDI standard.
To resolve errors caused from loading an improperly formatted EDI file:
1. In the apex.log file, search for any errors related to loading the EDI file.
For hosted customers, contact Navis Support.
2. Correct any EDI errors found.
If an error occurred for a missing or incorrect delimiter, review the delimiter specified in the EDI Session form (on
page 195) to make sure it matches the delimiter in the EDI file.
3. In the EDI Load form (on page 225), load the EDI file again.
If you were not able to resolve your problem, contact your regional Navis Support office.
1.7.2 An EDI batch has an UNKNOWN status
An EDI batch has an UNKNOWN status when either you or N4:
• Load an inbound EDI file but N4 has not posted the EDI batch.
• Post an inbound EDI batch that fails without errors.
• Extract an outbound EDI batch that fails with no errors.
To post an inbound EDI batch:
1. In the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825), on the Processes tab, review the
processes.
2. If the post process does not exist, then you must post the EDI batch.
3. To post an EDI batch, use the EDI Batch Inspector
Actions
Post option.
For a STOWPLAN EDI message, if the carrier visit specified in the EDI message generates an error, use the EDI
Batch Inspector Actions Update Carrier Visit option to select the required carrier visit before you post the
EDI batch.
If you want N4 to automatically post future inbound EDI, in the EDI Session form (on page 195), select the
Auto Post check box and click Save.
To resolve a failed inbound EDI post with no errors:
1. In the EDI Batch Inspector, on the Segments tab, review the EDI interchange data to make sure that the last
record contains the proper ending segment per the EDI standard.
Typically the last segment of an EDI file is either the IEA or UNZ segment, depending on the EDI message type.
2. If the last segment is missing, then the EDI file is truncated. Contact your trading partner for another EDI file.
To resolve a failed outbound EDI extract with no errors:
1. In the EDI Session form (on page 195), make sure the Message Map specified matches the EDI message type.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
243
Part 1: EDI
Troubleshooting EDI
Transshipment records are being retired
2. In the EDI Message Types form, on the EDI Message Map tab, select the message map specified in the EDI
Session form and click
to open the EDI Message Map form.
3. In the EDI Message Map form, export the XML mapping file.
4. Review the XML mapping file and make sure it matches the EDI message type.
5. If the mapping file does not match the EDI message type, then import the correct XML mapping file.
6. In the EDI Session form, update the Last Run Time date and time to the date and time of the previous successful
extract and then extract the EDI message again.
If you were not able to resolve your problem, contact your regional Navis Support office.
1.7.3 Transshipment records are being retired
Check to see if the COPARN EDI message was posted with message function as "X". This would remove the existing
unit from the booking and retire the unit. If you want to update the unit instead of retiring it, use message function as
"U" instead "X".
1.7.4 COPARN updates IB and OB Carrier of THROUGH
Containers
Problem:
Posting Rule has been defined so that no routing details should be updated if the unit Category is THROUGH.
However, COPARN updates IB and OB Carrier of THROUGH containers.
Solution:
Edit N4 setting ARGOEDI019 (EDI_CREATE_UPDATE_UNIT) (on page 136), ARGOEDI019
(EDI_CREATE_UPDATE_UNIT) (on page 866) at the Complex level to include the following override (in bold) of the
EdiUnitPredicate.xml:
<?xml version="1.0" encoding="UTF-8"?>
<edi-unit-predicates>
<!--If there is no predicate defined or no predicate matches then the value provided
for the default="" attribute in booking element would be
considered either to create a new unit or update a existing unit. If the default value
is defined then it might be either "UPDATE" (or) "CREATE"
-->
<booking default="">
<!-1. All the attributes (ediCategory,unitCategory,unitTstate,existingObCv) with value are
mandatory.
2. ediCategory/unitCategory value might be any one of the following value "EXPRT" (or)
"IMPRT" (or) "TRSHP" (or)"STRGE".
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
244
Part 1: EDI
Troubleshooting EDI
COPRAR DISCHARGE EDI does not create units if the vessel is departed
3. unitTstate can be provided either with single value or multiple value with comma(,)
separation.
eg. unitTstate="INBOUND" or unitTstate="INBOUND,YARD,EC/IN"
4. unitTstate value might be given as any of these value INBOUND,YARD,EC/IN,EC/
OUT,DEPARTED,RETIRED.
5. existingObCv might be provided as either "SAME" (or) "DIFF" (or) "GEN_CARRIER".
6. <predicate> value might be either "UPDATE" (or) "CREATE"</predicate>
-->
<predicate ediCategory="EXPRT" unitCategory="THRGH" unitTstate="INBOUND"
existingObCv="SAME">CREATE</predicate>
</booking>
</edi-unit-predicates>
1.7.5 COPRAR DISCHARGE EDI does not create units if
the vessel is departed
This is the default behavior. If you want to create units that are associated with a departed vessel, set
ARGODISCHLIST004 (on page 122), ARGODISCHLIST004 (on page 853) to True. Regardless of the value set for
ARGODISCHLIST004, N4 does not process a discharge list if the vessel visit phase is Archived.
1.7.6 Your trading partner did not receive an outbound
EDI file
If your trading partner did not receive an outbound EDI file, and there are no errors displayed in N4 for the selected EDI
batch, then either the communication setup is incorrect or N4 cannot access the FTP folder. This section lists the two
main communication types, with instructions for their use.
To verify your setup to send EDI by email:
1. In the EDI Mailbox form (on page 202), EDI Mailbox form (on page 876) for the selected EDI session, review the
email address and make sure to enter a correct email address.
2. In the EDI Session form (on page 195), on the Settings tab, review the EDIEMAIL001 and EDIEMAIL002 settings
and make sure you have set them correctly. N4 validates the email address when you create or edit the EDI
configuration (on page 205), EDI configuration (on page 843).
3. In the EDI Session form, update the Last Run Time date and time to the date and time of the previous successful
extract.
4. Extract the EDI message again.
To verify your setup to send EDI by File Transfer Protocol (FTP) or Secure File Transfer Protocol (SFTP):
1. In the EDI Mailbox form (on page 202), EDI Mailbox form (on page 876) for the selected EDI session, make sure
that the values in the FTP Address, FTP User Id, FTP Password, and FTP Folder fields are correct.
2. Connect to the FTP server from a PC on the same network as the N4 application server using the FTP values in the
EDI Mailbox form to make sure you can connect successfully.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
245
Part 1: EDI
Troubleshooting EDI
Error "BL Nbr XXX already exists for the Line XXX" when importing EDI discharge list
3. Optionally, you can transfer a test file to the FTP server to make sure the connection works.
4. For SFTP, make sure your EDI trading partner supports SFTP.
5. In the EDI Session form (on page 195), update the Last Run Time date and time to the date and time of the
previous successful extract.
6. Extract the EDI message again.
If you were not able to resolve your problem, contact your regional Navis Support office.
1.7.7 Error "BL Nbr XXX already exists for the Line XXX"
when importing EDI discharge list
Check your setting for ARGOEDI008. Try setting this to 1. Note that this will essentially turn off ARGOEDI008, which
could result in performance issues.
1.7.8 Upload multiple transactions in one EDI message
To include multiple transactions in one EDI XML file, you need to define one root tag <transactions> and one or
more <transaction> tags.
For example,
<!-- Root Tag Beginning - Transactions -->
<edi:stowplanTransactions>
<!-- Transaction 1 -->
<edi:stowplanTransaction>
</edi:stowplanTransaction>
<!-- Transaction 2 -->
<edi:stowplanTransaction>
</edi:stowplanTransaction>
<!-- Root Tag Ends - Transactions -->
</edi:stowplanTransactions>
1.7.9 N4 is unable to read EDI file, stops at mapping
stage with no errors
If N4 is stuck at the mapping stage without any errors, one of the EDI filters may be missing a value. In the Entry Filter
tab of the EDI Filter form (on page 223), EDI Filter form (on page 906), make sure that the From Value and To Value
fields contain a value. Delete any EDI filter entries that are missing a value and then try posting the EDI file again.
1.7.10 N4 only posts import and transshipment
containers
If you select Discharge Only check box from the EDI Load form (on page 225) and post a stowplan message, then
N4 posts only the import and transshipment containers that must be discharged at the current port.
How the Discharge only option works
When you select the Discharge only check box and post a stowplan message with category 'THRGH' for import
containers, N4 completes the batch with a warning message stating that the batch is skipped. However, if the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
246
Part 1: EDI
Troubleshooting EDI
How to remove a job group
Discharge only check box is not selected, then N4 completes the batch by creating new units for the 'THRGH' import
containers.
Use this option with caution, since the outbound Stowplan will be extracted with only Export and Transshipment
containers that will be loaded in the current port. Through containers will not be sent in the Stowplan message.
The Discharge Only option works only for manual stowplan and does not work for EDI Jobs.
1.7.11 How to remove a job group
N4 does not allow you to delete any job group that is associated with the EDI jobs. To delete a job group, you need to
disassociate the EDI jobs from the job group and add the jobs to a new job group. Then, after ensuring the job group
does not have any EDI jobs associated, you can delete the job group from the Job Groups view.
1.7.12 Missing Segments after generating Outbound EDI
Prior to 3.4.4, segments got generated even if Message Type standard was defined as XML. This was fixed so that
now customers have to define the standard as FLAT FILE for N4 to generate and save the segments.
1.7.13 User can edit the EDI session in the EDI Sessions
form without the EDI_MANAGEMENT privilege
To restrict a user from creating and editing an EDI session by using the Administration EDI
Sessions view, exclude the 'EDI_EXECUTE' and 'EDI_EXTRACT' privileges.
EDI Sessions
EDI
You exclude the EDI_MANAGEMENT privilege to prevent a user from editing an EDI session from Administration
EDI EDI Configuration EDI Sessions EDI Sessions view EDI Session form.
1.7.14 COPARN Replace message - Incorrect final
booking quantity and units associated with different
booking items
Problem:
When you post the COPARN REPLACE EDI message to replace the booking items, the Booking Inspector displays
incorrect booking quantity and the units are associated with different booking items.
Solution:
To ensure that multiple booking items are not created and the units are associated with the correct booking item, you
must clear the Order Item Not Unique checkbox in the Booking Rules tab in the N4 client Configuration
Organizations Line Operators Line Operators view Line Operator form before posting the COPARN
REPLACE EDI message.
1.7.15 Warning message is displayed on extracting
Problem:
When you try to extract an ACTIVITY EDI message (CODECO or COARRI), N4 displays a warning message stating
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
247
Part 1: EDI
Troubleshooting EDI
Missing Segments after generating Outbound EDI
that no events can be extracted for the specified time period although the load/discharge, gate-in/gate-out events are
performed.
Resolution:
To resolve this, you must change the time specified in the Last Run Time field in the Administration EDI EDI
Sessions EDI Sessions View EDI Session form to extract the events performed during that time period, in the
COARRI or CODECO EDI message.
1.7.16 Missing Segments after generating Outbound EDI
If you are using Microsoft SQL Server for your ECS database, you may sometimes see an error similar to the one
below in the EDI Batch Process form when you post a LoadList EDI file.
"Hibernate query failed for HQL "from LineLoadList as e where e.linellComplex = ? and
e.linellVesselVisit = ? and e.linellCtrId = ? " with message: could not execute query;
SQL [select lineloadli0_.gkey as gkey383_, lineloadli0_.action_code as action2_38"
To resolve this error, enable the "READ_COMMITTED_SNAPSHOT" attribute to allow read access to the database to
resolve this error in the EDI batches. For details, see Enable read access to the ECS database.
1.7.17 Second UFV created after posting the Loadlist/
Dischlist
Problem:
When you post an EDI release message for an export container, followed by the Loadlist or Dischargelist for the same
container, N4 creates a second Unit Facility Visit (UFV) instead of updating the existing advised unit.
Solution:
You must set the ARGOLOADLIST006 (LDL_EDI_ACCURATE) (on page 141), ARGOLOADLIST006
(LDL_EDI_ACCURATE) (on page 871) setting to true if you want N4 to overwrite the category of the existing unit when
you post the Loadlist for the unit. Also, you must set the ARGODISCHLIST005 (DISCH_EDI_ACCURATE) (on page
122), ARGODISCHLIST005 (DISCH_EDI_ACCURATE) (on page 854) setting to ACCURATE if you want N4 to update
the EDI category of the existing unit when you post the Dischargelist for the unit after posting the EDI release
message .
1.7.18 Posting rules for O/B Carrier not considered for
Stowplan EDI
Problem:
When you define a posting rule to ignore the O/B Carrier updates in the stowplan EDI message, N4 does not consider
the rule and updates the outbound carrier of the unit as GEN_TRUCK.
Solution:
You must configure the posting rule at the Routing property group level in the Posting Rules view (on page 70),
Posting Rules view (on page 908) to apply or ignore the O/B carrier information in the stowplan EDI file.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
248
Part 1: EDI
Troubleshooting EDI
N4 purge job takes six seconds to locate the unit record to be deleted
1.7.19 N4 purge job takes six seconds to locate the unit
record to be deleted
Problem:
When you execute the purge job, N4 takes six seconds to purge each unit which increases the activity time at the
terminal.
Solution:
You must update the default value (500) of the INVREFRESH004 (RFRSH_UNIT_NUMBER) setting to a lower value to
prevent deadlock while refreshing the units.
1.7.20 N4 does not evaluate the posting rules to apply or
ignore carrier details
Problem:
N4 does not evaluate the posting rule and updates the outbound carrier visit although you configure a posting rule to
ignore the outbound carrier visit in the posted EDI message.
Resolution:
Posting rules are to be configured at Routing level to apply or ignore outbound carrier updates.
For example, if you want to define a posting rule in N4 to ignore outbound carrier details in the Stowplan EDI message
if the existing source is from a Rail Way Bill EDI, you must do the following:
Configure the posting rule at the Routing property group level in the EDI Posting Rules Posting Rules view to
apply or ignore the outbound carrier visit updates from the stowplan when you post a 417 EDI (Railwaybill) message.
1.7.21 DischargeList EDI with different POD updates
category from Import to Transshipment
Problem:
When you post a DischargeList EDI, if the Port of Discharge (POD) of an import container is different from the current
port, N4 updates the category from Import to Transshipment.
Resolution:
You must set ARGODISCHLIST005 (DISCH_EDI_ACCURATE) (on page 122), ARGODISCHLIST005
(DISCH_EDI_ACCURATE) (on page 854) to Accurate so that if the container category in the discharge list EDI
message is Import and if the POD of the container is not the current port, N4 retains the category as Import.
1.7.22 Bento server displays 'Job has multiple triggers'
error message
Problem:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
249
Part 1: EDI
Troubleshooting EDI
EDI batch is sent with error status although the EDI file is sent and archived correctly
If you assign the Bento server to a job group that includes multiple nodes, N4 displays the message 'Job has multiple
triggers' in the Status field in the Background Jobs view (on page 929).
Resolution:
You must not assign the Bento server to a job group that includes multiple nodes. This will prevent N4 from displaying
the message 'Job has multiple triggers' in the Status field in the Background Jobs view.
1.7.23 EDI batch is sent with error status although the
EDI file is sent and archived correctly
Problem:
When you send the EDI batch file, the EDI batch is sent and archived correctly, but N4 displays the status as Errors in
the Batches view (on page 172), Batches view (on page 823) stating that the job execution failure occurred when
archiving the YML_COARRI_OUT_LOAD.edi file.
Solution:
Check to make sure that there's isn't more than one EDI session configured to the same EDI mailbox directory and
scheduled to run at the same frequency. If this is the case, make sure you set up a separate EDI mailbox directory.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
250
1.8 EDI How Do I...
How do I ...
In This Section
Set whether a BL is updated or created to match a manifested quantity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Determine whether N4 updates or creates a new unit when a load list is posted for an existing transship or export
container. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Post a disposition code as "Information Only". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Set the facility ID for validation when posting EDI messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Update a unit’s group code with the value received in the Discharge List EDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Manually load an EDI message file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Initiate EDI batch posting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
View EDI exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Process a BOOKING EDI message that does not have vessel information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Add the Marine Pollutant (MP) placard to hazards in an EDI file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Configure EDI to apply a hold multiple times for the same reference ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Handle FTX and Hazardous Free Text Segments in built-in BAPLIE file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Determine the line operator for a vessel visit created as a result of an IFTSAI message. . . . . . . . . . . . . . . . . . . 256
Difference between ARGOEDI025 and ARGOEDI018. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Determine whether N4 must update the existing unit's inbound visit as GEN_VESSEL on posting the Delete
message for the 310 Manifest EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Validate the container weight with the Gross Weight and the VGM Weight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Determine whether to record the discrepancies for the units posted in the BAPLIE message and missed in the
COPRAR Load list or Discharge list file.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
251
Part 1: EDI
EDI How Do I...
Set whether a BL is updated or created to match a manifested quantity
1.8.1 Set whether a BL is updated or created to match a
manifested quantity
Include the REPLACE qualifier in the MANIFEST EDI message so that when posted, N4 finds the bill of lading and
updates it along with the manifest quantity. If the bill of lading does not exist, N4 creates the bill of lading with the
manifest quantity.
See setting ARGOMANIFEST010 ("MFT_SKIP_MANIFEST_QTY_UPDATE") (on page 131), ARGOMANIFEST010
("MFT_SKIP_MANIFEST_QTY_UPDATE") (on page 862):
Determines whether N4 updates the manifest quantity for an existing bill of lading when the UPDATE qualifier is used
in the EDI message.
If set to true, then N4 does not update the manifest quantity, but updates other manifest information and displays the
warning message "Manifest Qty is not updated...". In this case, N4 only updates the manifest quantity for an existing
bill of lading when the REPLACE qualifier is used.
If set to false (default), then N4 updates the manifest quantity along with manifest information and displays the
following warning message "Manifest qty is updated but message function is not replace".In this case, N4 updates the
manifest quantity for an existing bill of lading when either the UPDATE (with warning message) or REPLACE (no
warning message) qualifier is used.
1.8.2 Determine whether N4 updates or creates a new
unit when a load list is posted for an existing transship
or export container
See ARGOLOADLIST008 (LDL_REROUTE_UNIT) (on page 141), ARGOLOADLIST008 (LDL_REROUTE_UNIT) (on
page 871).
1.8.3 Post a disposition code as "Information Only"
Under Administration EDI Message Types Message Types view EDI Message Type form Release Map
tab EDI Release Map form, select "Information Only" from the Modify Quantity drop-down list. When N4 identifies
a disposition code with modify quantity set to 'Information only', it records the 350 message with the quantity but does
not use that value to compute the entered or released quantity for the Bill of Lading.
1.8.4 Set the facility ID for validation when posting EDI
messages
Use the ARGOEDI007 (EDI_FACILITY_FOR_POSTING) (on page 105) setting to provide the facility ID for validation
when posting EDI messages.
In the US Customs mapping file, the location identifying element P401 is mapped to the ediReleaseFlexString01
attribute in release.xsd file. When the ediReleaseFlexString01 attribute matches the Schedule D code of the
routing point for the facility, then N4 posts the EDI message. Otherwise, N4 displays the following error message:
EDI release message is not for this port, port schedule xxxx does not match with message schedule D xxxx.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
252
Part 1: EDI
EDI How Do I...
Update a unit’s group code with the value received in the Discharge List EDI
1.8.5 Update a unit’s group code with the value received
in the Discharge List EDI
You can customize your discharge list EDI map so that the group code received in the discharge list EDI file is updated
against a unit in the Grp column in Units view.
Below is an excerpt from the Discharge List transaction XML file with the group code <edi:dischlistTransaction edi:msgClass="DISCHLIST" edi:msgReferenceNbr="090409163829"
edi:msgTypeId="COPRAR">
….
……….
<edi:containerOperator edi:operator="KEU" />
<edi:importRouting>
<edi:loadPort edi:portId="SGSIN" edi:portIdConvention="UNLOCCODE"/>
<edi:dischargePort1 edi:portId="USOAK"/>
<edi:groupCode>KEUGROUP</edi:groupCode>
</edi:importRouting>
<edi:grossWeight edi:wtUnit="KG" edi:wtValue="11999"/>
......
………di:dischlistTransactions>
1.8.6 Manually load an EDI message file
You can manually load an EDI message file using the EDI Load form (on page 225) .
To load an EDI message file:
1. From the EDI Session drop-down list, select an inbound EDI session.
Each entry in the drop-down list displays the EDI Session name followed by the EDI message type ID in
parentheses.
2. Click Browse, to locate the file on your computer or network.
In the EDI Load dialog box, select the EDI message file. The complete path and the name of the selected file is
displayed in the EDI File field.
3. Optionally, select the Post Immediate check box, to post the EDI file immediately.
If you do not select the check box, the file is posted when the selected EDI session is posted. If the Auto Post
option is selected for the EDI session, the file is posted automatically. For more information, see EDI Session form
(on page 195).
4. Click Load.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
253
Part 1: EDI
EDI How Do I...
Initiate EDI batch posting
1.8.7 Initiate EDI batch posting
From the EDI Batch Inspector:
You can post or repost all the transactions in a selected EDI batch by selecting the Post option from the Action menu
of the EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825).
From the Rail Inspector:
On the Inbound EDI tab, double-click an EDI batch record, or select an EDI batch record and click
Batch Inspector (on page 175), EDI Batch Inspector (on page 825). Click Post.
to open the EDI
From the Vessel Inspector:
On the Inbound EDI tab, double-click an EDI batch record, or select an EDI batch record and click
Batch Inspector (on page 175), EDI Batch Inspector (on page 825). Click Post.
to open the EDI
1.8.8 View EDI exceptions
To view the details of an EDI exception, double-click the record on the Exceptions tab (on page 177), Exceptions tab
(on page 827) or select the record and click
.
1.8.9 Process a BOOKING EDI message that does not
have vessel information
To process a BOOKING EDI message that does not have vessel information, i.e. the vessel field is blank (null), you
can create a dummy vessel visit in N4 and assign that vessel visit to the BOOKING EDI message.
1.8.10 Add the Marine Pollutant (MP) placard to hazards
in an EDI file
To add the Marine Pollutant (MP) placard to hazard units, you must send those details in the Dangerous Goods Label
(C236) element of the DGS segment in the EDI file. For example, when you post a COPARN booking EDI file with the
following DGS segment ..
...
MEA+WT+G+KGM:8706'
SEL+007640+SH'
FTX+AAA+++OTHER'
DGS+IMD+9+1122+++++++MP'
FTX+AAC++NP'
FTX+AAD++N'
DGS+IMD+4.1+4455+++++++MP'
FTX+AAC++P'
FTX+AAD++Y'
..
...
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
254
Part 1: EDI
EDI How Do I...
Configure EDI to apply a hold multiple times for the same reference ID
'MP' is added as the hazard placard to the unit. You can view the same in the Units view under Units View
Inspector Update Hazards.
Unit
If you are posting the EDI using XML, add the "edi:hazardLabel1='MP'" attribute in the '<edi:ediHazard>'
element in the XML file. For example,
..
...
<edi:ediReeferRqmnts edi:rfHumidityRequired="5.0" edi:rfVentRequired="7.0"
edi:rfVentRequiredUnit="PERCENTAGE" edi:rfCo2Required="4" edi:rfO2Required="2" />
<edi:ediHazard edi:baseImdgClass="" edi:deckRestrictions=""
edi:marinePollutants="true" edi:emergencyScheduleNbr="" edi:explosiveClass=""
edi:flashPoint="" edi:flashPointUnit="" edi:hazardDescription="" edi:hazardId=""
edi:hazardLabel1="MP" edi:hazardLabel2="" edi:hazardQuantity=""
edi:hazardTechnicalName="" edi:hazardWt="" edi:hazardWtUnit="" edi:imdgClass="1.2"
..
...
1.8.11 Configure EDI to apply a hold multiple times for
the same reference ID
In the Hold/Permission Type form, you can select the MultipleHolds Allowed check box to apply a hold multiple
times for the same reference Id. In addition, if you process EDI with multiple codes that are associated with a hold
where the MultipleHolds Allowed check box is selected, N4 can apply the same hold multiple times for that reference
Id. For example, you can use this to process a 350 message with multiple US customs 7H disposition codes that apply
a hold for each disposition code on the associated bill of lading.
To configure EDI to apply a hold multiple times for the same reference ID:
1. Open the Hold/Permission Type form for the hold you want to apply. If the hold does not exist, add the hold.
2. In the Hold/Permission Type form, select the MultipleHolds Allowed check box.
3. In the Hold/Permission Type form, optionally, select the Reference ID Required check box.
▪ If you select the Reference ID Required check box, then the reference ID must be a valid value and cannot be
zero (0) or a null value.
▪ If you do not select the Reference ID Required check box, then the reference ID can be a valid value, zero (0), or
a null value.
4. If a service business rule does not exist, in the Service Business Rule form, add a service business rule for this
hold.
For more information, see the Hold/Permission Type form (on page 489).
Notes
• Some information codes, such as the 7H and 7I codes in a 350 EDI message, have a Resend Indicator attribute.
When the Resend Indicator is false, N4 can create multiple holds if configured to do so. However, if the Resend
Indicator is true, N4 only creates one hold even if you post the same message twice. For more information, see Map
codes 7H and 7I (on page 90) in the online help or on the NCC.
• To apply a hold multiple times for the same reference ID, you cannot select the Unique by Reference ID check box
in the Hold/Permission Type form.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
255
Part 1: EDI
EDI How Do I...
Handle FTX and Hazardous Free Text Segments in built-in BAPLIE file
1.8.12 Handle FTX and Hazardous Free Text Segments in
built-in BAPLIE file
N4 supports up to six special stow instruction in the built in BAPLIE file. Following are the behaviors of N4 in various
scenarios:
Scenario 1:
Post EDI file with six Special Stow FTX segments, with FTX-AAA segment and does not consist GDS segment.
N4 updates only five Special Stow instructions and FTX-AAA will not be mapped to Special Stow Instructions Element.
N4 maps the description of FTX-AAA to Commodity Description.
Scenario 2:
Post the EDI file that consists of five Special Stow FTX Segments, does not consist FTX-AAA Segment and does not
consist GDS Segment.
N4 updates all the five Special Stow Instructions because FTX-AAA is not present in the posted EDI.
Scenario 3:
Post the EDI file with two Special Stow FTX segments and FTX-AAA FTX-AAA segment and with GDS Segment.
N4 updates only one Special Stow Instruction because the EDI file has the GDS segment. Also, the GDS Code will be
persisted as Commodity ID.
N4 does not map the FTX-AAA and its Description to Special Stow Instructions Element.
N4 updates the description of FTX-AAA as Commodity Description.
Scenario 4:
Post the EDI file that consists of five Special Stow FTX Segments, and a GDS Segment and does not have FTX-AAA
segment.
N4 updates all the five Special Stow Instructions as per the posted EDI file.
When you post the EDI BAPLIE file with FTX-AAA segment but without the GDS segment, N4 updates the FTX
+AAA in the commodity and FTX+HAN in the Special Stow fields. If you want to display special stow information
from the FTX+AAA segment, and the commodity description you can use Groovy code.
1.8.13 Determine the line operator for a vessel visit
created as a result of an IFTSAI message
Use the N4 setting, ARGOEDI026 (USE_VESSEL_LINE) (on page 117) to determine the line operator for a vessel visit
created as a result of an IFTSAI message.
If this setting is set to its default value of ‘true’, N4 creates a vessel visit using the vessel operator specified in N4.
However, when you change this setting to ‘false’, N4 creates a vessel visit using the line operator from the EDI
message. Also, N4 adds an entry for the vessel operator in the EDI message to the vessel visit lines (Vessel Visit
Inspector > Lines tab).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
256
Part 1: EDI
EDI How Do I...
Difference between ARGOEDI025 and ARGOEDI018
1.8.14 Difference between ARGOEDI025 and
ARGOEDI018
The ARGOEDI018 (VALIDATE_EQUIP_TYPE_EQUIVALENT) (on page 136), ARGOEDI018
(VALIDATE_EQUIP_TYPE_EQUIVALENT) (on page 866) setting is used for verifying the equipment type in the posted
EDI message with the equipment type of an existing unit whereas the ARGOEDI025
(CHECK_EQUIPMENTTYPE_EQUIVALENT) (on page 117) setting is used to check the equipment type equivalent
when reserving the units against an ELO, an EDO, or a Booking.
If ARGOEDI025 (on page 117) is set to 'false', N4 does not check for the equipment type equivalent and displays an
error message in the Batches view (on page 172), Batches view (on page 823)/EDI Batch Inspector (on page 175),
EDI Batch Inspector (on page 825) if the equipment type of the unit does not match the equipment type of the
ELO/EDO/Booking. However, if you set this setting to 'true', N4 checks for the equipment type equivalent for a unit, if
defined, and if it matches or is the equivalent, N4 reserves the units against an ELO/EDO/Booking.
The ARGOEDI018 (VALIDATE_EQUIP_TYPE_EQUIVALENT) (on page 136), ARGOEDI018
(VALIDATE_EQUIP_TYPE_EQUIVALENT) (on page 866) setting is used to determine whether to validate the
equipment type equivalent when you post the Stowplan or DischargeList EDI message. If set to 'true', the setting
validates the equipment type of the posted EDI message with the equipment type of the existing unit and N4 displays
an error message EDI Batch Inspector (on page 175), EDI Batch Inspector (on page 825) if the equipment types do
not match. However, if set to 'false', the setting does not validate the equipment type equivalent and posts the
message.
'
1.8.15 Determine whether N4 must update the existing
unit's inbound visit as GEN_VESSEL on posting the
Delete message for the 310 Manifest EDI message
You can use the ARGOMANIFEST013 (DELETE_MANIFEST_UPDATE_UNIT_CV) (on page 117) setting to determine
whether N4 must update the existing unit's inbound visit as GEN_VESSEL on posting the Delete message for the 310
Manifest EDI message.
If you set this setting to a default value of ‘false’, N4 does not update the unit's inbound declared visit to
GEN_VESSEL.
However, if you set this setting to ‘true’, N4 updates the unit's inbound declared visit to GEN_VESSEL.
When you set the ARGOMANIFEST013 (DELETE_MANIFEST_UPDATE_UNIT_CV) (on page 117) setting to ‘true’
and post the Delete message for the 310 Manifest EDI message with different BL and vessel visit, N4 updates the
already existing UFV.
1.8.16 Validate the container weight with the Gross
Weight and the VGM Weight
You can use the ARGOLOADLIST009 (LDL_VALIDATE_WEIGHT) (on page 142), ARGOLOADLIST009
(LDL_VALIDATE_WEIGHT) (on page 872) setting to determine whether N4 should validate the container weight with
the Gross Weight and the VGM Weight provided by the LOADLIST EDI message.
To display a warning message if the unit gross weight or the VGM weight of the container is less than the tare weight,
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
257
Part 1:
EDI
EDI How Do I...
Determine whether to record the discrepancies for the units posted in the BAPLIE message and missed in the COPRAR
Load list or Discharge list file.
you must override the ARGOLOADLIST009 (LDL_VALIDATE_WEIGHT) (on page 142), ARGOLOADLIST009
(LDL_VALIDATE_WEIGHT) (on page 872) setting and set the value as WARN_GROSS_LESS_THAN_TARE.
1.8.17 Determine whether to record the discrepancies for
the units posted in the BAPLIE message and missed in
the COPRAR Load list or Discharge list file.
You must use the ARGOLINE_LOAD_DISCHARGE_LIST008
(EDI_LOAD_LIST_DISCHLIST_MISSING_UNITS_ACTION) (on page 117) settings to determine whether to record the
discrepancies for the units posted in the BAPLIE message and missed in the COPRAR Load list or Discharge list file in
the Vessel Visit Inspector Loadlist Discrepancies tab or Disch.list Discrepancies tab.
By default, N4 records the discrepancies in the Vessel Visit Inspector
Discrepancies tab for the missing units.
Loadlist Discrepancies tab or Disch.list
If you override the above setting, at the Global level or the EDI Session level, and select the
AVOID_CREATE_MISSING_UNITS option, N4 does not record the discrepancies for the missing units in the Vessel
Visit Inspector Loadlist Discrepancies tab or Disch.list Discrepancies tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
258
Part 1:
EDI
EDI How Do I...
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
1.8.18 Display the date and time in the
containerArrivedDateTime containerDepartedDateTime
attributes on extracting the Activity EDI message
When you extract the Activity EDI message, N4 displays only the date in the containerArrivedDateTime and
containerDepartedDateTime attributes in the EDI Transactions form Contents Edit Area.
You must set the ARGOACTIVITY004 (EXTRACT_ACTIVITY_XSD_FORMAT) setting to False before extracting the
Activity EDI message. This ensures that the containerArrivedDateTime and containerDepartedDateTime attributes
display the date and time.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
259
Part 1:
EDI
EDI How Do I...
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
260
1.9 EDI Message Specifications
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
261
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
262
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
263
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
264
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
265
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
266
Part 1:
EDI
EDI Message Specifications
Display the date and time in the containerArrivedDateTime containerDepartedDateTime attributes on extracting the
Activity EDI message
In This Section
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
EDI Message Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
267
Part 1: EDI
EDI Message Specifications
Introduction
1.9.1 Introduction
In addition to the documented schema files, sometimes you require documentation about how a specific EDI Message
Type is implemented in N4. During the development of an EDI Message Type, we make certain assumptions about
how to handle individual segments and looping. The decisions made during the process are reflected in the standard
EDI Message Maps that we create. However, sometimes these maps are difficult to understand.
For example,
• For a particular message type we support some segments but do not support the other segments.
• For a particular EDIFACT message we support multiple UNH-UNT segments while for others we support loops only
in EQD inside one UNH-UNT segment.
• For a particular EDIFACT message we support the RFF inside the loop but for some we support it only in the
Header.
The following sections represent the Navis EDI Implementation Guidelines that describes how an EDI Message Type
that is supported in N4 is implemented.
1.9.2 Sections
For each EDI Message Type, the following sections are included:
• Section 1 provides the details of the EDI Message Standard, Message Type, Version, and Release. In addition, it
states the objective and the scope of this message in N4.
• Section 2 provides the table of the Segments and Loops that are supported/not supported in our N4 Standard Map
with respect to the EDI Standard (EDIFACT/ANSI).
• Section 3 provides the details on complex problems in the message and how are they handled in N4 Standard Map.
• Section 4 provides the Special Considerations and scenarios.
• Section 5 provides the Samples for every special case.
• Section 6 provides the Test Instructions.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
268
1.9.3 EDI Message Types
In this Section:
EDI Inbound BAPLIE Message - BAPLIE 3.1.1 D.13B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Booking Message - COPARN D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Booking Message - IFTMBC D 98B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Booking Message - IFTMCS D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
270
278
282
286
EDI Inbound Cargo Release Message - ANSI 350 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Container Release Order Message - COREOR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Customs Cargo Report Message - CUSCAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Customs Response Message - CUSRES D 96B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Discharge List Message - COPRAR D 95A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound LoadList Message - COPRAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Pre-advise Message - COPINO D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Rail consist Message - ANSI 418 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Rail Waybill Message - ANSI 417 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Saudi Load Permit Order Message - SAUDILDP 30. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Saudi Manifest Message - SAUDIMANIFEST30. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Verified Gross Mass Message - VERMAS D.16A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Vessel Schedule Message - IFTSAI D.00B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Container Discharge/Loading Report Message - COARRI D 95B. . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Container Gate-In/Gate-Out Report Message - EDIFACT CODECO D 95B. . . . . . . . . . . . . . . . .
EDI Outbound Invoice Message - ANSI 810. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Invoice Message - EDIFACT INVOIC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound LoadList Message - COPRAR D 95B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Message - BAPLIE 3.1.1 D.13B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Rail Consist Message - ANSI 418 00 4020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDI Outbound Terminal Performance Report Message - EDIFACT TPFREP 30 00B. . . . . . . . . . . . . . . . . . . . . .
EDI Inbound Inventory Update Message - COHAOR D 04B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
292
293
299
304
319
323
327
330
341
347
353
361
369
379
387
395
405
416
419
427
434
440
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
269
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.1 EDI Inbound BAPLIE Message - BAPLIE 3.1.1 D.13B
Purpose
The Bayplan/stowage plan occupied and empty locations message may be used for both national and international
applications. The reporting of empty locations has to be mutually agreed between partners.
The BAPLIE message is typically exchanged between a container terminal operator / stevedore, vessel operator,
shipping line, ship's master, tonnage center, non-vessel operating common carrier, container operator, slot charterer,
customs and other authorities.
Functional Definition
A message to transmit information about equipment (mostly containers) and goods on a means of transport (typically a
container vessel), including their location on the means of transport.
The Bayplan/stowage plan occupied and empty locations message may be used for both national and international
applications. The reporting of empty locations has to be mutually agreed between partners.
The BAPLIE message is typically exchanged between a container terminal operator / stevedore, vessel operator,
shipping line, ship's master, tonnage center, non-vessel operating common carrier, container operator, slot charterer,
customs and other authorities.
It is based on universal practice related to monitoring the logistics transport chain and is not dependent on the type of
business or industry.
1.1 Objective
Overall objective for version 3 of BAPLIE was to enhance the message in a way to reduce necessity for additional
communication about details unaccounted for in the message. Improving accuracy and completeness of transmitted
data serves for higher standards in vessel safety.
There are many cases where dimensions of containerized equipment are not sufficiently determined by its ISO size
type code. New qualifiers for the DIM segment are provided (width of body, width at corner posts, actual height of
telescopic end-walls, height of internal floor). The height specification allows for exact calculation of containers’ vertical
position in stacks. For containers the maximum allowable stacking weight can be specified.
Specifications for transport of un-containerized (breakbulk) data are improved. The weight of large breakbulk units can
be distributed across multiple units of supporting equipment. This allows for more accurate validation of stack-weight
limits. A qualifier for breakbulk’s vertical center of gravity is added for more accurate determination of centers of gravity
for vessel’s stability calculation.
Stowage locations which can/must not be used can be specified together with the according reason. Blocking by
oversize of other equipment (lost slot) refers to the equipment in charge.
Temperature settings and ranges for reefer containers can now be specified dependent as a function of date/time.
Parameter settings for atmosphere control can be specified.
1.2 Inbound BAPLIE Message (BAPLIE 3.1.1 D.13B)
N4 supports EDIFACT standard BAPLIE message, release D & version 13B.
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
270
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard BAPLIE D.13B message & scope of each segment in
N4.
The following picture illustrates groups and their segments supported in IFTSAI.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
271
Part 1: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI Message Specifications
EDI Message Types
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
272
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
A new built-in map with map id "BAPLIE_IN" is added to N4. this map can be used to convert the vermas edi file into
Navis standard vermas.xml. This xml in turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• baplie_31_13B.mgt.mgt - GoXml map
• baplie_3_1.dic - Edifact standard dictionary
• stowplan.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
Remove the below from FTX with ATT segment (Additional FTX segments should not be used for identification of
hazards)
Please note, the Edifact directory allows composite C956 to be repeated up to 5 times in each ATT segment:
1.ATT+26+QTY:DGATT:306+TLQ:DGQTY:306' - Limited quantity
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
273
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.ATT+26+PSN:DGATT:306+:::CHLOROSULPHONIC ACID' - Proper shipping name CHLOROSULPHONIC
ACID
3.ATT+26+TNM:DGATT:306+:::SOLVENT NAPHTHA' Technical name solvent naphtha
4.MEA+AAE+A AA+KGM:20000’ Net weight: 20t - hazard weight - move from FTX to MEA DGS
group
5. CTA+HG‘ Dangerous goods contact - map to emergency contact in DGS group
Data about attribute detail are transmitted in composite C956. Most data are transmitted as code in data element 9019.
ATT segment’s reference description in section x specifies the according code lists for each type.
Proper shipping name and Technical name are transmitted in data element 9018.
Please note, the Edifact directory allows composite C956 to be repeated up to 5 times in each ATT segment.
6. Container with controlled atmosphere - Reefer requirements
MEA+AAE+AAO+P1:20’ Humidity: 20%
MEA+AAE+AAS+MQH:20’ Air flow: 20 m3/h (vent reqd)
MEA+AAE+ZO+P1:20’ Oxygen: 20%
MEA+AAE+ZC2+P1:10’ Carbon dioxide: 10%
7. In case of bundled units:
MEA+AAE+AET+KGM:4800’ - Includes weight of bundled units.
For Inbound BAPLIE:
The weight in the MEA segment is divided by the count of containers in the bundle (including the primary unit in the
EQD segment and the payload unit in the EQA segment). For e.g., if the MEA segment is the Inbound BAPLIE is ‘MEA
+AAE+AET+KGM:6000’, assuming the bundle has three containers (1 primary + 2 payload), the weight of individual
containers in the bundle is updated in N4 as 2000.
For Outbound BAPLIE:
If the unit being extracted in the BAPLIE is a bundle of 4 containers (1 primary + 3 payload) each with gross weight as
1200, then the BAPLIE file extracts the MEA segment as MEA+AAE+AET+KGM:4800’.
4.1 How to Configure N4 for an Inbound BAPLIE?
The following section explains how to setup and test a Vermas message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
274
Part 1: EDI
EDI Message Specifications
EDI Message Types
To set up an Inbound BAPLIE message:
1. Create a session for BAPLIE message.
To post the BAPLIE EDI message:
1. Post Baplie message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
275
Part 1: EDI
EDI Message Specifications
EDI Message Types
2. Ensure batch is completed without any error message and Unit is created
5 Samples
UNB+UNOA:2+APL+FCP PLANNING+030626:1314+TEST001'
UNH+M-EX11+BAPLIE:D:13B:UN:SMDG31'
BGM+659::LOADONLY+M-EX1/1++38'
DTM+137:201304130959:203'
DTM+171+199912281415UTC:303'
RFF+AGO:BAPLIE ID'
NAD+CA+HLC:LINES:306'
TDT+20+014E47+++HLC:LINES:306+++9501332::11:NEW YORK EXPRESS'
RFF+VON:014E47'
LOC+5+BEANR+K913:terminal'
DTM+133:201304301048:203'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
276
Part 1: EDI
EDI Message Specifications
EDI Message Types
DTM+136:201304301048:203'
LOC+61+DEHAM'
DTM+132:201305012100:203'
DTM+178:201305012100:203'
UNS+D'
LOC+147+0501490::5'
EQD+CN+MARU1234567+45G1:2++2++5'
NAD+CF+HLC:172:20'
NAD+GF+MSK:172:20'
MEA+AAE+VGM+KGM:11000'
MEA+AAE+AET+KGM:12000'
HAN+OND:HANDLING:306'
DIM+5+CMT:100'
DIM+6+INH:200'
DIM+7+CMT:300'
DIM+8+CMT:400'
DIM+13+MMT:500'
GDS+57:HS:1+cmd 1'
LOC+9+GBSOU:139:6'
LOC+11+DEHAM:139:6'
LOC+83+DEHAM:139:6'
TMP+2+-1.5:CEL'
RNG+5+CEL:-24:-21'
DGS+IMD+2.1::35-10+1954+055:CEL+1+F-E,S-E'
CNT+8:1'
LOC+147+0260490:9711:5'
EQD+DPL+XLXU8523991:6346:5+45G1:6346:2++3++5'
NAD+CF+APL:172:20'
RFF+BN:00002'
MEA+AAE+VGM+KGM:12000'
HAN+AAA:HANDLING:306:FRESH WATER ACCESS'
DIM+5+CMT:101'
DIM+6+INH:201'
DIM+7+CMT:301'
DIM+8+CMT:401'
DIM+13+MMT:501'
GDS+58:HH:1+cmd 2'
LOC+9+USOAK:139:6'
LOC+11+SGSIN:139:6'
TMP+2+-3.5:CEL'
RNG+5+CEL:-15:-15'
DGS+IMD+3.1:8:35-10+1754++1+F-A,S-B'
CNT+8:1'
LOC+147+0260490:9711:5'
EQD+DPL+MARU09112018:6346:5+2200:6346:3++4++5'
NAD+CF+APL:172:20'
RFF+BN:00002'
MEA+AAE+AET+KGM:13000'
HAN+BBB:HANDLING:306:SPECIAL HANDLING'
DIM+5+CMT:102'
DIM+6+INH:202'
DIM+7+CMT:303'
DIM+8+CMT:404'
DIM+13+MMT:505'
GDS+59:HH:1+cmd 2'
LOC+9+USOAK:139:6'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
277
Part 1: EDI
EDI Message Specifications
EDI Message Types
LOC+11+SGSIN:139:6'
DGS+IMD+3.1::45-10+1964+055:CEL+1+ACID'
CNT+8:1'
UNT+789+1'
UNZ+1+0'
1.9.3.2 EDI Inbound Booking Message - COPARN D 95B
Purpose
This specification provides the Container Announcement Instructions Message (COPARN) to be used in Electronic
Data Interchange (EDI), which is sent by the shipping agent to the container terminal, operator, or depot.
Functional Definition
• This message is the order for the release of empty containers and the announcement of the delivery of full or empty
containers to the terminal.
• When it concerns a release of containers, the shipping agent reports to the terminal operator that one or more
containers will be collected on a later date.
• In case of an announcement, the shipping agent announces to the terminal operator that full or empty containers will
be brought to the terminal whether or not with the intention to be exported.
1.1 Objective
The following sections of this document explain how COPARN message is handled in N4 and scope of its
implementation.
In a terminal, COPARN EDI is received from the shipping agent. The Implementation or posting is done based on the
message function specified in the COPARN EDI message
1.2 Container Announcement Instructions Message (COPARN)
N4 supports EDIFACT standard COPARN message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard COPARN D 95B message & scope of each segment in
N4.
S.No
Group
Segment ID
Supported Qualifier
Description
Supported in N4?
1
UNH
Message Header
Supported
2
BGM
Beginning of message
Supported
3
TMD
Transport Movement Details
Not Supported
4
DTM
Date/time/period
Supported
5
TSR
6
FTX
AAI
Free text
Not Supported
7
RFF
BN
Reference
Supported
8
DTM
Date/time/period
Not Supported
9
TDT
Details of transport
Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
2, 63
Transport Service Requirements Not Supported
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
278
Part 1: EDI
S.No
Group
EDI Message Specifications
EDI Message Types
Segment ID
Supported Qualifier
Description
Supported in N4?
10
RFF
VON
Reference
Supported
11
LOC
8, 9, 11
Place/location identification
Supported
12
DTM
132, 133, 136,178
Date/time/period
Supported
13
NAD
CA, CN, CZ, CF
Name and address
Not Supported
14
CTA
Contact information
Not Supported
15
RFF
Reference
Not Supported
16
DTM
Date/time/period
Not Supported
17
GID
Goods item details
Not Supported
18
HAN
Handling instructions
Not Supported
19
FTX
Free text
Supported
20
RFF
Reference
Not Supported
21
PIA
Additional product id
Not Supported
22
NAD
Name and address
Not Supported
23
DTM
Date/time/period
Not Supported
24
RFF
Reference
Not Supported
25
MEA
Measurements
Not Supported
26
DIM
Dimensions
Not Supported
27
DOC
Document/message details
Not Supported
28
SGP
Split Goods Placement
Not Supported
29
MEA
Measurements
Not Supported
30
DGS
Dangerous goods
Not Supported
31
EQD
Equipment details
Supported
32
RFF
Reference
Not Supported
33
EQN
Number of units
Supported
34
TMD
Transport movement details
Not Supported
35
DTM
Date/time/period
Not Supported
36
TSR
Transport service requirements
Not Supported
37
LOC
Place/location identification
Not Supported
38
MEA
AET, G, CD, ZO, AAO, AAS Measurements
Supported
39
DIM
5, 6, 7, 8, 9
Dimensions
Not Supported
40
TMP
Temperature
Supported
41
RNG
Range details
Supported
42
SEL
CA, SH, TO, CU
Seal number
Supported
43
FTX
AAA, AAI
Free text
Not Supported
44
DGS
Dangerous Goods
Supported
45
FTX
Free text
Supported
46
MOA
Monetary amount
Not Supported
47
GOR
Governmental Requirements
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
279
Part 1: EDI
S.No
EDI Message Specifications
EDI Message Types
Group
Segment ID
Supported Qualifier
Description
Supported in N4?
48
EQA
Attached equipment
Not Supported
49
DAM
Damage
Not Supported
50
COD
Component details
Not Supported
51
TDT
Details of transport
Not Supported
52
LOC
Place/location identification
Not Supported
53
DTM
Date/time/period
Not Supported
54
NAD
Name and address
Not Supported
55
DTM
Date/time/period
Not Supported
56
CTA
Contact information
Not Supported
57
COM
Communication contact
Not Supported
58
CNT
Control total
Not Supported
59
UNT
Message trailer
Not Supported
2.2 COPARN - Message Functions
As per EDIFACT standard, COPARN has various message function codes in BGM segment and N4 supports the
following message functions are supported:
BGM+12+20070702004202+9' – Here "9" is the message function qualifier
Qualifier in the EDI message
Value in the XML
9
2
3
4 or 33
1
O - Original
A - Add
E - Delete
U - Change
D - Cancel
5
X - Replace
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert COPARN Edi message into Navis standard booking xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• coparn_D_95B.mgt - GoXml map
• coparn.dic - Edifact standard dictionary
• booking.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
edi:BookingItem mapping
• Added a filter (/EDI/Group_Loop/COPARN/SG13/EQD/C237@A_8260==NULL) such that this tag will be displayed
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
280
Part 1: EDI
EDI Message Specifications
EDI Message Types
only when the EQD segment has no
equipment number
• Added a match to SG13 loop (EQD Loop)
edi:BookingEquipment
• Added a filter (/EDI/Group_Loop/COPARN/SG13/EQD/C237@A_8260 !=NULL) such that this tag will be displayed
only when the EQD segment has
equipment number
• Added a match to SG13 loop (EQD Loop)
4.1 How to Configure N4 for COPARN?
N/A
4.2 Special Cases
N/A
4.3 Settings
N4 has a way of validating some business conditions, which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for COPARN message:
Name
Description
Edit UI
ARGOBOOKING001 Import To Transship
Session
ARGOBOOKING002 Allow container Update
1. Create new pre-advised export containers
Settings 2. Update existing containers to associate them to
the export booking
ARGOBOOKING003
Allow creation of Foreign
Vessel Visits
Session
Usage
To change import containers to transship
containers.
To create a vessel if the vessel specified in a
BOOKING EDI message is not in N4.
5 Samples
UNB+UNOA:1+MAE+MWTCMYT+070702:0042+685453'
UNH+68545300001+COPARN:D:95B:UN'
BGM+12+20070702004202+9'
RFF+BN:TYOAGB810'
TDT+20+0713+1+MAE:172:20++9290426:146:11:MAERSK DURHAM'
LOC+88+ZADUR:139:6'
LOC+9+ZADUR:139:6'
DTM+133:200707151800:203'
NAD+CZ+41594607J+PANALPINA WORLD TRANSPORT (TYO)'
NAD+CA+MAE:172:20'
GID+1'
FTX+AAA+++HAZ CHEMICAL'
DGS+IMD+9+2071++3+F-HS-Q+*'
FTX+AAD+++AMMONIUM NITRATE BASED FERTILIZER'
EQD+CN++22G1:102:5+2+2+4'
RFF+BN:TYOAGB810'
EQN+9'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
281
Part 1: EDI
EDI Message Specifications
EDI Message Types
TMD+3++2'
DTM+201:200707021041:203'
LOC+8+HKHKG:139:6'
LOC+11+HKHKG:139:6'
MEA+AAE+G+KGM:8000'
MEA+AAE+T+KGM:2150'
MEA+AAE+EGW+KGM:10150'
FTX+AAI+++TYO4, FWD?:SUZUYO/SHPR?:PANALPINA, P-UP?:SHIMIZU *DG*'
CNT+16:1'
UNT+43+68545300001'
UNZ+1+685453'
1.9.3.3 EDI Inbound Booking Message - IFTMBC D 98B
Purpose
This specification provides the Booking confirmation message (IFTMBC) to be used in Electronic Data Interchange
(EDI) between trading partners involved in administration, commerce and forwarding/transporting parties.
Functional Definition
• Permits the transfer of data from a Forwarding/Transporting parties
• It can be used whenever a confirmation of the booking of a consignment is deemed necessary as an answer to a
booking provisional or booking firm message concerning a certain consignment.
• It can also be used to confirm cargo particulars and equipment requirements.
• A confirmation might read that the booking of a consignment is accepted, pending, conditionally accepted or
rejected.
1.1 Objective
The following sections of this document explain how IFTMBC message is handled in N4 and scope of its
implementation.
In a terminal, IFTMBC Edi is received from Forwarding/Transport parties. The Implementation or posting is done based
on the message function specified in the EDI message.
1.2 Booking confirmation message (IFTMBC)
N4 supports EDIFACT standard IFTMBC message, release D & version 98B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard IFTMBC D 98B message & scope of each segment in
N4.
S.No
Group
Segment ID
Supported
Qualifier
Description
Supported in N4?
1
UNH
Message Header
Supported
2
BGM
Beginning of message
Supported
3
CTA
Contact Information
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
282
Part 1: EDI
S.No
Group
EDI Message Specifications
EDI Message Types
Segment ID
4
COM
5
DTM
6
TSR
7
FTX
8
CNT
9
SG1
10
11
LOC
Supported
Qualifier
2, 63, 137
AAI, BLR, AAA
7, 9 , 11
DTM
SG2
RFF
BN, ERN
Description
Supported in N4?
Communication Contact
Not Supported
Date/Time/Period
Supported
Transport Service Requirements
Not Supported
Free text
Supported
Control Total
Not Supported
Details of transport
Supported
Date/Time/Period
Not Supported
Reference
Supported
12
DTM
Date/Time/Period
Not Supported
13
TCC
Transport Charge/Rate Calculations
Not Supported
TDT
Details of Carriage Level Info
Supported
15
DTM
Date/Time/Period
Not Supported
16
TSR
Transport Service Requirements
Not Supported
Details of transport
Supported
DTM
Date/Time/Period
Not Supported
RFF
Reference
Not Supported
DTM
Date/Time/Period
Not Supported
Name And Address
Supported
LOC
Details of transport
Not Supported
CTA
Contact Information
Not Supported
COM
Communication Contact
Not Supported
TSR
Transport Service Requirements
Not Supported
26
RFF
Reference
Not Supported
27
LOC
Details of transport
Not Supported
28
TPL
Transport Placement
Not Supported
29
FTX
Free Text
Not Supported
GID
Information about the Packaging of Goods Not Supported
31
HAN
Handling Instructions
Not Supported
32
TMP
Temperature
Not Supported
33
RNG
Range
Not Supported
34
TMD
Transport Movement Details
Not Supported
35
LOC
Details of Transport
Not Supported
36
FTX
Free Text
Not Supported
37
PCD
Percentage Details
Not Supported
NAD
Name And Address
Not Supported
39
DTM
Date/Time/Period
Not Supported
40
GDS
Nature Of Cargo
Supported
14
17
SG3
SG4
18
19
SG5
20
21
SG6
22
23
SG7
24
25
30
38
SG8
SG9
SG10
LOC
NAD
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
7, 9 , 11
CA, CN, OS, CZ,
SF
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
283
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S.No
Group
Segment ID
41
SG11
MEA
Measurements
Not Supported
EQN
Number Of Units
Not Supported
Dimension
Supported
EQN
Number Of Units
Not Supported
RFF
Reference
Not Supported
DTM
Date/Time/Period
Not Supported
DOC
Document/Message Details
Not Supported
DTM
Date/Time/Period
Not Supported
DGS
Dangerous Goods
Supported
Free Text
Supported
CTA
Contact Information
Not Supported
COM
Communication Contact
Not Supported
MEA
Measurements
Supported
EQN
Number Of Units
Not Supported
EQD
Equipment Qualifier
Supported
56
EQN
Number Of Units
Supported
57
TMD
Transport Movement Details
Not Supported
58
MEA
Measurements
Not Supported
59
DIM
Dimension
Not Supported
60
HAN
Handling Instructions
Not Supported
61
TMP
Temperature
Not Supported
62
FTX
Free Text
Not Supported
63
RFF
Reference
Not Supported
NAD
Name And Address
Not Supported
65
DTM
Date/Time/Period
Not Supported
66
UNT
Message Trailer
Not Supported
42
43
SG12
44
45
SG13
46
47
SG14
48
49
SG15
50
51
FTX
SG16
52
53
SG17
54
55
64
DIM
SG 18
SG19
5, 6, 7, 8, 9
AAD
Description
Supported in N4?
2.2 IFTMBC - Message Functions
As per EDIFACT standard, IFTMBC has various message function codes in BGM segment and N4 supports the
following message functions are supported
BGM+661+WCP00000530901+9+AB' – Here "9" is the message function qualifier.
Qualifier in the EDI message
Value in the XML
9
2
3
4 or 33
1
5
O - Original
A - Add
E - Delete
U - Change
D - Cancel
X - Replace
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
284
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert IFTMBC Edi message into Navis standard booking xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• iftmbc_D_98B.mgt- GoXml map
• iftmbc.dic -Edifact standard dictionary
• booking.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
edi:BookingItem mapping
• Added a filter (/EDI/Group_Loop/IFTMBC/SG18/EQD/C237@A_8260==NULL) such that this tag will be displayed
only when the EQD segment has no equipment number.
• Added a match to SG18 loop (EQD Loop).
edi:BookingEquipment and edi:ediContainer mapping
• Added a filter (/EDI/Group_Loop/IFTMBC/SG18/EQD/C237@A_8260!=NULL) such that this tag will be displayed
only when the EQD segment has equipment number.
• Added a match to SG18 loop (EQD Loop).
4.1 How to Configure N4 for IFTMBC?
N/A
4.2 Special Cases
N/A
4.3 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for IFTMBC message:
Name
Description
Edit UI
ARGOBOOKING001 Import To Transship
Session
ARGOBOOKING002 Allow container Update
Create new pre-advised export containers.
Settings Update existing containers to associate them to the
export booking.
ARGOBOOKING003
Allow creation of Foreign
Vessel Visits
Session
Usage
To change import containers to transship
containers.
To create a vessel if the vessel specified in a
BOOKING EDI message is not in N4.
5 Samples
UNB+UNOA:2+RIK+RIK+081222:0310+45978'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
285
Part 1: EDI
EDI Message Specifications
EDI Message Types
UNH+25507360+IFTMBC:98B:UN'
BGM+772:::BOOKING CONFIRMATION+25507001+9'
DTM+137:200807010308:203'
TSR+3'
FTX+AAI+++FURNITURE'
RFF+VON:726'
TDT+20+001+1+RIK:172:20++726:103::RIK VESSEL'
LOC+9+NZLYT:139:6:NORTHPORT,P.KLANG+CT1:TER:ZZZ'
LOC+11+SGSIN:139:6'
LOC+8+HKHKG:139:6'
LOC+7+NZLYT:139:6'
DTM+132:200807252100:203'
DTM+133:200800010800:203'
NAD+CF+RIK:160:166'
GID+1'
EQD+CN+45G0:102:5+2+5'
EQN+1'
TMD+3'
MEA+AAE+G+KGM:23020'
RFF+HS:940300'
NAD+CZ+A046:160:166++HAPAG-LLOYD' UNT+22+22507360'
1.9.3.4 EDI Inbound Booking Message - IFTMCS D 95B
Purpose
This specification provides the definition of the Instruction contract status message (IFTMCS) to be used in Electronic
Data Interchange (EDI) between trading partners involved in administration, commerce and transport.
Functional Definition
• It is a single consignment based message.
• It is an export booking confirmation/response to query messages transmitted by carriers to exporters/their agents in
response to booking requests.
• It can be used by all modes of transport for the forwarding and transport of goods from any origin to any destination,
regardless of route or prevailing commercial practice.
• It is suitable for the arrangement of the transport of goods between all parties to the movement of the consignment.
1.1 Objective
The following sections of this document explain how IFTMCS message is handled in N4 and scope of its
implementation.
In a terminal, IFTMCS Edi is received from Forwarding/Transport parties. The Implementation or posting is done based
on the message function specified in the EDI message
1.2 Instruction contract status message (IFTMCS)
N4 supports EDIFACT standard IFTMCS message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard IFTMCS D 95B message & scope of each segment in
N4.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
286
Part 1: EDI
S.No
Group
EDI Message Specifications
EDI Message Types
Segment ID
Supported
Qualifier
Description
Supported in N4?
1
UNH
Message Header
Supported
2
BGM
Beginning of message
Supported
3
CTA
Contact Information
Not Supported
4
COM
Communication Contact
Not Supported
5
DTM
Date/Time/Period
Not Supported
6
TSR
Transport Service Requirements
Not Supported
7
CUX
Currencies
Not Supported
8
MOA
Monetary Amount
Not Supported
9
FTX
Free text
Not Supported
10
CNT
Control Total
Not Supported
Details of transport
Supported
DTM
Date/Time/Period
Not Supported
TOD
Terms Of Delivery or Transport
Not Supported
LOC
Details of transport
Not Supported
Reference
Supported
DTM
Date/Time/Period
Not Supported
GOR
Governmental Requirements
Not Supported
18
DTM
Date/Time/Period
Not Supported
19
LOC
Details of transport
Not Supported
20
SEL
Seal number
Not Supported
21
FTX
Free text
Not Supported
DOC
Document/Message Details
Not Supported
DTM
Date/Time/Period
Not Supported
CPI
Charge payment instructions
Not Supported
25
CUX
Currencies
Not Supported
26
LOC
Details of transport
Not Supported
27
MOA
Monetary amount
Not Supported
TCC
Transport Charge/Rate Calculations
Not Supported
29
LOC
Details of transport
Not Supported
30
FTX
Free Text
Not Supported
31
CUX
Currencies
Not Supported
32
PRI
Price Details
Not Supported
33
EQN
Number of units
Not Supported
34
PCD
Percentage details
Not Supported
35
MOA
Monetary amount
Not Supported
36
QTY
Quantity
Not Supported
TDT
Details of Carriage Level Info
Supported
DTM
Date/Time/Period
Not Supported
11
SG1
12
13
SG2
14
15
SG3
16
17
22
SG4
SG5
23
24
28
37
38
SG6
SG7
SG8
LOC
RFF
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
7, 88
BN, ERN
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
287
Part 1: EDI
S.No
Group
39
40
SG9
SG10
43
44
Segment ID
Supported
Qualifier
TSR
41
42
EDI Message Specifications
EDI Message Types
SG11
Description
Supported in N4?
Transport Service Requirements
Not Supported
Details of transport
Supported
DTM
Date/Time/Period
Not Supported
RFF
Reference
Not Supported
DTM
Date/Time/Period
Not Supported
Name And Address
Supported
LOC
NAD
8, 9, 11
CA, CF, CN, OS
45
LOC
Details of transport
Not Supported
46
MOA
Monetary amount
Not Supported
CTA
Contact Information
Not Supported
COM
Communication Contact
Not Supported
DOC
Document/Message Details
Not Supported
DTM
Date/Time/Period
Not Supported
TCC
Transport Charge/Rate Calculations
Not Supported
52
PRI
Price Details
Not Supported
53
EQN
Number of units
Not Supported
54
PCD
Percentage details
Not Supported
55
MOA
Monetary amount
Not Supported
56
QTY
Quantity
Not Supported
RFF
Reference
Not Supported
DTM
Date/Time/Period
Not Supported
CPI
Charge payment instructions
Not Supported
60
CUX
Currencies
Not Supported
61
LOC
Details of transport
Not Supported
62
MOA
Monetary amount
Not Supported
TSR
Transport Service Requirements
Not Supported
64
RFF
Reference
Not Supported
65
LOC
Details of transport
Not Supported
66
TPL
Transport Placement
Not Supported
67
FTX
Free Text
Not Supported
GID
Information about the Packaging of Goods Not Supported
69
HAN
Handling Instructions
Not Supported
70
TMP
Temperature
Not Supported
71
RNG
Range
Not Supported
72
TMD
Transport Movement Details
Not Supported
73
LOC
Details of transport
Not Supported
74
MOA
Monetary amount
Not Supported
75
PIA
Additional product id
Not Supported
76
FTX
Free Text
Not Supported
47
SG12
48
49
SG13
50
51
57
SG14
SG15
58
59
63
68
SG16
SG17
SG18
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
288
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S.No
Group
Segment ID
77
SG19
NAD
Name And Address
Not Supported
78
DTM
Date/Time/Period
Not Supported
79
GDS
Nature Of Cargo
Not Supported
MEA
Measurements
Not Supported
EQN
Number Of Units
Not Supported
DIM
Dimension
Not Supported
EQN
Number Of Units
Not Supported
RFF
Reference
Not Supported
DTM
Date/Time/Period
Not Supported
PCI
Package identification
Not Supported
87
RFF
Reference
Not Supported
88
DTM
Date/Time/Period
Not Supported
DOC
Document/Message Details
Not Supported
DTM
Date/Time/Period
Not Supported
80
SG20
81
82
SG21
83
84
SG22
85
86
89
SG23
SG24
90
Description
Supported in N4?
91
SG25
TPL
Transport placement
Not Supported
92
SG26
MEA
Measurements
Not Supported
EQN
Number of units
Not Supported
SGP
Split goods placement
Not Supported
SEQ
Sequence details
Not Supported
MEA
Measurements
Not Supported
EQN
Number of units
Not Supported
TCC
Transport charge/rate calculations
Not Supported
99
CUX
Currencies
Not Supported
100
PRI
Price Details
Not Supported
101
EQN
Number of units
Not Supported
102
PCD
Percentage details
Not Supported
103
MOA
Monetary amount
Not Supported
104
QTY
Quantity
Not Supported
105
LOC
Details of transport
Not Supported
DGS
Dangerous Goods
Not Supported
FTX
Free Text
Not Supported
CTA
Contact Information
Not Supported
COM
Communication Contact
Not Supported
MEA
Measurements
Not Supported
EQN
Number Of Units
Not Supported
93
94
SG27
95
96
SG28
97
98
106
SG29
SG30
107
108
SG31
109
110
SG32
111
112
SG33
SGP
Split goods placement
Not Supported
113
SG34
MEA
Measurements
Not Supported
EQN
Number Of Units
Not Supported
114
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
289
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S.No
Group
Segment ID
115
SG35
EQD
Equipment Qualifier
Supported
116
EQN
Number Of Units
Supported
117
TMD
Transport Movement Details
Not Supported
118
MEA
Measurements
Supported
119
DIM
Dimension
Not Supported
120
SEL
Seal number
Supported
121
TPL
Transport placement
Not Supported
122
HAN
Handling Instructions
Not Supported
123
TMP
Temperature
Supported
124
FTX
Free Text
Not Supported
TCC
Transport charge/rate calculations
Not Supported
126
PRI
Price Details
Not Supported
127
EQN
Number of units
Not Supported
128
PCD
Percentage details
Not Supported
129
MOA
Monetary amount
Not Supported
130
QTY
Quantity
Not Supported
NAD
Name And Address
Not Supported
DTM
Date/Time/Period
Not Supported
EQA
Attached equipment
Not Supported
EQN
Number of units
Not Supported
DGS
Dangerous Goods
Supported
Free Text
Supported
125
131
SG36
SG37
132
133
SG38
134
135
SG39
AAB, AAO, AAS,
CD, ZO
CA, CU, SH, TO
Supported in N4?
136
FTX
137
CTA
Contact Information
Not Supported
COM
Communication Contact
Not Supported
UNT
Message Trailer
Not Supported
138
139
SG40
AAC, AAD
Description
2.2 IFTMCS - Message Functions
As per EDIFACT standard, IFTMCS has various message function codes in BGM segment and N4 supports the
following message functions are supported
BGM+661+WCP00000530901+9+AB' – Here "9" is the message function qualifier.
Qualifier in the EDI message
Value in the XML
9
2
3
4 or 33
1
5
O - Original
A - Add
E - Delete
U - Change
D - Cancel
X - Replace
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
290
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert IFTMCS Edi message into Navis standard booking xml. This xml in
turn used for further processing.
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How to Configure N4 for IFTMCS?
N/A
4.2 Special Cases
edi:BookingItem mapping
• Added a filter (/EDI/Group_Loop/IFTMCS/SG35/EQD/C237@A_8260==NULL) such that this tag will be displayed
only when the EQD segment has no equipment number.
• Added a match to SG35 loop (EQD Loop)
edi:BookingEquipment and edi:ediContainer mapping
• Added a filter (/EDI/Group_Loop/IFTMCS/SG35/EQD/C237@A_8260!=NULL)such that this tag will be displayed
only when the EQD segment hasequipment number.
• Added a match to SG35 loop (EQD Loop).
4.3 Setting
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for IFTMCS message:
Name
Description
Edit UI
Usage
To change import containers to transship
containers.
ARGOBOOKING001 Import To Tranship
Settings
ARGOBOOKING002 Allow container Update
Create new pre-advised export containers.
Settings Update existing containers to associate them to the
export booking.
ARGOBOOKING003
Allow creation of Foreign
Vessel Visits
Settings
To create a vessel if the vessel specified in a
BOOKING EDI message is not in N4.
5 Samples
UNA:+.? '
UNB+UNOC:3+YUSQTL+YUS+061215:1557+67142 '
UNH+67142+IFTMCS:95B:UN'
BGM+770+67142+9'
DTM+137:200608151855:203'
RFF+BN:BK61'
TDT+20+123+1+YUS++KWD:::KWD'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
291
Part 1: EDI
EDI Message Specifications
EDI Message Types
LOC+9+NZLYT'
LOC+11+HKHKG'
LOC+8+USSEA'
LOC+88+AUMEL'
NAD+CF+YUS'
GID+48+0:BX'
FTX+AAA+++200899'
MEA+AAE+AAB+KGM:15000'
MEA+AAE+AAW+MTQ:0'
EQD+CN+YUSU93036+2200:102:5+1++5'
EQD+CN+2200++5'
EQN+7'
UNT+16+67142'
1.9.3.5 EDI Inbound Cargo Release Message - ANSI 350 00
4020
2.1 Scope
Following table illustrates the segments of the Cargo Release - ANSI 350 00 4020 standard message & scope of each
segment in N4.
S.No.
Segment Id
Description
1
ST
Transaction Header
Yes
2
M10
Manifest Identifying Information
Yes
3
P4
Port Information
No
4
V9
Event Detail
No
5
K1
Remarks
No
6
N9
Reference Identification
No
7
K1
Remarks
No
8
X4
Customs Release Information
Yes
9
K1
Remarks
No
10
N7
Equipment Details
Yes
11
BA1
Export Shipment Identifying Information No
12
X4
Customs Release Information
Yes
13
K1
Remarks
No
12
SE
Transaction Set Trailer
Yes
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Supported?
Mapped Elements
Vessel visit, Release type
Bill Of Lading number, Release
Quantity
Container Id
Bill Of Lading number, Release
Quantity
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
292
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.6 EDI Inbound Container Release Order Message COREOR D 95B
Purpose
This specification provides the definition of the Container Release Order Message (COREOR) to be used in Electronic
Data Interchange (EDI) between shipping agent and the terminal.
Functional Definition
COREOR is
• Container Release Order Message
• A notification from Shipping Line to Terminal about an order to release a containe
• Used to release of full containers, either for export or for release.
• Optionally used to release empty transport equipment prior to packing.
1.1 Objective
The following sections of this document explain how COREOR message is handled in N4 and scope of its
implementation.
In Terminal, the COREOR will be received from the shipping agent.
1.2 COREOR Message (COREOR D 95B)
N4 supports EDIFACT standard COREOR message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard COREOR D 95B message & scope of each segment in
N4.
S.No
Group
Segment
ID
Supported
Qualifier
Description
Supported
in N4?
UNB
Interchange
Header (sender, Supported
receiver)
UNH
Message
Header
(message type,
id, version,
Supported
release number,
message
reference
number)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Mapped Elements
Reason/
Comments
Sender Identification -->
InterchangeSender and
InterchangeReceipient
Sender is
identified by
the contents
of the
interchange
Interchange Control
Reference -->
InterchangeNumber
ID, Version,
Release
Number is
identified by
the contents
of the
interchange
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
293
Part 1: EDI
S.No
Group
EDI Message Specifications
EDI Message Types
Segment
ID
SG2
SG3
SG4
Description
Supported
in N4?
Mapped Elements
BGM
Beginning of
message
Supported
FTX
Free Text
Not
Supported
Reference
Supported
Reference Number -->
pinNbr
a) Conveyance
Reference Number -->
inVoyageNbr
b) Transport Identification
--> Vessel Id, Name and
Convention
c) Carrier -->
ediShippingLine element
details
RFF
SG1
Supported
Qualifier
REO
msgFunction and
ediCode
TDT
Details of
Transport
Supported
RFF
Reference
Not
Supported
LOC
Location
Not
Supported
DTM
Date/Time
Supported
Date/Time -->
estimatedTimeArrival
Name and
Address
Supported
shippingLine element
CTA
Contact
information
Not
Supported
RFF
Reference
Supported
DTM
Date/Time
Not
Supported
GID
Goods Item
Details
Not
Supported
HAN
Handling
instructions
Not
Supported
FTX
Free Text
Not
Supported
NAD
Name and
Address
Not
Supported
DTM
Date/Time
Not
Supported
NAD
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
CA
Reason/
Comments
msgFunction
is not
handled as
of now but
we mapped
so that it can
be used in
the future if
needed.
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
294
Part 1: EDI
S.No
Group
SG5
SG6
SG7
EDI Message Specifications
EDI Message Types
Segment
ID
Supported
Qualifier
Description
Supported
in N4?
RFF
Reference
Not
Supported
MEA
Measurement
Not
Supported
PCI
Package
Information
Not
Supported
SGP
Split Goods
Placement
Not
Supported
MEA
Measurement
Not
Supported
DGS
Dangerous
Goods
Not
Supported
FTX
Free Text
Not
Supported
MEA
Measurement
Not
Supported
Equipment
Details
EQD
RFF
SQ, TF,
AEL, ZZZ
Supported
Reference
Supported
TSR
Transport
Service
Requirements
Not
Supported
MEA
Measurement
Not
Supported
DIM
Dimensions
Not
Supported
TMP
Temperature
Not
Supported
RNG
Range Details
Not
Supported
SEL
Seal Number
Not
Supported
FTX
Free Text
Not
Supported
EQA
Attached
Equipment
Not
Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Mapped Elements
Reason/
Comments
a) Equipment
Identification Number -->
releaseIdentifierNbr
b) Equipment Status,
Coded -->
releaseIdentifierCategory
releaseReferenceId
Check for the
value in the
following
order AEL
(or) ZZZ (or)
SQ (or) TF
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
295
Part 1: EDI
S.No
Group
SG8
SG9
EDI Message Specifications
EDI Message Types
Segment
ID
Supported
Qualifier
Description
Supported
in N4?
TDT
Details of
Transport
Supported
LOC
Location
Not
Supported
DTM
Date/Time
Not
Supported
NAD
Name and
Address
Supported
DTM
Date/Time
Not
Supported
CTA
Contact
information
Not
Supported
COM
Communication Not
contact
Supported
CNT
Control Total
Not
Supported
UNT
Message Trailer
Not
Supported
UNZ
Interchange
Trailer
Not
Supported
Mapped Elements
Reason/
Comments
ediTruckingCompany
2.2 COREOR - Message Functions
As per EDIFACT standard, COREOR has various message function codes in BGM segment. But N4 supports similar to
other EDI messages (Original & Update function codes i.e create/update). As per Line Operator, Message functions
are indicated in EDI files as CANCEL (code 1) and REPLACE (5) for COREOR along with ORIGINAL (9).
2.2.1 REPLACE
Units which are not sent in Replace message but already attached to the IDO should be detached from IDO and
UNIT_CANCEL_RESERVE event should be logged. If Unit is already Departed or currently being delivered (unit in
ECOUTE status) against the IDO, appropriate error message will be thrown.
BGM code 5 Original -> mapped as X
2.2.2 CANCEL
The Attached unit should be detached from IDO and UNIT_RESERVE event should be logged. if Unit is already
Departed or currently being delivered(unit in ECOUT status) agaisnt the IDO, appropriate error message will be thrown.
If there are no units attached to the IDO, the IDO should be deleted. The hold/permission applied to the unit based on
the Original COREOR message should be reverted i.e. Hold should be restored or permission should be revoked.
BGM code 1 Original -> mapped as D
2.3 Schema Changes
No schema change is done in cusres.xsd schema file to support COREOR D 95B EDI posting.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
296
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.4 Pre-requisites
The following section lists the pre-requisites for setting up and testing a COREOR message using COREOR EDI
message to release/hold a container in N4.
Required fields in the XML
• msgClass attribute values should be "RELEASE"
• msgTypeId attribute value should align with the Message Type ID defined in the N4 (example: COREOR)
• releaseIdentifierType attribute value should be "UNITRELEASE"
• ediCode attribute value. Currently the following assumption is made in the mapping. The customer needs to create
their custom maps and map the values accordingly.
▪ if BGM - 1225 - message function code is 1 --> LINEHLD (LINE HOLD which is defined in N4 in holds/
permissions UI)
▪ if BGM - 1225 - message function code is other than 1 --> RELEASE (RELEASE which is defined in N4 in holds/
permissions UI)
• releaseReferenceId attribute value is set as follows
▪ Pick from RFF+AEL segment - 1154 - if found (else)
▪ Pick from RFF+ZZZ segment - 1154 - if found (else)
▪ Pick from RFF+SQ segment - 1154 - if found (else)
▪ Pick from RFF+TF segment - 1154 - if found.
• releaseIdentifierCategory attribute is set based on the EQD - Equipment Status element (2 - EXPRT, 3 - IMPRT, 6 TRSHP and THRGH if nothing specified)
Other Requirements
• The customer needs to create a EDI Release Map for the specified ediCode (Example: LINEHLD for hold and
RELEASE for release)
• Trucking company should exist in the system if it is provided
• The flag type used for the EDI code should be applies only to "UNIT" entity
• Line operator should exist in the system if it is provided
• Shipping line should be mapped to release shipping line element. (Note: The user should not map to ediVesselVisit shipping line element as it is not used).
• Enable the "Use PIN Number in Delivery" checkbox in Line Operator UI if the pin number needs to be posted. Else
the system will throw the below error "attempted to set PIN number when the line doesn't support PIN
Unit[INKU2584149:2ADVISED:IMPRT:FCL:]"
Other Optional Requirements
• Vessel visit should exist in the system for the given details and the specified configuration (EDI Release Map). Need
to enable the AutoCreationOfVesselVisit setting if the vessel visit needs to be created for the given details if not
found.
• Provide the vesselCallFacility details if it refers to the facility at which the vessel(Inbound/Outbound) actually calls
• Enable the setting "RLS_VALIDATE_LINE_OPERATOR " to true so that line is validated to release the Unit. By
default the setting is set to false.
• Enable the setting "RLS_VALIDATE_UNIT_IN_YARD" to validate whether the specified unit is in Yard. If the setting
is set it to true the unit must exist in the system
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
297
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert COREOR Edi message into Navis standard manifest xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• coreor_D_95B.mgt - GoXml map
• coreor.dic - Edifact standard dictionary
• cusres.xsd - Navis standard release xml schema
UI Navigation: Administration > EDI > Message Types
4.1 How to Configure N4 for COREOR?
N4 needs to be set up to process an incoming COREOR message. As COREOR is responsible to Hold/Release
containers, there may be few rules to be defined based on particular user's business requirement.
To process COREOR:
1. Create a Hold/Permission (Configuration - Services - Holds/Permissions).
2. Open COREOR message type in "Message Types" UI and go to "Release Map" tab.
3. Add a mapping to the Hold/Permission with unique Map CodeRelease Xml message should contain the Map Code
in "/releaseTransactions/releaseTransaction@ediCode" attribute.
4. N4 identifies the Hold/Permission to be applied using the Map Code
4.1.1 EDI Release Map
As per EDIFACT standard, customs may send delivery instructions as Edi codes in Cusres Edi. In N4, release map is a
way of mapping those Edi codes to N4 specific Hold/Permission flags.
4.2 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for COREOR EDI message:
Name
RLS_VALIDATE_LINE_OPERATOR
Description
Validate Line is
allowed to release
the Unit
Edit UI
Session Settings
Usage
The given line operator and the
unit's line operator should
match else the system will
throw an error.
Allow auto creation
Session RLS_ALLOW_FOREIGN_VESSEL_VISIT
of foreign vessel visit Settings
N4 creates vessel visit on the
fly if the vessel visit referred in
COREOR is not present in N4
& this setting is set to TRUE.
Validate whether unit Session is in Yard
Settings
If the setting is set it to true the
unit must exist in the system
and should be in yard.
RLS_VALIDATE_UNIT_IN_YARD
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
298
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.7 EDI Inbound Customs Cargo Report Message CUSCAR D 95B
Purpose
This specification provides the definition of the Customs Cargo Report message (CUSCAR) to be used in Electronic
Data Interchange (EDI) between shipping agent and Customs department.
Functional Definition
CUSCAR is
• Customs Cargo Report
• International multimodal status report message
• Transfer of data from a carrier to a Customs administration for the purpose of meeting Customs cargo reporting
requirements
• The data provides Customs with a means of "writing off" or acquitting the cargo report against Goods declarations.
• It also allows Customs to undertake selectivity processing in order to select high risk shipments requiring
examination.
• The Customs Cargo Report is primarily used by Shipping Companies and Airlines to report full details of cargo
carried on vessels
• The message may be used for reporting: (a) onward transit/transhipment; (b) short and part shipped goods; (c)
empty containers; (d) import/export cargo; (e) house and masterbill relationships
• The ship’s agent sends it to Customs.
1.1 Objective
The following sections of this document explain how CUSCAR message is handled in N4 and scope of its
implementation.
In Terminal, the CUSCAR will be received from the shipping agent.
1.2 CUSCAR Message (CUSCAR D 95B)
N4 supports EDIFACT standard CUSCAR message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard CUSCAR D 95B message & scope of each segment in
N4.
Group
Segment
ID
Supported
Qualifier
UNB
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Description
Interchange
Header
(sender,
receiver)
Supported in N4?
Supported
Mapped Elements
Interchange Control
Reference >
InterchangeNumber
Reason /
Comments
Sender is identified by
the contents of the
interchange
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
299
Part 1: EDI
Group
EDI Message Specifications
EDI Message Types
Segment
ID
Supported
Qualifier
Supported in N4?
Mapped Elements
Reason /
Comments
UNH
Message
Header
(message type,
id, version,
Supported
release
number,
message
reference
number)
ID, Version, Release
Interchange Number > Number is identified by
msgReferenceNbr
the contents of the
interchange
BGM
Beginning of
message
9 message reference
number
DTM
137
RFF
NAD
MS
FTX
SG1
Description
Date/Time
Not Supported
Reference
Not Supported
Sender of the
message
Not Supported
Free Text
Not Supported
Details of
Transport
TDT
Supported
Supported
LOC
60
Place of Arrival Not Supported
DTM
132
Date/Time
Supported
General
Indicator
Not Supported
GIS
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
We are handling only
original message
function in CUSCAR
EDI.
msgProducedDateTime
is handled in EDI
extract and set as
current date.
Customer needs to use
the generic / dynamic
flex field if needed to
store the date.
a) Conveyance
Reference Number >
inVoyageNbr
b) Carrier Identification
> shippingLine
c) ID means of
transport > Vessel Id,
Name and Convention
We will resolve it by
facility id. The
customer needs to
handle in the custom
map.
a) Data/Time > vessel
visit estimatedTimeArrival
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
300
Part 1: EDI
Group
SG2 SG3
EDI Message Specifications
EDI Message Types
Segment
ID
EQD
Supported
Qualifier
CN
TSR
MEA
AAE + G
AAE + T
DIM
SEL
SG3
Description
Supported in N4?
Equipment
Details
Supported
Transport
Service
Requirements
Not Supported
Supported
Measurement
Supported
a) measurement unit
value containerTareWt
b) measurement unit
qualifier containerTareWtUnit
Dimensions
Not Supported
Measurement
Supported
NAD
Name and
Address
Not Supported
GIS
General
Indicator
Not Supported
TMP
Temperature
Not Supported
RNG
Range Details
Not Supported
CNT
Control Total
Not Supported
CNT
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Consignment
Information
Not Supported
Control Total
Not Supported
Reason /
Comments
a) Equipment
Identification Number containerNbr
b) Equipment Size/
Type containerISOcode
c) Equipment Status Container Category
d) Full/Empty indicator
- Container Status
a) measurement unit
value containerGrossWt
b) measurement unit
qualifier containerGrossWtUnit
CA, CU, SH
SG4 (SG4
CNI
- SG12)
Mapped Elements
a) CA containerSealNumber1
b) SH containerSealNumber2
c) CU containerSealNumber3
Loop starts from CNI
segment
RFF + BM segment is
a mandatory segment
and we can get the Bill
Of Lading Number from
the same
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
301
Part 1: EDI
Group
EDI Message Specifications
EDI Message Types
Segment
ID
SG5 (SG5
RFF
- SG12)
SG6
SG10
(SG10 SG12)
Supported in N4?
Supported
CNT
Control Total
Not Supported
MOA
Monetary
Amount
Not Supported
LOC
8, 9, 11, 76
Location
Supported
LOC
20, 28, 80
Location
Not Supported
GIS
General
Indicator
Not Supported
CUX
Currencies
Not Supported
CPI
Charge
payment
instructions
Not Supported
TDT
Details of
Transport
Not Supported
LOC
Location
Not Supported
DTM
Date/Time
Not Supported
RFF
Reference
Not Supported
Name and
Address
Supported
CN, CZ
Name and
Address
Not Supported
RFF
Reference
Not Supported
CTA
Contact
information
Not Supported
COM
Communication
Not Supported
contact
QTY
Quantity
Not Supported
FTX
Free Text
Not Supported
NAD
SG9
BM
Description
Reference
SG7 (SG7
NAD
- SG8)
SG8
Supported
Qualifier
IV, FW, N1,
N2
GID
Goods Item
Details
Supported
PAC
Package
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Mapped Elements
Reason /
Comments
Bill Of Lading Number
Mapped with BL - port
informations
8 - Destination, 9 Load, 11 - Discharge, ,
76 - Origin
CN - Consignee
CZ - Shipper
IV - Invoicee, FW Freight forwarder
N1- Notify Part1, N2Notify Party2
Customer needs to
use the flex fields if
needed.
BlItem Holder loop
starting segment
GID+1+63:BALES
63- blitem quantity
Bales - blitem type
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
302
Part 1: EDI
Group
EDI Message Specifications
EDI Message Types
Segment
ID
Supported
Qualifier
HAN
SG12
SG13
Supported in N4?
Handling
instructions
Not Supported
Supported
FTX
AAA
Free Text
MEA
AAE
Measurements Supported
MOA
SG11
Description
Monetary
amount
Mapped Elements
Reason /
Comments
commodityNote
blItem volume and
weight
Not Supported
SGP
Split Goods
Placement
Supported
DGS
Dangerous
Goods
Supported
PCI
Package
Information
Supported
CST
Customs
Status Of
Goods
Not Supported
GIS
General
Indicator
Not Supported
DOC
Document /
Message
Details
Not Supported
QTY
Quantity
Not Supported
FTX
Free Text
Not Supported
AUT
Authentication
result
Not Supported
DTM
Date/Time
Not Supported
RFF
Reference
Not Supported
UNT
Message
Trailer
Not Supported
UNZ
Interchange
Trailer
Not Supported
Added a new attribute
quantity in
ediBlEquipment
element to store the
value.
ediBlItem - ediHazard
ediBlItem markNumber
Only one field in the
DB model to map
marks. We will
concatenate all the
marks and truncate it if
the size is more than
240
2.2 CUSCAR - Message Functions
We support "original" message function as per the CUSCAR D 95B message i.e similar to other EDI messages N4 will
do create/update (original/update).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
303
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.3 Schema Changes
The following schema changes were made to support CUSCAR:
• Added new ediEquipment element of complexType "ediEquipmentDetail" under blTransactions element to create
units for the given details (top level EQDs)
• Added "packageType" element and added "customerOrderNbr" attribute to ediBlItem complexType.
• Added a new "ediBlEquipment" element under "ediBlItem" element to manifest bl item in the specified containers
2.4 Pre-requisite
Following are some pre-requisites for using CUSCAR in N4:
• Few EDI files are using special character - apostrophe as segment terminator. The special character is also coming
within the data. Ex: FTX+AAA+++MEN?' S SHIRT'. UNA comes with override character. The customer needs to
remove the character using load interceptor groovy.
• Update message function (ex: update) will not be handled in CUSCAR.
• Commodity codes are mandatory to create a BL item but it will not be specified in the CUSCAR. So we added
a dummy commodity code which starts with "FAK" in the built-in map. The customer needs to create a custom map
to have their own commodity codes for each Bl item.
3 N4 Built-in Map
N4 serves a built-in map which is used to convert CUSCAR Edi message into Navis standard manifest xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• cuscar_D_95B.mgt - GoXml map
• cuscar.dic - Edifact standard dictionary
• manifest.xsd - Navis standard manifest xml schema
UI Navigation: Administration > EDI > Message Types
1.9.3.8 EDI Inbound Customs Response Message - CUSRES
D 96B
Purpose
This specification provides the definition of the Customs response message (CUSRES) to be used in Electronic Data
Interchange (EDI) between Customs department & a terminal in marine domain.
Functional Definition
This Customs Response Message (CUSRES) permits the transfer of data from a customs administration:
• To acknowledge the receipt of the message
• To indicate whether the information received is correct or if there are errors (i.e. accepted without errors, accepted
with errors, rejected, etc.)
• To inform the sender of the status of the customs declaration (i.e. goods released, goods for examination,
documents required, etc.)
• To transmit additional information as agreed between parties (i.e. tax information, quantity information, etc.)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
304
Part 1: EDI
EDI Message Specifications
EDI Message Types
• To respond to batched messages (i.e. CUSDEC, CUSCAR, CUSREP, CUSEXP).
1.1 Objective
The following sections of this document explain how CUSRES message is handled in N4 and scope of its
implementation.
In a terminal, CUSRES EDI is received from Customs Department. This can result following effects in N4:
• Place a Hold(s) for container(s) & Bill of Lading
• Release Hold(s) for container(s) & Bill of Lading
• Grant Permission(s) for container(s) & Bill of Lading
• Revoke Permission(s) for container(s) & Bill of Lading
A CUSRES EDI may contain:
• List of containers
• List of Holds/Permissions
• Vessel visit information
1.2 CUSRES Message (CUSRES D 96B)
N4 supports EDIFACT standard CUSRES message, release D & version 96B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard CUSRES D 96B message & scope of each segment in
N4.
S. No. #
Segment ID
Supported Qualifier
Description
Supported in N4?
1
BGM
Beginning of message
Supported
2
DTM
Date/time/period
Not Supported
3
FTX
Free text
Supported
4
TDT
Details of transport
Supported
5
LOC
Place/location identification
Not Supported
6
GIS
General indicator
Supported
7
EQD
Equipment details
Not Supported
8
NAD
Name and address
Not Supported
9
CTA
Contact information
Not Supported
10
COM
Communication contact
Not Supported
11
RFF
Reference
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
DIN
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
305
Part 1: EDI
S. No. #
EDI Message Specifications
EDI Message Types
Segment ID
Supported Qualifier
Description
Supported in N4?
12
DTM
Date/time/period
Not Supported
13
LOC
Place/location identification
Not Supported
14
ERP
Error point details
Not Supported
15
RFF
Reference
Not Supported
16
ERC
Application error information
Not Supported
17
FTX
Free text
Not Supported
18
TAX
Duty/tax/fee details
Not Supported
19
MOA
Monetary amount
Not Supported
20
GIS
General indicator
Not Supported
21
DOC
Document/message details
Not Supported
22
PAC
Package
Not Supported
23
RFF
Reference
Not Supported
24
PCI
Package identification
Not Supported
25
FTX
Free text
Supported
26
TDT
Details of transport
Not Supported
27
LOC
Place/location identification
Not Supported
28
DTM
Date/time/period
Not Supported
29
GIS
General indicator
Not Supported
30
MEA
Measurements
Not Supported
31
EQD
Equipment details
Supported
32
NAD
Name and address
Not Supported
33
CTA
Contact information
Not Supported
34
COM
Communication contact
Not Supported
35
MOA
Monetary amount
Not Supported
36
CUX
Currencies
Not Supported
37
CST
Customs status of goods
Not Supported
38
FTX
Free text
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
CN
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
306
Part 1: EDI
S. No. #
EDI Message Specifications
EDI Message Types
Segment ID
Supported Qualifier
Description
Supported in N4?
39
TAX
Duty/tax/fee details
Not Supported
40
MOA
Monetary amount
Not Supported
41
GIS
General indicator
Not Supported
42
MEA
Measurements
Not Supported
43
RFF
Reference
Not Supported
44
ERP
Error point details
Not Supported
45
RFF
Reference
Not Supported
46
ERC
Application error information
Not Supported
47
FTX
Free text
Not Supported
48
CNT
Control total
Not Supported
2.2 CUSRES - Message Functions
As per EDIFACT standard, CUSRES has various message function codes in BGM segment. But N4 supports only
Original & Update function codes.
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert CUSRES EDI message into Navis standard release xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• CUSRES_D_96B.mgt - GoXml map
• CUSRES.dic - EDIFACT standard dictionary
• release.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How To Configure N4 For CUSRES?
N4 needs to be set up to process an incoming CUSRES message. As CUSRES is responsible to Hold/Release
containers, there may be few rules to be defined based on particular user's business requirement.
Following are preliminary steps need to be followed for a typical scenario to process CUSRES: Create a Hold/
Permission (Configuration > Services > Holds/Permissions).Open CUSRES message type in "Message Types" UI and
go to "Release Map" tab.Add a mapping to the Hold/Permission with unique Map CodeRelease Xml message should
contain the Map Code in "/releaseTransactions/releaseTransaction@EDICode" attribute.N4 identifies the Hold/
Permission to be applied using the Map Code
• Create a Hold/Permission (Configuration ' Services ' Holds/Permissions).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
307
Part 1: EDI
EDI Message Specifications
EDI Message Types
• Open CUSRES message type in "Message Types" UI and go to "Release Map" tab.
• Add a mapping to the Hold/Permission with unique Map Code
• Release Xml message should contain the Map Code in "/releaseTransactions/releaseTransaction@EDICode"
attribute.
• N4 identifies the Hold/Permission to be applied using the Map Code
4.1.1 EDI Release Map
As per EDIFACT standard, customs may send delivery instructions as EDI codes in CUSRES EDI. In N4, release map
is a way of mapping those EDI codes to N4 specific Hold/Permission flags.
4.2 Special Cases
In this Section:
4.2.1 Multiple Containers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
4.2.2 Apply Multiple Holds/Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
4.2.3 Release Containers Against Bill of Lading (BL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
308
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Multiple Containers
As CUSRES EDIFACT standard supports multiple containers, Navis standard release schema is designed to handle
multiple containers as well. If CUSRES EDI has information about multiple containers, N4 converts the EDI using the
built-in map into Navis standard release xml with the following element repeated:
/releaseTransactions/releaseTransaction/EDIReleaseIdentifier
4.2.2 Apply Multiple Holds/Permissions
CUSRES message can be used to process more than one Hold/Permission for a container. Navis standard release
schema supports by repeating the following element:
/releaseTransactions/releaseTransaction/EDIAdditionalEDICodes
This particular element is referred to "master additional codes" as these Holds/Permissions are applied to all the
containers given in the message.
There is one more element at container level and it can also be repeated to specify more than Hold/Permission. This
applies to the particular container only, even if the message contains more than one container, so it's referred to "child
additional codes": /releaseTransactions/releaseTransaction/EDIReleaseIdentifier/EDIAdditionalEDICodes
4.2.3 Release Containers Against Bill of Lading (BL)
CUSRES can be used to release a bunch of containers grouped as one BL. In this case, CUSRES will not have any
specific container identification; instead, it specifies the BL number and the number of containers that are released at
the moment. In this way, Customs may send more than one CUSRES EDI for same BL with some number of
containers to be released. N4 keeps track of the number container being released for a BL and releases the whole BL
when the sum of all the released containers (Released Quantity) equals the original number (Manifested Quantity) of
containers of the BL.
N4 uses the Navis standard release schema for both Unit Release & BL Release. Following are the key factors that
differentiate the type of release:
• /releaseTransactions/releaseTransaction@releaseIdentifierType element in release xml message should be set to
"BLRELEASE"
• /releaseTransactions/releaseTransaction/EDIReleaseIdentifier@releaseIdentifierNbr should specify the BL number
to be released
4.3 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for CUSRES message:
Name
Description
EDIt UI
ARGORELEASE002
Allow auto creation of
foreign vessel visit
CGOCargoRelease001
BL Hold that is managed
Settings
by quantity
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI
Session
Usage
N4 creates vessel visit on the fly if the vessel
visit referred in CUSRES is not present in N4
& this setting is set to TRUE.
This should be set to the Id of the particular
Hold/Permission which is applied to the BL
when its released
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
309
Part 1: EDI
EDI Message Specifications
EDI Message Types
5 Samples
5.1 CUSRES EDI with One Container
UNB+UNOA:2+CUSMOD:ZZZ+PORTNZAKL:ZZZ+040924:1503+IRN108564'
UNH+TRN598194+CUSRES: D:96B:UN+SRN481241'
BGM+932+41310649:01'
TDT+20+V93N+1+++++:::FENG YUN HE'
GIS+846:120:143'
DOC+25'
EQD+CN+IPXU3207389++++5'
UNT+7+TRN598194'
UNZ+1+IRN108564'
5.2 CUSRES EDI with Multiple Containers
UNB+UNOA:2+CUSMOD:ZZZ+PORTNZAKL:ZZZ+040924:1503+IRN108564'
UNH+TRN598194+CUSRES: D:96B:UN+SRN481241'
BGM+932+41310649:01'
TDT+20+V93N+1+++++:::FENG YUN HE'
GIS+846:120:143'
DOC+25'
EQD+CN+IPXU3207389++++5'
DOC+26'
EQD+CN+IPXU3325389++++5'
UNT+7+TRN598194'
UNZ+1+IRN108564'
5.3 CUSRES EDI with Master Additional Codes
UNB+UNOA:2+CUSMOD:ZZZ+PORTNZAKL:ZZZ+040924:1503+IRN108564'
UNH+TRN598194+CUSRES: D:96B:UN+SRN481241'
BGM+932+41310649:01'
FTX+DIN+++225'
FTX+DIN+++226'
TDT+20+V93N+1+++++:::FENG YUN HE'
GIS+846:120:143'
DOC+25'
EQD+CN+IPXU3207389++++5'
UNT+7+TRN598194'
UNZ+1+IRN108564'
5.4 CUSRES EDI with Master & Child Additional Codes
UNB+UNOA:2+CUSMOD:ZZZ+PORTNZAKL:ZZZ+040924:1503+IRN108564'
UNH+TRN598194+CUSRES: D:96B:UN+SRN481241'
BGM+932+41310649:01'
FTX+DIN+++225'
FTX+DIN+++226'
TDT+20+V93N+1+++++:::FENG YUN HE'
GIS+846:120:143'
DOC+25'
FTX+DIN+++327'
FTX+DIN+++328'
EQD+CN+IPXU3207389++++5'
UNT+7+TRN598194'
UNZ+1+IRN108564'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
310
Part 1: EDI
EDI Message Specifications
EDI Message Types
6 Test Instructions
6.1 CUSRES - Unit Release
The following section explains how to setup & test a Customs Release using CURES EDI message to release a
container in N4. Considering the sample EDI given in section 5.1, which is a typical case, following are the
prerequisites & results to be noted.
6.1.1 Pre-requisite
1. In N4 a Release is represented as Permission Flag type & it can be created in Holds/Permissions UI.
"Reference ID Required" checkbox mandates a reference/note to be attached whenever the particular
permission is granted or cancelled. For CUSRES, N4 assigns the highlighted (BGM+932+41310649:01)
element as reference id.
2. In Message Types UI, for CUSRES message, the above permission should be mapped to a respective EDI code
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
311
Part 1: EDI
EDI Message Specifications
EDI Message Types
that Customs may send in EDI. For the sample 5.1, the permission should be mapped to the code '846'. This is
done in "Release Map" tab.
The two fields "Match Unit By" & "Guardian" are used to identify specified container without any ambiguity.
As Customs Release is crucial for delivering the container out of the terminal, N4 is intelligent enough to let
the user configure the selection criteria. More information about those individual fields is available on product
help.
6.1.2 Posting CUSRES EDI
1. An EDI session should be set up in "EDI Configuration" UI with following values:
▪ Message class: RELEASE
▪ Map: CUSRES_IN (N4 Built in map for CUSRES)
2. CUSRES EDI can be posted either thro' "EDI Load" UI or scheduled jobs in "EDI Jobs" UI against the EDI session.
6.1.3 Effects of CUSRES EDI in N4:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
312
Part 1: EDI
EDI Message Specifications
EDI Message Types
Once the CUSRES EDI is processed successfully in N4 there are possible consequences to be noted.
1. N4 grants the particular permission identified by the EDI code in CUSRES thro' Release Map to the given unit.
Unit also has the reference id recorded for the particular permission. If EDI has additional codes (refer
samples 5.3 & 5.4) N4 applies those permissions as well and can be verified here.
6.1.4 Service Business Rules
CUSRES EDI is just a list of containers that are declared to be released. Once a container has customs release
permission granted it can be delivered. But nothing stops a container being delivered without Customs release
permission. So to mandate the customs release N4 has a way of defining the rules. This is achieved thro' Service
Business Rules (UI Navigation: Configuration -> Services -> Service Business Rules).
For the above case, a Service business rule could be set up as follows:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
313
Part 1: EDI
EDI Message Specifications
EDI Message Types
Once this rule is setup no container could be delivered without "CUSTOMS_RELEASE" granted.
6.2 CUSRES - BL Release
6.2.1 Pre-requisite
1. A permission should be setup thro' Holds/Permissions UI.
2. Permission should be configured as to be applicable for Bill of Lading.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
314
Part 1: EDI
EDI Message Specifications
EDI Message Types
3. In Message Types UI, for CUSRES message, the above permission should be mapped to a respective EDI code
that Customs may send in EDI. This is done in "Release Map" tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
315
Part 1: EDI
EDI Message Specifications
EDI Message Types
4. In Settings UI, the "RELEASE_BY_QTY_FLAGTYPE" should be set to the permission id created in step-1.
6.2.2 Posting CUSRES EDI
1. An EDI session should be set up in "EDI Configuration" UI with following values:
▪ Message class: RELEASE
▪ Map: N/A (At present does not provide a Built in map for BL release using CUSRES)
Given this restriction, BL release can be done only in XML. But, a custom map should be created from N4
built-in CUSRES map, it should be able set the following values:
▪ /releaseTransactions/releaseTransaction@releaseIdentifierType should be mapped to constant "BLRELEASE"
▪ /releaseTransactions/releaseTransaction@releaseQty should be set to the number of containers being released
against a particular bill of lading at that moment. Customs should send this value in the EDI.
2. If such Custom map is available then it can be imported into N4 and used in the EDI session.
3. CUSRES EDI can be posted either thro' "EDI Load" UI or scheduled jobs in "EDI Jobs" UI against the EDI session.
6.2.3 Effects of CUSRES EDI in N4
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
316
Part 1: EDI
EDI Message Specifications
EDI Message Types
Once BL release EDI is processed successfully in N4 there are possible consequences to be noted.
N4 adds a BL release record for each BL release message received form Customs & released quantity is also
recorded. This can be verified in "BL Releases" sub panel under a particular bill of lading.
When the total released quantity exceeds the manifested quantity N4 grants release permission for that particular bill of
lading, which in turn releases all the containers attached to that BL.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
317
Part 1: EDI
EDI Message Specifications
EDI Message Types
6.2.4 Service Business Rules
When Customs release is practiced as BL release then there is no need of permission at individual container level. So
if an Import container has to be delivered then the BL to which the container is attached, should have a valid released
permission granted. To mandate such restriction a business rule should be set as shown below in Service Business
Rules (UI Navigation: Configuration --> Services --> Service Business Rules).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
318
Part 1: EDI
EDI Message Specifications
EDI Message Types
Once this rule is setup no container could be delivered without "CUSTOMS_RELEASE_BL" is granted for the related
Bill of Lading.
1.9.3.9 EDI Inbound Discharge List Message - COPRAR D 95A
Purpose
This specification provides the definition of the COPRAR D 95A Inbound Discharge List message to be used in
Electronic Data Interchange (EDI) between a line operator and a marine terminal, primarily to indicate which containers
should be discharged from the vessel.
Functional Definition
• This COPRAR Discharge List message (COPRAR D 95A) permits the transfer of data from a line operator to a
terminal operator.
• The line operator will send the following details to a terminal operator:
▪ Inbound vessel visit details
▪ Container details
▪ Equipment order details
▪ Hazard and commodity details
1.1 Objective
The following sections of this document explain how COPRAR D 95A Discharge message is handled in N4 and the
scope of its implementation. This message is basically used for the following operations carried out by the terminal/line
operators:
• The line operator will send the inbound vessel visit details to a terminal operator.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
319
Part 1: EDI
EDI Message Specifications
EDI Message Types
• The terminal operator will discharge the containers specified in the EDI message sent by a line operator.
1.2 Inbound Discharge List message (COPRAR D 95A)
N4 supports EDIFACT standard COPRAR Discharge message, release D and version 95A
UI Navigation: Administration > EDI > Message Types
2.1 Scope
The following table illustrates the segments of EDIFACT standard COPRAR D 95A message and the scope of each
segment in N4.
S.No
Group
Supported
Qualifier
Segment ID
Description
Supported in N4?
1
UNB
Interchange Header (sender, receiver)
Supported
2
UNH
Message Header (message type,
message reference number)
Supported
3
BGM
Beginning of message (message function) Supported
4
FTX
Free text
Not Supported
5
RFF
Reference
Not Supported
TDT
Details Of Transport (I/B vessel details)
Supported
7
RFF
Reference
Not Supported
8
LOC
11, 9
Place/Location Identification
Supported
9
DTM
132, 133
Estimated Time Arrival/Departure of I/B
vessel (132/133)
Supported
10
FTX
Free text
Not Supported
Name And Address
Supported
Contact Information
Not Supported
6
11
SG1
SG2
12
13
NAD
CA, CF
CTA
SG3
EQD
CN
Equipment Details
Supported
14
RFF
BN, AAY, ABT
Reference
Supported
15
EQN
Number Of Units
Not Supported
16
TMD
Transport Movement Details
Not Supported
17
DTM
Date/Time/Period
Not Supported
18
LOC
Place/Location Identification (delivery,
destination, discharge)
Supported
19
MEA
20
DIM
21
2, 3, 4, 5
7, 9, 11, 147
Measurement (gross weight), Tare Weight Supported
Dimensions (front, back, right, left, top)
Supported
TMP
Temperature (preferred temperature)
Supported
22
RNG
Range (Minimum, Maximum)
Supported
23
SEL
CA, CU, QA, SH
Seal Number (carrier, customs,
quarantine, shipper)
Supported
24
FTX
AAA
Free Text (goods description, handling
instructions
Supported
25
DGS
Dangerous Goods
Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
5, 6, 7, 8, 9
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
320
Part 1: EDI
S.No
Group
EDI Message Specifications
EDI Message Types
Supported
Qualifier
Segment ID
Description
Supported in N4?
Attached Equipment (chassis, reefer
generator)
Supported
TDT
Details Of Transport (Outbound - truck/
train/vessel details)
Supported
28
RFF
Reference
Not Supported
29
LOC
Place/Location Identification
Not Supported
30
DTM
Date/Time/Period (Estimated Time Arrival
of I/B Vessel Visit)
Not Supported
31
NAD
Name And Address (Container Operator)
Supported
32
CNT
Control Total
Not Supported
33
UNT
Message Trailer
Not Supported
26
27
EQA
SG4
CH, RG
2.2 COPRAR - Message Functions
As per EDIFACT standard, COPRAR has various message function codes in the BGM segment. N4 supports the
following message functions:
BGM+661+WCP00000530901+3+AB' – Here, '3' is the message function qualifier.
Qualifier in the EDI message
Value in the XML
1 or 3
Any Other Qualifier
D - Delete
Default Behavior
3.1 N4 Built-in Map
N4 serves a built-in map for converting COPRAR EDI message into the Navis standard discharge list xml. This XML, in
turn, is used for further processing.
Following are the related files that can be downloaded as part of N4:
• coprar(discharge)_D_95A.mgt - GoXml map
• coprar.dic - EDIFACT standard dictionary
• dischlist.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
edi:ediOutboundVesselVisit
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='1') such that it will be displayed only
when the SG4 TDT has qualifer "1" (maritime transport)
edi:ediTrainVisit
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='2') such that it will be displayed only
when the SG4 TDT has qualifier "2" (rail transport)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
321
Part 1: EDI
EDI Message Specifications
EDI Message Types
edi:ediTruck
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='3') such that it will be displayed only
when the SG4 TDT has qualifier "3" (road transport)
4.1 How to Configure N4 for COPRAR?
N/A
3.2 Special Cases
Multi-facility scenario
If a given container in an EDI file is active in another facility, the system will create a new advised unit for the given
facility.
4 Settings
N4 has a way of validating certain business conditions which might be applicable for some clients and might not be for
some. Therefore, those validations are made configurable. That is, the user may turn it on if a certain validation is
needed or turn it off, if not needed.
The following table lists such configurable settings applicable for the Discharge list EDI message:
Name
ARGODISCHLIST001
Description
Edit UI
List of Permissions to
Session >
apply for Discharge List Settings
Validate equipment
ARGODISCHLIST002
type ISO
Session >
Settings
Usage
To apply all the selected permissions for the
given containers in the COPRAR EDI
message.
Set it to true to validate the equipment type
provided by the DISCHARGE List EDI
message and generate an error if the
equipment type is not found in the system.
5 Samples
UNA:+.? '
UNB+UNOA:2+DISC+131208+060227:1013+24'
UNH+2400001+COPRAR:95A:UN'
BGM+43+20060227101+9'
FTX+OSI++D'
RFF+XXX:1'
TDT+20+029W+1+DISC:172:20++VRXH3:103::COSCO ANTWERP'
RFF+VON:029W'
LOC+11+USOAK:139:6+:TER:ZZZ'
NAD+CF+DISC:160:20'
EQD+CN+BLKU1253160+2270:102:5++3+5'
RFF+BN:39430060'
RFF+BM:39430061'
RFF+AAY:1'
LOC+9+SGSIN'
MEA+AAE+G+KGM:28000'
MEA+AAE+T+KGM:37000'
FTX+AAA+++LACTIC ACID FEED GRADE'
TDT+30++2+25'
CNT+16:153'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
322
Part 1: EDI
EDI Message Specifications
EDI Message Types
UNT+944+2400001'
UNZ+1+24'
6 Validations
Pre-requisite to post a discharge list message:
• Container ID, operator must be available.
• Routing points must be in the itinerary.
• Vessel visit must be present, else system will try to create a preliminary vessel visit, provided the auto-creation of
vessel visit is enabled and the vessel details are given.
• The line operator must be a shared line of the vessel visit if "SP_VALIDATE_LINE_PER_VSL" setting is enabled.
• ISO code must be valid if "DISCH_VALIDATE_EQ_TYPE" is enabled.
1.9.3.10 EDI Inbound LoadList Message - COPRAR D 95B
Purpose
This specification provides the definition of the COPRAR D 95B Inbound LoadList message to be used in Electronic
Data Interchange (EDI) between line operator and the marine terminal primarily to indicate which containers should be
loaded to a vessel.
Functional Definition
This COPRAR LoadList Message (COPRAR D 95B) permits the transfer of data from a line operator to the terminal
operator.
The line operator may send the following details to the terminal operator:
• Outbound Vessel Visit Details
• Container Details
• Equipment Order Details
• Hazard Details
• Commodity Details
1.1 Objective
The following sections of this document explain how COPRAR D 95BLoadList message is handled in N4 and scope of
its implementation. This message is basically used for the following purposes:
• The line operator will send the outbound vessel visit details to the terminal operator.
• The terminal operator will plan for the vessel visit that is send by the line operator.
• The terminal operator will also plan for the containers received through the message.
1.2 COPRAR LoadList Message (COPRAR D 95B)
N4 supports EDIFACT standard COPRAR LOADLIST message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
323
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard COPRAR D 95B message & scope of each segment in
N4.
S. No
Group
Supported
Qualifier
Segment ID
Description
Supported in N4?
1
UNB
Interchange Header (sender, receiver)
Supported
2
UNH
Message Header (message type,
message reference number)
Supported
3
BGM
Beginning of message (message
function)
Supported
4
FTX
Free text
Not Supported
5
RFF
Reference
Not Supported
TDT
Details Of Transport (O/B vessel details)
Supported
7
RFF
Reference
Not Supported
8
LOC
Place/Location Identification
Not Supported
9
DTM
Estimated Time Arrival/Departure of O/B
vessel (132/133)
Supported
10
FTX
Free text
Not Supported
Name And Address
Not Supported
Contact Information
Not Supported
6
11
SG1
SG2
12
13
NAD
XXX, ACW
132, 133
CA, CF, SLS
CTA
EQD
CN
Equipment Details
Supported
14
RFF
BN, ABT
Reference
Supported
15
EQN
Number Of Units
Not Supported
16
TMD
Transport Movement Details
Not Supported
17
DTM
Date/Time/Period
Not Supported
18
LOC
Place/Location Identification (delivery,
destination, discharge)
Supported
19
MEA
Measurement (gross weight)
Supported
20
DIM
Dimensions (front, back, right, left, top)
Supported
21
TMP
Temperature (preferred temperature)
Supported
22
RNG
Range (Minimum, Maximum)
Supported
23
SEL
CA, CU, QA, SH
Seal Number (carrier, customs,
quarantine, shipper)
Supported
24
FTX
AAA, HAN
Free Text (goods description, handling
instructions
Supported
25
DGS
Dangerous Goods
Supported
26
EQA
Attached Equipment (chassis, reefer
generator)
Supported
TDT
Details Of Transport (Inbound - truck/
train/vessel details)
Supported
28
RFF
Reference
Not Supported
29
LOC
Place/Location Identification
Not Supported
27
SG3
SG4
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
2, 3, 4, 5
7, 9, 11, PDS
5, 6, 7, 8, 9
CH, RG
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
324
Part 1: EDI
S. No
Group
EDI Message Specifications
EDI Message Types
Segment ID
Supported
Qualifier
Description
Supported in N4?
30
DTM
Date/Time/Period (Estimated Time Arrival
Supported
of I/B Vessel Visit)
31
NAD
Name And Address (Container Operator) Supported
32
CNT
Control Total
Not Supported
33
UNT
Message Trailer
Not Supported
2.2 COPRAR - Message Functions
As per EDIFACT standard, COPRAR has various message function codes in BGM segment and N4 supports the
following message functions are supported
BGM+661+WCP00000530901+3+AB' -- Here "3" is the message function qualifier
Qualifier in the EDI message
Value in the XML
1 or 3
Any Other Qualifier
D - Delete
Default Behavior
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert COPRAR Edi message into Navis standard loadlist xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• coprar(load)_D_95B.mgt- GoXml map
• coprar.dic -Edifact standard dictionary
• loadlist.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
edi:ediInboundVesselVisit
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='1' || /EDI/Group_Loop/
COPRAR/SG3/SG4/TDT/C220@A_8067=='8') such that it will be displayed only when the SG4 TDT has qualifer "1"
(maritime transport) or "8"(inland water transport).
edi:ediTrainVisit
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='2') such that it will be displayed only
when the SG4 TDT has qualifier "2" (rail transport).
edi:ediTruck
• Added a filter (/EDI/Group_Loop/COPRAR/SG3/SG4/TDT/C220@A_8067=='3') such that it will be displayed only
when the SG4 TDT has qualifier "3" (road transport).
4.1 How to Configure N4 for COPRAR?
N/A
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
325
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2 Special Cases
Multi-facility scenario
If the given container in the EDI file is Active in other facility, the system will create a new advised unit for the given
facility.
4.3 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for COPRAR LoadList EDI message:
Name
Description
Edit UI
Usage
Session >
Settings
To apply all the selected permissions for the
given containers in the COPRAR EDI
message.
Validate equipment type
ARGOLOADLIST002
ISO
Session >
Settings
Set it to true to validate the equipment type
provided by the LOADLIST EDI message
and generate an error if the equipment type
is not found in the system.
Parameter to convert
ARGOLOADLIST003 container category from
IMPORT to TRANSSHIP
Session >
Settings
To change the container category from
Import to Transship.
ARGOLOADLIST001
List of Permissions to
apply for Load List
5 Samples
UNA:+.? '
UNB+UNOA:2+128201+131200+060613:0945+5'
UNH+20060613000000+COPRAR:D:95B:UN:ITG12'
BGM+45+2261+9'
FTX+OSI++L'
RFF+XXX:1'
TDT+20+TEST242+1+CSL:172:20++TESTV:103::XIN QING DAO'
RFF+VON:TEST242'
LOC+9+BEANR:139:6+K736:TER:ZZZ'
NAD+CF+CSL'
EQD+CN+XCCLU2930116+22G0:102:5++2+5'
RFF+BN:8ANRZHA632154'
RFF+AAY:1'
TMD+3'
LOC+11+CNNSA'
LOC+7+CNZHA'
MEA+AAE+G+KGM:29290'
FTX+AAA+++IRON AND STEEL'
EQD+CN+XCCLU3228866+22G0:102:5++2+5'
RFF+BN:8ANRPKG631586'
RFF+AAY:89'
TMD+3'
LOC+11+MYPKG'
LOC+7+MYPKG'
MEA+AAE+G+KGM:14790'
FTX+AAA+++CHEMICALS'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
326
Part 1: EDI
EDI Message Specifications
EDI Message Types
FTX+AAD+++ENVIRONMENTALLY HAZARDOUS SUBSTANCE, SOLID, NOS'
DGS+IMD+9+3077+000+3'
CNT+16:89'
UNT+724+20060613000000'
UNZ+1+5'
6 Validations
Pre-Requisite to post a load list message:
• Container Id, operator
• Routing points must be in the itinerary
• Vessel visit must be present else system tries to create Preliminary vessel visit if auto creation of vessel visit is
enabled provided vessel info is given.
• The line operator must be a shared line of the vessel visit if "SP_VALIDATE_LINE_PER_VSL" setting is enabled
• ISO code must be valid if "LDL_VALIDATE_EQ_TYPE" is enabled
1.9.3.11 EDI Inbound Pre-advise Message - COPINO D 95B
Purpose
The COPINO pre-advise message is provided by inland carriers (railroads, barge operators and trucking companies) to
notify the terminal to drop off a container.
Functional Definition
This message is to notify the terminal to drop off a container. The EDI messages can be received at any point in the
ongoing inbound vessel operation.
1.1 Objective
The following sections of this document explain how COPINO pre-advise message is handled in N4 and scope of its
implementation.
In a terminal, COPINO pre-advise edi is received from the trucking company.
1.2 Container Pre-Notification Message (COPINO D 95B)
N4 supports EDIFACT standard COPINO message, release D & version 95B.
2.1 Scope
Following table illustrates the segments of EDIFACT standard COPINO D 95B message & scope of each segment in
N4.
S.No
Group
Segment ID
Supported Qualifier
Description
Supported in N4?
1
UNH
Message Header
Supported
2
BGM
Beginning of message
Supported
3
FTX
Free Text
Not Supported
4
RFF
Reference
Not Supported
5
TDT
Details of transport
Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
327
Part 1: EDI
S.No
EDI Message Specifications
EDI Message Types
Group
Segment ID
6
LOC
7
DTM
8
NAD
9
Supported Qualifier
7
Description
Supported in N4?
Place/location identification
Supported
Date/time/period
Supported
Name and address
Supported
CTA
Contact information
Not Supported
11
GID
Goods item details
Supported
12
HAN
Handling instructions
Not Supported
13
TMP
Temperature
Supported
14
RNG
Range
Supported
15
SGP
Split Goods Placement
Not Supported
16
DGS
Dangerous goods
Supported
17
FTX
Free Text
Not Supported
18
EQD
CN, CH
Equipment Qualifier
Supported
19
RFF
REO,CAO
Reference
Supported
20
EQN
Number Of Units
Not Supported
21
MEA
Measurements
Supported
22
DIM
Dimensions
Supported
23
SEL
Seal number
Supported
24
EQA
Attached equipment
Not Supported
25
TDT
Details of transport
Supported
26
LOC
Place/location identification
Supported
27
DTM
Date/time/period
Not Supported
28
NAD
Name and address
Not Supported
29
CNT
Control total
Not Supported
30
UNT
Message trailer
Not Supported
MR, MS
CA, SH, TO, CU
9,11, 147
2.2 COPINO - Message Functions
As per EDIFACT standard, COPINO has various message function codes in BGM segment and N4 supports the
following message functions are supported
BGM+12+20070702004202+9' – Here "9" is the message function qualifier.
Qualifier in the EDI message
Value in the XML
9
3
1
O - Original
D - Cancel
D - Cancel
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert COPINO edi message into Navis standard preadvise xml. This xml in
turn used for further processing.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
328
Part 1: EDI
EDI Message Specifications
EDI Message Types
Following are the related files, part of N4 application and can be downloaded:
• copinodropoff_D_95B.mgt - GoXml map
• copino.dic - Edifact standard dictionary
• preadvise.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
edi:ediInboundVisit mapping
• Added a match to SG1 loop (First TDT)
edi:ediOutboundVisit mapping
• Added a match to SG5 loop (Second TDT)
4.1 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for some. So
those validations are made configurable, the user may turn it on if the particular validation is needed or turn it off if not
needed.
The following table lists such configurable settings applicable for COPINO message:
Name
Description
Edit UI
Usage
ARGOPREADVISE001 Validate equipment type ISO Settings To validate the ISO code given in the EDI file.
Allow auto creation of
foreign vessel visit
Settings
To create a vessel if the vessel specified in a
COPINO EDI message is not in N4
ARGOPREADVISE003 Validate line operator
Settings
To validate the line operator given in the EDI
file.
ARGOPREADVISE002
4.2 Special Cases
POD
• POD is not given - if the container discharge port is empty system tries to resolve discharge point using the route
resolver if defined
• If the POD is current port, then the unit category will be considered as "STORAGE"
Line Operator
• It uses vessel visit shipping line details to resolve the line operator (Else)
• It uses container operator details to resolve the line operator (Else)
• Throws error
5 Samples
UNB+UNOA:2+COPTHU+131204+041231:1515+NYK00000000460+++A+1++1'
UNH+NYK00000046001+COPINO:95B:UN+NYK000000460+1:F'
BGM+660+NYK00000046001+9+AB'
TDT+1+TRK001+3++ACME:172:20'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
329
Part 1: EDI
EDI Message Specifications
EDI Message Types
LOC+7+BEANR732+P&O PORTS KADE 732-738'
DTM+132:200708181200:203'
NAD+MS+NYK:172:20'
CTA+IC+:CARRIER'
NAD+MR+NYK:172:20'
CTA+IC+:LUC SIMONS'
GID+1'
FTX+AAA+++LIQUID'
SGP+NSOU0000001'
DGS+IMD+8+1760'
FTX+AAD+++CORROSIVE LIQUID, NOS 5-B?:ROMO-5-NITRO-1,3-DIOXANE'
EQD+CN+ZSPU113245+2200:102:5++2+5'
RFF+CAO:ZSPBKG001'
RFF+CN:ZSP002'
RFF+SQ:1'
MEA+AAE+G+KGM:32300'
SEL+3241+CA+1'
TDT+20+565+1+ZSP:172:20++THU:146::THU'
LOC+9+NZLYT'
LOC+11+HKHKG'
NAD+OCR+UNKNOWN'
CNT+16:1'
UNT+23+NYK00000046001'
UNZ+1+NYK00000000460'
1.9.3.12 EDI Inbound Rail consist Message - ANSI 418 00
4020
Purpose
This specification provides the definition of the ANSI 418 Inbound Rail Consist message to be used in Electronic Data
Interchange (EDI) between a rail operator and the terminal operator in the marine/rail domain. This message is used to
inform the terminal operator about what containers are shipped in to the terminal via rail. This can be typically sent after
planning and loading the containers to the train and when the rail road is about to move them, that is, before the train
arrives at the terminal.
Functional Definition
This Inbound Rail Consist Message (ANSI 418) permits the transfer of data from a rail operator to a terminal operator.
The rail operator will send the following details to the terminal operator:
• Train visit details
• Attached railcar details
• Loaded container details
• Attached equipment details
• Hazard information, if any, for the individual containers
1.1 Objective
The following sections of this document explain how ANSI 418 Inbound Rail Consist message is handled in N4 and the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
330
Part 1: EDI
EDI Message Specifications
EDI Message Types
scope of its implementation. This message is basically used for the following operations carried out by the terminal/rail
operators:
• The rail operator will send the inbound train visit details to the terminal operator once the planning of the containers
is completed. That is, before the train arrives at the facility.
• The terminal operator will plan for the train visit that is sent by the rail operator.
• The terminal operator will also plan for the containers received through the EDI message.
1.2 Inbound Rail Consist message (ANSI 418)
N4 supports ANSI standard 418 RAILCONSIST message, release 00 & version 4020.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
The following table illustrates the segments of ANSI standard RAILCONSIST 00 4020 (418) message and the scope of
each segment in N4.
S. No. #
Supported
Qualifier
Segment ID
Description
Supported in N4?
1
ST
Transaction Set Header
Supported
1
BAX
Beginning Segment for Advance Consist and
Transportation Automatic Equipment
Supported
2
W1
Block Identification
Not Supported
3
W2
RR
Equipment Identification (Railcar)
Supported
4
W2
CN
Equipment Identification (Container)
Supported
5
W3
Consignee Information
Supported
6
IMA
Interchange Move Authority
Not Supported
7
W4
Consignee Information
Supported
8
W5
Route Information
Supported
9
PS
Protective Service Instructions
Supported
10
REF
Reference Identification
Not Supported
11
LS
Loop Header
Not Supported
12
LH1
Hazardous Identification Information
Supported
13
LH2
Hazardous Classification Information
Supported
14
LH3
Hazardous Material Shipping Name
Supported
15
LFH
Freeform Hazardous Material Information
Not Supported
16
LEP
EPA Required Data
Not Supported
17
LH4
Canadian Dangerous Requirements
Not Supported
18
LHT
Trans-border Hazardous Requirements
Not Supported
19
LHR
Hazardous Material Identifying Reference Numbers
Not Supported
20
PER
Administrative Communications Contact
Not Supported
21
N1
Name
Not Supported
22
N3
Address Information
Not Supported
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
331
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S. No. #
Segment ID
Description
Supported in N4?
23
N4
Geographic Location
Not Supported
24
PER
Administrative Communications Contact
Not Supported
25
LE
Loop Trailer
Not Supported
26
PER
Administrative Communications Contact
Not Supported
27
LH2
Hazardous Classification Information
Not Supported
28
LHR
Hazardous Material Identifying Reference Numbers
Not Supported
29
SE
Transaction Set Trailer
Supported
2.2 Rail Consist - Message Functions
As per ANSI standard, the Rail Consist Outbound message has various message function codes in the BAX (in the
13th element) segment. But, in the Inbound message, N4 only supports the following message function i.e. Original
(00), Add (02) and Replace (05).
3.1 N4 Built-in Map
The rail operator will send the EDI as per ANSI standard format. In N4, the inbound rail consist map is a way of
mapping the data send through an EDI file in to the application (to store as persistent data).
N4 serves a built-in map for converting the ANSI 418 Inbound EDI message standard in to Navis standard rail consist
xml file using the Navis standard schema file i.e. railconsist.xsd.
Following are the related files that can be downloaded as part of N4 application:
• ansi418_00_4020.mgt - GoXml map
• 418.dic - ANSI standard dictionary
• railconsist.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
4.1 How to Configure N4 for Inbound Rail Consist
N4 needs to be set up to process an inbound Rail Consist message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
332
Part 1: EDI
EDI Message Specifications
EDI Message Types
To process an inbound Rail Consist message:
1. Create an inbound train visit with the Direction as Inbound Only Train.
2. Update the visit phase to Inbound.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
333
Part 1: EDI
EDI Message Specifications
EDI Message Types
3. Create the Message Type and Message Map for the Inbound Railconsist.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
334
Part 1: EDI
EDI Message Specifications
EDI Message Types
4. Create the Mailbox and Session for the Inbound Railconsist.
5. Load and post the Inbound Railconsist EDI file.
To load an inbound rail consist message:
1. Go to Administration> EDI> EDI Load. A new form will be displayed.
2. Select the desired railconsist session in the EDI Session drop-down.
3. Browse the desired EDI file to post in the application.
4. Select the Post Immediate check box to post the file immediately after loading the file.
5. Click on the Load button to load the file. The progress bar will show the following message "Edi Job Completed".
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
335
Part 1: EDI
EDI Message Specifications
EDI Message Types
6. Click OK.
7. Verify the batch for the status of the file posted.
In a ideal scenario, all the processes should show the status as COMPLETE. If there are any errors, then rectify and
repost the file.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
336
Part 1: EDI
EDI Message Specifications
EDI Message Types
5 Samples
5.1 ANSI 418 Inbound Rail Consist EDI with message function as A
ISA*00* *00* *ZZ* *ZZ* *070607*0310*U*00402*000190806*0*P*>~
GS*SO*APL*APL*20070607*0310*211621*X*004020~
ST*418*130001~
BAX*FCY111*T*139*040511*1328*SPTRLHA307**IN*040511*2115*02~
W1*APL~
W2*RCA*11*RR*L*135BNSF*****1*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCA*22*RR*L*135BNSF*****2*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCA*33*RR*L*135BNSF*****3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRA*11*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRA*22*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*RCA*44*RR*L*135BNSF*****4*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRA*33*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRA*44*4950130*CN*L*8*APL*******1B1*2000~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
337
Part 1: EDI
EDI Message Specifications
EDI Message Types
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
PER*HM*MAERSK INC*TE*3523233500~
SE*79*130001~
GE*5*211621~
IEA*1*000190806~
5.2 ANSI 418 Inbound Rail Consist EDI with message function as A for a different train visit
ISA*00* *00* *ZZ* *ZZ* *070607*0310*U*00402*000190806*0*P*>~
GS*IC*APL*APL*040609*1135*13*X*004020~
ST*418*130001~
BAX*FCY111*T*139*040511*1328*SPTRLHA309**IN*040511*2115*02~
W1*APL~
W2*RCB*11*RR*L*135BNSF*****1*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCB*22*RR*L*135BNSF*****2*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCB*33*RR*L*135BNSF*****3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRB*11*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRB*22*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*RCB*44*RR*L*135BNSF*****4*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
338
Part 1: EDI
EDI Message Specifications
EDI Message Types
W6*IB~
W2*CTRB*33*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRB*44*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
PER*HM*MAERSK INC*TE*3523233500~
SE*79*130001~
GE*5*211621~
IEA*1*000190806~
5.3 ANSI 418 Inbound Rail Consist EDI with message function as X for a Replace Railconsist
ISA*00* *00* *ZZ* *ZZ* *070607*0310*U*00402*000190806*0*P*>~
GS*IC*APL*APL*040609*1135*13*X*004020~
ST*418*130001~
BAX*FCY111*T*139*040511*1328*SPTRLHA309**IN*040511*2115*05~
W1*APL~
W2*RCA*11*RR*L*135BNSF*****1*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCB*11*RR*L*135BNSF*****2*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCC*11*RR*L*135BNSF*****3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*RCA*33*RR*L*135BNSF*****3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRA*11*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
339
Part 1: EDI
EDI Message Specifications
EDI Message Types
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRB*11*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRC*11*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*RCB*33*RR*L*99*******3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRA*33*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRB*33*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
PER*HM*MAERSK INC*TE*3523233500~
W2*RCC*33*RR*L*99*******3*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*CTRC*22*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
340
Part 1: EDI
EDI Message Specifications
EDI Message Types
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
W2*CTRC*33*4950130*CN*L*8*APL*******1B1*2000~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*4*1111111*KG*1111**cylinder~
LH2*6.2*P*2*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
PER*HM*MAERSK INC*TE*3523233500~
SE*79*130001~
GE*5*211621~
IEA*1*000190806~
1.9.3.13 EDI Inbound Rail Waybill Message - ANSI 417 00 4020
Purpose
This specification provides the definition of the ANSI 417 Inbound Rail Waybill message to be used in Electronic Data
Interchange (EDI). It explains the movement instructions pertinent to a rail carrier shipment. It creates a contract
between the shipper and the rail freight carrier and serves as a receipt by the carrier for goods shipped.
This message is sent by the rail carriers to the terminal.
Functional Definition
This Inbound Rail Waybill Message (ANSI 417) permits the transfer of data from a rail carrier to a terminal operator.
The Waybill is considered to be at the container level. The inbound or outbound containers are resolved with respect to
the current facility port. That is,
• If the SPLC code of the current facility port is the same as the SPLC code of the destination port, then it is an
inbound container.
• If the SPLC code of the current facility port is the same as the SPLC code of the origin port, then it is an outbound
container.
• The rail operator will send the following details to a terminal operator:
▪ Rail Waybill details (Waybill number and Waybill date)
▪ Vessel visit details, if any
▪ Loaded container details
▪ Attached equipment details
▪ Hazard information, if any, for the individual containers
▪ Booking and/or Bill of Lading numbers
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
341
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.1 Objective
The following sections of this document explains how ANSI 417 Inbound Rail Waybill message is handled in N4 and
the scope of its implementation. This use of the message is as follows:
The rail operator sends the inbound rail waybill details to a terminal operator. This waybill is used to resolve the
inbound and outbound containers with respect to the current facility. It creates a waybill considering the message
function as Original or Create. If the message function provided in the waybill message is Delete, then the existing
waybill information gets deleted. However, if the waybill message contains a Booking and/or a BL number, then the unit
gets attached to that booking and/or the BL number (if existing).
1.2 Inbound Rail Waybill message (ANSI 417)
N4 supports ANSI standard 417 Rail Waybill message, release 00 and version 4020.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
The following table illustrates the segments of ANSI standard RAILWAYBILL 00 4020 (417) message and the scope of
each segment in N4.
Supported
Qualifier
S. No. #
Segment ID
1
ST
Transaction Set Header
2
ZC1
Beginning Segment For Data Correction Or Change Supported
3
BX
General Shipment Information
Supported
4
BNX
Rail Shipment Information
Not Supported
5
CM
Cargo Manifest
Supported
6
H3
Special Handling
Supported
7
N9
Reference Identification
Supported
8
N7
Equipment Details
Supported
9
M12
Inbond Identifying information
Supported
10
M7
Seal Numbers
Supported
11
N8
Waybill Reference
Supported
12
F9
Origin Station
Supported
13
D9
Destination Station
Supported
14
N1
Name
Supported
15
N2
Additional Name Information
Not Supported
16
N3
Address Information
Not Supported
17
N4
Geographic Location
Not Supported
18
PER
Administrative Communications Contact
Not Supported
19
R2
Route Information
Supported
20
LH1
Waybill Hazards Details like count, code,etc.
Supported
21
LH2
Waybill Hazards Details like temperature,flash point Supported
22
LH3
Shipping Name
Supported
23
LFH
Material Description
Supported
L, D
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Description
Supported in N4?
Supported
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
342
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S. No. #
Segment ID
Description
Supported in N4?
24
PER
Material Contact
Not Supported
25
LX
Assigned Number
Not Supported
26
L5
Description, Marks and Numbers
Supported
27
L0
Line Item - Quantity and Weight
Not Supported
28
SE
Transaction Set Trailer
Supported
2.2 Rail Waybill - Message Functions
As per ANSI standard, the Rail Waybill Inbound message has various message function codes in the BX (the 1st
element) segment. But in the Inbound message, N4 supports only the following message functions: Original (00), Add
(02) and Delete (03).
3.1 N4 Built-in Map
N4 serves a built-in map for converting the ANSI 417 Inbound EDI message standard in to a Navis standard rail waybill
xml file using the Navis standard schema file: railwaybill.xsd.
Following are the related files that can be downloaded as part of N4 application:
• ansi417_00_4020.mgt - GoXml map
• 417.dic - ANSI standard dictionary
• railwaybill.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Special cases
• If there is any secondary rail operator (additional R2 segment), then the equipment is treated as a transship
container.
• Facility is optional in the railwaybill message. But because a facility is required to process a rail waybill message, a
custom map can be created from N4 built-in map and the facility field can be mapped to a constant value.
Alternatively, refer section 1.3 (Configuring facility in an EDI session) below.
• N4 creates vessel visits automatically. A unit's IB or OB category should be updated only if the unit is attached to a
TBA_TRAIN.
Following conditions apply only for outbound units:
• If a unit already has a booking existing in the system, then it should update the vessel visit associated with that
booking for the received unit.
• A parameter ARGORAILWAYBILL001- Allow auto creation of foreign vessel visit will be supported, which can
be configured to make the Rail Waybill message create vessel visits automatically for only a Non-Operational
facility.
3.3 Configuring facility in an EDI Session
N4 requires facility information to process a rail way bill message. It can be sent to N4 in two ways - The first method is
specified in section 1.2.4 and the other one is explained below. When creating an EDI session for a Rail Waybill
message, a setting can be added to specify the facility value. N4 will use this facility to process the Waybill message
and will advise units at this facility. The setting name is : ARGORAILWAYBILL003 - Facility to post rail waybill
messages.
If facility is not specified in any of the above two ways, N4 will throw an error.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
343
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.1 How to Configure N4 for Inbound Rail Waybill?
The following steps explain how to set up and process an inbound Rail Waybill message in N4.
To set up an inbound Rail Waybill message:
1. Create the Message Type and Message Map for the Inbound RailWaybill.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
344
Part 1: EDI
EDI Message Specifications
EDI Message Types
2. Create the Mailbox and Session for the Inbound Rail Waybill.
3. Load and post the Inbound Rail Waybill EDI file.
To load an inbound Rail Waybill message:
1. Go to Administration > EDI > Load. A new form will be displayed.
2. Select the desired rail waybill session in the EDI Session drop-down.
3. Browse the desired EDI file to post in the application.
4. Select the Post Immediate check box for posting the file immediately after loading the file.
5. Click on the Load button to load the file. The progress bar will show the following message "Edi Job Completed".
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
345
Part 1: EDI
EDI Message Specifications
EDI Message Types
6. Click OK.
7. Verify the batch for the status of the file posted.
In an ideal scenario, all the processes should show the status as COMPLETE/WARNING. If there are any errors, then
rectify and repost the file.
5 Samples
5.1 ANSI 417 Inbound Rail Waybill EDI with message function as original (00)/create(02)
ISA*04* *00* *ZZ*APL *ZZ*APL *080609*0345*U*00401*000586492*0*P*>
GS*WB*APL*APL*20080609*0345*586492*X*004010
ST*417*864920001
ZC1*NA*TRLU*652862*992811**CO*CSXT*X
BX*02*X*PP**CSXT*L*W*N
BNX*M**S
N9*BM*USPNY6608***0923*ET
N9*BN*USPNY6608***0923
N9*P8*35110988
CM*216R*L*USOAK******FSECL01
N7*TRLU*652862*2000*N***APL*CN**4000***2200*U000
M12*INBOND STATUS02***INBOND STATUS06
M7*SEAL1*SEAL2*SEAL3*SEAL4
N8*992811*
F9*72168*CLEVELAND*OH*****664422
D9*89630*ELIZABETH MARINE TE*NJ*****191821
N1*SH*ZIM AMERICAN INTEGRATED SHIPNG
N4*CLEVELAND*OH
N1*CN*ZIM AMERICAN INTEGRATED SHIPNG
N4*ELIZABETH MARINE TE*NJ
N1*PF*ZIM AMERICAN INTEGRATED SHIPNG
N3*ATTN ACCOUNTS PAYABLE*5801 LAKE WRIGHT DRIVE
N4*NORFOLK*VA*23502
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
346
Part 1: EDI
EDI Message Specifications
EDI Message Types
N1*N1*BILL TOPPS
PER*NT**TE*7183131964
R2*CSXT*S***85
H3*SPL INS**85
LX*1
L5*1*CONTAINERS, DEMOUNTABLE*4221130*T
L0*1***2000*N
PI*CT*5004***CSXT*AGRT
LH1***CODE4
LH2*CLS1
LH3*HAZARDOUS DESC
SE*26*864920001
GE*1*586492
IEA*1*000586492
5.2 ANSI 417 Inbound Rail Waybill EDI with message function as delete(03)
When the message function, that is, the first element of the BX segment is 03 *(BX*03)*, then the message deletes the
rail waybill message. In this case, the unit must be available in the system and the received waybill number must match
with the existing waybill number attached to that unit. If this condition is satisfied, then the deletion of waybill will be
performed in either of the two cases (mentioned below) when the unit is in advised state:
• The unit is deleted from the application if the inbound and outbound visit information are generic (i.e. both the IB and
OB are TBA_TRAIN/GEN_VESSEL).
• The unit waybill information (that is, waybill number and waybill date) is removed if the routing information is not
generic.
1.9.3.14 EDI Inbound Saudi Load Permit Order Message SAUDILDP 30
Purpose
This guideline document specifies on how Saudi Load Permit Order EDI message is implemented and how N4 can be
configured to process this particular message.
Functional Definition
Saudi Load Permit Order is a Flatfile EDI transferred from Shipping Agents to Terminals in Saudi region. Basically, it
contains the list of containers to be loaded on particular outbound vessel, especially for Transship containers. Load
permit order contains list of BLs, Bl Items, Containers, and Load permission section. It is assumed that all the BLs, BL
Items & containers in load permit order message are already created by another message called Saudi Manifest.
A Saudi Load Permit Order may contain following information in same order:
• Load Permit Manifest Header - Contains outbound vessel visit & etc.
• Replacement Containers
• Reference Import Manifest Header
• Reference Import Manifest containers
• Reference Import Manifest BL & Bl Items
• Load Permit Header & Items
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
347
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.1 Objective
Shipping Agent advises the terminal the list of Transship containers to be loaded from an incoming vessel to an
another outgoing vessel. N4 grants a permission to those containers referred in load permit order and terminal can/will
load only those containers.
1.2 Saudi Load Permit Order Message (SAUDILDP 30)
N4 supports Saudi Load permit order message as per specification document version 3.0 received from Red Sea
Gateway Terminals(RSGT) since the feature is primarily developed for RSGT. A new message class "SAUDILDP" has
been added in N4 to configure load permit message.
2.1 Scope
• In Replacement Container segment (SAULDPD200), though we have separate message function (N-New/UUpdate/D-Delete), in N4 its always assumed as U-update.
• The sequence number in Replacement Container segment (SAULDPD200) is not recorded/processed.
• All BL, BL containers & Bl items are updated as per Load permit order. Basically the information from Saudi manifest
will be overwritten.
2.2 SAUDILDP - Message Functions
Saudi LDP has message function (N-New/U-Update/D-Delete) in following segments:
• Replacement container segment - SAULDPD200
• Load Permit & Items - SAULDPD400, SAULDPD450
But, in principal as the message meant grant load permission which is received in SAULDPD400 & SAULDPD450
segments, N4 obeys only the message function in SAULDPD450 (this in turn takes care of SAULDPD400 as well).
• SAULDPD400(N) - To grant permission to a container.
• SAULDPD400(U) - Update other information related to load permit - load permit date etc.
• SAULDPD400(D) - Revoke the existing load permission.
3.1 Xenos Map for Saudi LDP
Since Saudi LDP is a flat file, it cannot be processed as such in N4. So a new Xml schema (saudildp.xsd) has been
defined for SAUDILDP message class and flat file load permit message has to be converted to this particular xml
structure.
For this, a new Xenos map(saudildp_30.mgt) has been developed to transform the load permit flat file to N4 standard
xml format during runtime.
Note: The Xenos map is not a built-in map, which means there won’t be a Message Type (in Message Types UI) in N4
with this map & message class SAUDILDP. Customers who want to use Saudi LDP need to get the latest map from PS
and maintain it themselves if any customization is done.
3.2 Xenos Map - Special cases
In this Section:
3.2.1 Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
3.2.2 Sequence Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
3.2.3 Hard Coded EDI Trading Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
348
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.2.1 Entity Type
As Saudi LDP contains information various entities, such as BL, BL Item & Container etc, a separate attribute is
present in Navis standard xml (saudildp.xsd) to specify the type of entity to be processed in N4.
Possible values for entity type field are: REPLACEMENTCTR, BLCTR, BL, BLITEM, LOADPERMIT &
LOADPERMITITEM.
This attribute is used for following purpose:
• to control the code flow
• to validate the integrity of the transformed xml - for example, if entity type is BL the transformed xml should contain
BL information.
• to resolve the keywords for specific to an entity
3.2.2 Sequence Numbers
Since Saudi LDP is a flat file EDI, it has sequence numbers at each segment level and is used to refer in further update
messages for the same entity and same message. The sequence numbers are unique in a particular message but not
across messages. So to make it unique across messages, in N4, in addition to sequence number of a particular entity,
some more information such as manifest number and date are used as well.
In N4, once the Load permit flat file is transformed to Navis standard xml, the sequence number of various entity will be
concatenation of many values.
3.2.3 Hard Coded EDI Trading Partner
In N4, to process an inbound EDI, an EDI Session needs to be created which in turn needs a EDI Trading Partner.
According to ANSI & EDIFACT standards, the EDI Trading partner refers to the sender of the EDI message. But the
Saudi LDP flat file does not have such information at all.
So, as of now, for the Saudi LDP developed for Saudi EDI, the EDI trading partner name is hard coded as "SAUDIEDI".
Customers that want to use a different partner name, the Xenos map (saudildp.mgt) has to be customized with
required partner name.
4.1 How to Configure N4 for Saudi LDP?
To process Saudi LDP, the following set up needs to be done:
• Message Type should be created with Message Class as "SAUDILDP" and Standard as "FLATFILE".
• A Message map should be created under the message type direction as Receive, import the map file
"saudildp_30.mgt" and dictionary file "saudildp.fxd".
• In Holds/Permissions UI, add a flag type with "Applies To" as Unit, Type as Permission.
• Under Settings UI, select the config "SAUDI_LOAD_PERMIT_PERMISSION - ARGOSAUDILDP001-Id of
Permission(s) to apply for Saudi Load Permit Order to set the ID(s) for the Permission created above. These can be
comma separated values.
• In the EDI Configuration UI, create a EDI Trading Partner with an ID similar to the partner hardcoded in the map.
• Create an EDI Mailbox with direction as Receive.
• Create an EDI Session with the following attributes:
▪ Message Class - SAUDILDP
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
349
Part 1: EDI
EDI Message Specifications
EDI Message Types
▪ Direction - Receive
▪ Map - Select Map ID as created under Message Type
4.2 Special Cases
In this Section:
4.2.1 Implication of Posting a Saudi LDP in N4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.2 Saudi LDP with Replacement Container. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.3 Saudi LDP - DELETE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.4 Saudi LDP For Dray-In Container. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.5 Saudi LDP "Single Unit - multiple cargo". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
351
351
351
352
352
350
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Implication of Posting a Saudi LDP in N4
Though Saudi LDP message is primarily meant to grant permission for a container, it contains additional information
about the BL, BL Item and containers received in Import Manifest. Import Manifest creates all the BL, BL Item and
containers with proper sequence numbers. So when a Saudi LDP is posted, all those entities using the same sequence
number as marked as received.
Following are the implications of posting a Saudi LDP:
• BLs, Bl Items and Containers are updated as received in Saudi LDP.
• In addition to the information received in Container segments (SAULDPD200 & SAULDPD310), there is some
information in Load Permit segment SAULDPD400 and other noteable updates to the Unit are as follows:
▪ Load Permit Number
▪ Load Permit Date
▪ Category changed as TRANSSHIP
▪ Outbound Visit information are change to the Export vessel visit information from Saudi LDP header.
▪ Load Permission is GRANTED.
In N4, Load Permit Number and Date are named as Export Release Number and Export Release Date respectively. It
can be view in the "Units" UI by selecting those fields from the fields group "9-Other". The Export Release Number is
also available in Filter options.
The Export Release Number and Date are also made as Reportable fields and can be part of a report generated based
on Unit entity.
4.2.2 Saudi LDP with Replacement Container
Saudi LDP has a separate section called 'Replacement container' which means that the original container in a given BL
Item should be replaced with the container specified in this section.
When a Saudi LDP with Replacement Container is posted in N4, following are the implications:
• Load Permission is CANCELLED for the Original container, if it's GRANTED already.
• Load Permit Number, Date and Load permit sequence number information is removed from the Unit.
• Container is detached from the BL Item.
• If the same container is not attached with any other BL Items in the same BL, then the container is removed from
the BL itself. This means the Unit no longer displays in the Units sub-panel of the BL Inspector.
• Replacement container is attached to the BL Item & BL.
• Load Permission is GRANTED and Load permission information are updated to it.
4.2.3 Saudi LDP - DELETE
Saudi LDP with load permit segments of DELETE message function means to revoke the Load permission.
Implications in N4 are:
• Load Permission is CANCELLED for the Unit.
• Load Permit Number, Date and Load permit sequence number information are removed from the Unit.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
351
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.4 Saudi LDP For Dray-In Container
In general, Saudi LDP contains information about Containers recieved in Import Manifest. But sometimes it might
contain Containers that are not received in Import Manifest at all. In N4 those containers handled as Dray-In
containers.
In this case, the BL might not exist in the system, but the container must exist. Container might not have the manifest
sequence number since it's not part of import manifest.
Following are the implications:
• BL and BL items are created and updated with sequence numbers from Saudi LDP.
• Container is attached to BL & load permission is GRANTED.
• Load permit Nbr, Date and container sequence numbers are updated.
4.2.5 Saudi LDP "Single Unit - multiple cargo"
There are situations when a container has multiple cargo of the same BL or different BLs, since in the N4 model, a
container can be linked to multiple Cargo Lots. In these cases, the container will be granted with load permission only if
the load permit is received for all the BL items, in N4 terms, for all the Cargo lots. To keep track of this, Cargo Lots are
updated with the Load permit number as and when the load permit is received for each BL item.
The Load permit number is displayed in Cargo Lot table view under BL Item inspector.
Till the load permit is received for the last BL item of a container, N4 keeps adding a warning to all the EDI Batches
while processing the load permit. The warning reports that the container is not granted with load permission since there
are more BL items for which load permit is not yet received.
4.3 Settings
N4 has a way of validating some business conditions which might be applicable for some clients and not for others.
Therefore, those validations are configurable, so that the user may turn them on or off as needed.
The following table lists such configurable settings applicable for SAUDILDP message:
Name
Description
Edit UI
• ARGOSAUDILDP001
• Id of Permission(s) to apply for
Saudi Load Permit Order; can be
comma separated values
• Settings
Usage
• Refers to the Permission(s) to
be applied to Unit while
processing load permit order
5. Samples
5.1 Saudi Load Permit Order - NEW
SAULDPH100~N~1~1~20090908000001~20090908~EXP196657~ KOTA GUNAWAN~ ~
AE~LL196657~OB196657~SAJED~1~3
SAULDPD300~1~20090908000001~IMP196657~20090908~SAJED~0~11~IB196657~LL197657~MSC
GUNAWAN~~20040807132300~20040818173000~428~321
SAULDPD310~108~111~301~DRY~~45~KRKW 1966574~1~1900~9900~~~~~~~
SAULDPD320~210~1~BL196657~KRK196657~SSA~428~USOAK~SAJED~1~SGSIN~~~1~8080~50~1~1~General
Remarks~
SAULDPD330~1~108~50~PK~8080~~5~2~0~2~Highly explosive chemicals~Highly explosive
chemicals~marks no.711~~~
SAULDPD400~N~LP196657~20060612~428~321~SGSIN~1~SG~2
SAULDPD450~N~1~20090908000002~IMP196657~1~20090908~210~BL196657~1~~~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
352
Part 1: EDI
EDI Message Specifications
EDI Message Types
5.2 Saudi Load Permit Order - Replacement Container
SAULDPH100~N~1~1~20090908000001~20090908~EXP196657~ KOTA GUNAWAN~~
AE~LL196657~OB196657~SAJED~1~3
SAULDPD200~N~300~111~301~DRY~~45~BLJU 2345992~7~1900~9900~0~~~~~
SAULDPD300~1~20090908000001~IMP196657~20090908~SAJED~0~11~IB196657~LL197657~MSC
GUNAWAN~~20040807132300~20040818173000~428~321
SAULDPD310~108~111~301~DRY~~45~KRKW 1966574~1~1900~9900~~~~~~~
SAULDPD320~210~1~BL196657~KRK196657~SSA~428~USOAK~SAJED~1~SGSIN~~~1~8080~50~1~1~General
Remarks~
SAULDPD330~1~108~50~PK~8080~~5~2~0~2~Highly explosive chemicals~Highly explosive
chemicals~marks no.711~~~
SAULDPD400~N~LP196657~20060612~428~321~SGSIN~1~SG~2
SAULDPD450~N~1~20090908000002~IMP196657~1~20090908~210~BL196657~1~~BLJU 2345992~
5.3 Saudi Load Permit Order - DELETE
SAULDPH100~N~1~1~20090908000001~20090908~EXP196657~ KOTA GUNAWAN~~
AE~LL196657~OB196657~SAJED~1~3
SAULDPD400~D~LP196657~20060612~428~321~SGSIN~1~SG~2
SAULDPD450~D~1~20090908000002~IMP196657~1~20090908~210~BL196657~1~~~
5.3 Saudi Load Permit Order - Multiple Import Reference Manifest
SAULDPH100~N~1~1~20090908000001~20090908~EXP196657~ KOTA GUNAWAN~~
AE~LL196657~OB196657~SAJED~1~3
SAULDPD300~1~20090908000001~IMP196657~20090908~SAJED~0~11~IB196657~LL197657~MSC
GUNAWAN~20040807132300~20040818173000~428~321
SAULDPD310~108~111~301~DRY~45~KRKW 1966574~1~1900~9900~~~~~~~
SAULDPD320~210~1~BL196657~KRK196657~SSA~428~USOAK~SAJED~1~SGSIN~~~1~8080~50~1~1~General
Remarks~
SAULDPD330~1~108~50~PK~8080~~5~2~0~2~Highly explosive chemicals~Highly explosive
chemicals~marks no.711~~~
SAULDPD300~1~20090908000001~IMP296657~20090908~SAJED~0~11~IB296657~LL297657~MSC
GUNAWAN~20040807132300~20040818173000~428~321
SAULDPD310~208~111~301~DRY~45~KRKW 2966574~1~1900~9900~~~~~~~
SAULDPD320~310~1~BL296657~KRK196657~SSA~428~USOAK~SAJED~1~SGSIN~~~1~8080~50~1~1~General
Remarks~
SAULDPD330~1~208~50~PK~8080~~5~2~0~2~Highly explosive chemicals~Highly explosive
chemicals~marks no.711~~~
SAULDPD400~N~LP196657~20060612~428~321~SGSIN~1~SG~2
SAULDPD450~N~1~20090908000002~IMP196657~1~20090908~210~BL196657~1~~~
SAULDPD450~N~1~20090908000002~IMP296657~1~20090908~310~BL296657~1~~~
1.9.3.15 EDI Inbound Saudi Manifest Message SAUDIMANIFEST30
Purpose
This guideline document specifies on how the Saudi Manifest EDI message is implemented and how N4 can be
configured to process this particular message.
Functional Definition
Saudi Manifest Order is a Flatfile Edi transferred from Shipping Agents to Terminals in Saudi region. This EDI file
contains list of containers, BLs, BL Item details in a vessel. This Edi message can be for New, Update, Delete
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
353
Part 1: EDI
EDI Message Specifications
EDI Message Types
messages.
As per Saudi EDI standard, at least one BL is expected. Each BL should have at least 1 BL Item. Currently we support
Import and Export manifest.
Oil is not supported. In cargo, Bulk cargo is currently unsupported.
A Saudi Manifest message may contain the following information in same order:
• Saudi Manifest Header - Contains vessel visit, manifest message detail etc..
• Routing Information
• Containers
• Bill Of Ladings
• BL Items
1.1 Objective
The Shipping Agent advises the terminal of the list of Containers, BLs, BL Items and their relationships. The system
should create all this data in N4 after applying all the business validations.
1.2 Saudi Manifest Message (SAUDIMANIFEST30)
N4 supports the Saudi Manifest message as per the specification document version 3.0 received from Red Sea
Gateway Tterminals(RSGT) since the feature is primarily developed for RSGT. A new message class
"SAUDIMANIFEST" has been added in N4.
2.1 Scope
• Container, BL, BL Item are separate individual EDI transactions and therefore they don't communicate between one
another while posting.
(ex: If BL not created because of a error, BL Item will know it. It will say BL sequence number not found in system)
• Oil/Bulk cargo are not supported as on now.
• A BL will be deleted only if all BL Items are deleted. So delete message for BL doesn't make any difference.
• A container will be retired if a delete message is posted for a container.
2.2 SAUIDMANIFEST - Message Functions
Saudi Manifest has a message function (N-New/U-Update/D-Delete) in all segments. But message functions are
applicable only for containers, BLs, and BL Items.
In this Section:
2.2.1 Container. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
2.2.2 Bill Of Lading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
2.2.3 BL Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
354
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.2.1 Container
• Container (New): Use the Unit if it already exists and update the sequence number, otherwise create a Unit.
• Container (Update): Use the Unit if it already exists with given sequence number, otherwise Error out.
• Container (Delete): Delete the Unit matching the sequence number.
2.2.2 Bill Of Lading
• BL (New): Create a new BL, Error out if the sequence number already exists.
• BL (Update): Update the existing BL having a given sequence number. Error out if the sequence number is not
found.
• BL (Delete): Don't do anything as BL gets deleted automatically when all BL Items are deleted.
2.2.3 BL Item
• BL Item(New): Create a new BL Item and Cargo Lot. Error out if the sequence number already exists.
• BL Item(Update): Update existing BL Item having given sequence number. Error out if the sequence number is not
found.
• BL Item(Delete): Delete BL Item, remove Unit from Cargo Lot, delete Cargo Lot, and if there is no more BL Items
on this BL, then delete the BL
3.1 Xenos Map for Saudi Manifest
Since the Saudi manifest is a flat file, it cannot be processed as such in N4. So a new Xml schema
(saudimanifest.xsd) has been defined for SAUDIMANIFEST message class and a flat file Saudi manifest message
has to be converted to this particular xml structure.
For this, a new Xenos map(saudimanifest_30.mgt) has been developed to transform the Saudi manifest flat file to N4
standard xml format during runtime.
Note: The Xenos map is not a built-in map which means there won't be a Message Type (in Message Types UI) in N4
with this map and message class SAUDIMANIFEST. Customers that want to use the Saudi manifest need to get the
latest map from PS and maintain it themselves if any customization is done.
3.2 Xenos Map - Special Handling
In this Section:
3.2.1 Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
3.2.2 Sequence Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
3.2.3 Hard Coded EDI Trading Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
355
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.2.1 Entity Type
As the Saudi manifest contains information various entities, such as BL, BL Item and Container, etc., a separate
attribute is present in Navis standard xml (saudimanifest.xsd) to specify the type of entity to be processed in N4.
Possible values for entity type field are:
CN : Container
BL : Bill Of Lading
BLITEM : BL Item
This attribute is used for following purpose:
• to control the code flow
• to validate the integrity of the transformed xml - for example, if the entity type is BL, the transformed xml should
contain BL information.
• to resolve the keywords specific to an entity
3.2.2 Sequence Numbers
Since the Saudi Manifest is a flat file EDI, it has sequence numbers at each segment level that are used to refer in
further update messages for the same entity and message. The sequence numbers are unique in a particular message
but not across messages. So to make it unique across messages, in N4, in addition to the sequence number of a
particular entity, information such as manifest number and date are used as well.
In N4, once the Saudi manifest flat file is transformed to Navis standard xml, the sequence number of various entity will
be concatenation of many values.
3.2.3 Hard Coded EDI Trading Partner
In N4, to process an inbound EDI, an Edi Session needs to be created, which in turn needs a EDI Trading Partner.
According to ANSI & EDIFACT standards, the EDI Trading partner refers to the sender of the EDI message. But Saudi
manifest flat file does not have such information at all.
So, as of now, for the Saudi manifest developed for Saudi EDI, the EDI trading partner name is hard coded as
"SAUDICUSTOMS". For customers that want to use a different partner name, the Xenos map (saudimanifest.mgt) has
to be customized with the required partner name.
4.1 How to Configure N4 for Saudi Manifest?
To process Saudi Manifest, the following set up has to be done:
• Message Type should be created with Message Class as "SAUDIMANIFEST" and Standard as "FLATFILE".
• A Message map should be created under the message type direction as Receive, import the map file
"saudimanifest_30.mgt" and dictionary file "saudimanifest.fxd".
• In the EDI Configuration UI, create a EDI Trading Partner.
• Create an EDI Mailbox with direction as Receive.
• Create an EDI Session with following attributes:
• Message Class - SAUDIMANIFEST
• Direction - Receive
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
356
Part 1: EDI
EDI Message Specifications
EDI Message Types
• Map - Select Map id as created under Message Type
• Message Delimiter - \n
4.2 Posting Logic
In this Section:
4.2.1 Posting logic for container NEW (N). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.2 Posting logic for container UPDATE (U). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.3 Posting logic for container DELETE (D). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.4 Posting logic for BL NEW (N). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.5 Posting logic for BL UPDATE (U). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.6 Posting logic for BL DELETE (D). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.7 Posting logic for BL Item NEW (N). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.8 Posting logic for BL Item UPDATE (U). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2.9 Posting logic for BL Item DELETE (D). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
358
358
358
358
358
358
358
359
359
357
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Posting logic for container NEW (N)
When a Saudi manifest message is posted for a container with N message type, following are the implications :
• Error out if the unit sequence number already exists.
• If unit already exists, take that unit, otherwise create a new unit.
• Update unit attributes from the EDI message.
4.2.2 Posting logic for container UPDATE (U)
When a Saudi manifest message is posted for a container with U message type, following are the implications :
• Error out if the unit sequence number does't exist.
• Update unit attributes from the EDI message.
4.2.3 Posting logic for container DELETE (D)
When a Saudi manifest message is posted for a container with D message type, following are the implications :
• Error out if the unit sequence number does't exist.
• Error out if the unit is in yard or any state after yard.
• Retire the unit.
4.2.4 Posting logic for BL NEW (N)
When a Saudi manifest message is posted for a BL with N message type, following are the implications :
• Error out if the BL sequence number already exists.
• If BL already exists, take that BL, otherwise create a new BL with a given sequence number.
• Update BL details from the EDI message.
4.2.5 Posting logic for BL UPDATE (U)
When a Saudi manifest message is posted for a BL with U message type, following are the implications :
• Error out if the BL sequence number doesn't exist.
• Update BL details from the EDI message.
4.2.6 Posting logic for BL DELETE (D)
When a Saudi manifest message is posted for a BL with D message type, following are the implications :
• Post completes successfully without any action. (BL will be deleted once all BL Items are deleted).
4.2.7 Posting logic for BL Item NEW (N)
When a Saudi manifest message is posted for a BL Item with N message type, following are the implications:
• Error out if the BL Item sequence number already exists.
• Update the BL Item and cargoLot details from the EDI message.
• Attach the referred unit to this cargoLot.
• Attach referred BL Item to this BL.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
358
Part 1: EDI
EDI Message Specifications
EDI Message Types
• When posting the ediCargoLot element, if the ediCargoLotUnit element is not provided, the posting is not stopped.
4.2.8 Posting logic for BL Item UPDATE (U)
When a Saudi manifest message is posted for a BL Item with U message type, following are the implications :
• Error out if the BL Item sequence number doesn't exist.
• Update the BL Item and cargoLot details from the EDI message.
• Attach the referred unit to this cargoLot.
4.2.9 Posting logic for BL Item DELETE (D)
When a Saudi manifest message is posted for a BL Item with D message type, following are the implications :
• Error out if the BL Item sequence number doesn't exist.
• Get Unit, BL and BL Item from CargoLot.
• Remove the Unit link from the cargo lot.
• Delete the cargo lot and BL Item.
• If there are no more BL Items in this BL, delete the BL.
• Remove the link between BL and Unit.
5. Samples
5.1 Saudi Manifest - NEW
SAUMAFH100~N~1~2~20040708000002~20040705~101630~KOTA GUNAWAN~???? ??????
~~~~~20~AE~3344556~C163E~SAJED~1~20040807132300~20040818173000~20040812~1355~1356~TEST
FOR DIRECT SHIPMENT~30~22
SAUMAFD150~N~1~SG~SGSIN~1~FROM SINGAPORE
SAUMAFD150~N~2~SA~SAJED~1~To Jeddah
SAUMAFD200~N~61~1355~1356~DRY~2591~2438~40~BLJU
1231231~536341~536342~536343~1~4200~8080~0~1~2~3~CEL~MRK~NOTES
SAUMAFD300~N~61~2~LONA123123~0~SMN~~~JOHN REEKS TRADING PTE
LTD???????? ???????? ????????~SAUDI CARS INDUSTRIES~P.O. BOX 6535 DAMMAM POSTAL CODE
31452 SAUDI
ARABIA~6212234~8593090~6535~31452~1355~1356~USOAK~1~TH~SARUH~4~8080~120.0~1~1~GENERAL
REMARKS~RM1
SAUMAFD350~N~61~61~45.0~PK~12~PC~8080~123.0~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
5.2 Saudi Manifest - UDATE
SAUMAFH100~U~1~1~20040708000002~20040705~101630~KOTA GUNAWAN~???? ??????
~~~~~20~AE~3344556~C163E~SAJED~1~20040807132300~20040818173000~20040812~1355~1356~TEST
FOR DIRECT SHIPMENT~30~22
SAUMAFD150~U~1~SG~SGSIN~1~FROM SINGAPORE
SAUMAFD150~U~2~SA~SAJED~1~To Jeddah
SAUMAFD200~U~11~1112~1113~VENTILATED~2591~2438~40~BLJU
4200111~126341~126342~126343~2~4500~7080~0~4~5~6~CEL~MRNO~container has hole
SAUMAFD300~U~11~1~LONA438111~0~SMN~~~MANNAR & CO PTE LTD???????? ???????? ????????
~FINUX TOILET CLEANER INDUSTRIES~P.O. BOX 13 XXX POSTAL CODE 123 SAUDI
ARABIA~12312222~34343223~6535~3234234~32223~32224~USOAK~1~XX~SARUH~4~8080~100.0~1~1~GEN
REM~RM1
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
359
Part 1: EDI
EDI Message Specifications
EDI Message Types
SAUMAFD350~U~11~11~55~SE~8~PC~6080~321~11~2~0~2~9~POTTU PATTASU~???? ???????? ????? ?
MARKS NO.222?1
5.3 Saudi Manifest - DELETE
SAUMAFH100~D~1~2~20040708000002~20040705~101630~KOTA GUNAWAN~???? ??????
~~~~~20~AE~3344556~C163E~SAJED~1~20040807132300~20040818173000~20040812~1355~1356~TEST
FOR DIRECT SHIPMENT~30~22
SAUMAFD150~D~1~SG~SGSIN~1~FROM SINGAPORE
SAUMAFD150~D~2~SA~SAJED~1~To Jeddah
SAUMAFD200~D~21~1355~1356~DRY~2591~2438~40~BLJU
4200222~536341~536342~536343~1~4200~8080~0~1~2~3~XX~MRK~NOTES
SAUMAFD300~D~21~2~LONA438222~0~SMN~~~JOHN REEKS TRADING PTE
LTD???????? ???????? ????????~SAUDI CARS INDUSTRIES~P.O. BOX 6535 DAMMAM POSTAL CODE
31452 SAUDI
ARABIA~6212234~8593090~6535~31452~1355~1356~USOAK~1~TH~SARUH~4~8080~50~1~1~GENERAL
REMARKS~RM1
SAUMAFD350~D~21~21~50~PK~12~PC~8080~123~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
5.3 Saudi Manifest - Multiple container reference
SAUMAFH100~N~1~2~20040708000002~20040705~101630~KOTA GUNAWAN~???? ??????
~~~~~20~AE~3344556~C163E~SAJED~1~20040807132300~20040818173000~20040812~1355~1356~TEST
FOR DIRECT SHIPMENT~30~22
SAUMAFD150~N~1~SG~SGSIN~1~FROM SINGAPORE
SAUMAFD150~N~2~SA~SAJED~1~To Jeddah
SAUMAFD200~N~1~1355~1356~DRY~2591~2438~40~BLJU
4200514~536341~536342~536343~1~4200~8080~0~1~2~3~XX~MRK~NOTES
SAUMAFD200~N~2~1355~1356~DRY~2591~2438~40~BLJU
4200600~536341~536342~536343~1~4200~8080~0~1~2~3~XX~MRK~NOTES
SAUMAFD300~N~1~2~LONA438376~0~SMN~~~JOHN REEKS TRADING PTE
LTD???????? ???????? ????????~SAUDI CARS INDUSTRIES~P.O. BOX 6535 DAMMAM POSTAL CODE
31452 SAUDI
ARABIA~6212234~8593090~6535~31452~1355~1356~USOAK~1~TH~SARUH~4~8080~50~1~1~GENERAL
REMARKS~RM1
SAUMAFD350~N~1~1~50~PK~12~PC~8080~123~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
SAUMAFD300~N~2~2~LONA438377~0~SMN~~~JOHN REEKS TRADING PTE
LTD???????? ???????? ????????~SAUDI CARS INDUSTRIES~P.O. BOX 6535 DAMMAM POSTAL CODE
31452 SAUDI
ARABIA~6212234~8593090~6535~31452~1355~1356~USOAK~1~TH~SARUH~4~8080~50~1~1~GENERAL
REMARKS~RM1
SAUMAFD350~N~1~2~50~PK~12~PC~8080~123~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
SAUMAFD350~N~2~1~50~PK~12~PC~8080~123~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
SAUMAFD350~N~3~2~50~PK~12~PC~8080~123~5~2~0~2~8~HIGHLY EXPLOSIVE
CHEMICALS~???? ???????? ????? ?MARKS NO.711?1
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
360
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.16 EDI Inbound Verified Gross Mass Message VERMAS D.16A
Purpose
This specification provides the definition of the Verified Gross Mass message (VERMAS) to be used in Electronic Data
Interchange (EDI) between trading partners involved in administration, commerce, and transport.
Functional Definition
In relation to a supply chain including the transport of a packed container on an ocean vessel, the Verified Gross Mass
message (VERMAS) permits to submit the Verified Gross Mass of the packed container and supporting information as
legally required by the SOLAS Convention Chapter VI, Part A, Regulation 2.
VERMAS can be used by different parties at different times in the process chain. It is not dedicated to a particular
process step in the transport chain.
VERMAS shall only be used for transmission of the SOLAS Verified Gross Mass and directly related information.
1.1 Objective
The following sections of this document explain how VERMAS message is handled in N4 and scope of its
implementation.
The message can be exchanged between any two parties in the maritime transport chain as per mutual agreement.
The sender may have obtained the Verified Gross Mass himself or he may forward a VGM received from a 3rd party.
Each party in the transport chain can be a sender or a receiver of a VERMAS message.
The VERMAS is a small message for a clearly dedicated purpose. It shall only be used for transmission of the VGM as
required by SOLAS and directly related information
A VERMAS EDI may contain:
• List of containers
• VGM details of each container
• Vessel visit information of each container
1.2 VERMAS Message (VERMAS D.16A)
N4 supports EDIFACT standard VERMAS message, release D & version 16A.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard VERMAS D 16B message & scope of each segment in
N4
Segment
Id
Supported
Qualifier
BGM
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Element Description
Beginning of Message
Supported in N4 ?
Following function codes are
supported currently
1 - Cancellation 5 - Replace 9 Original
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
361
Part 1: EDI
EDI Message Specifications
EDI Message Types
Segment
Id
Supported
Qualifier
Element Description
Supported in N4 ?
DTM
Date/Time/Period
To specify date, and/or time, or period.
This segment is available in .dic
but not used in built-in map
RFF
Reference
To specify a reference.
This segment is available in .dic
but not used in built-in map
DTM
Date/Time/Period
This segment is available in .dic
but not used in built-in map
NAD
Name and Address
To specify the name/address and their
related function, either by C082 only and/or
unstructured by C058 or structured by C080
thru 3207.
This segment is available in .dic
but not used in built-in map
CTA
Contact Information
This segment is available in .dic
but not used in built-in map
COM
Communication Contact
This segment is available in .dic
but not used in built-in map
EQD
CN
Equipment Details
supported
RFF
BN or BM
Reference
supported
LOC
9 - loadPort
11 - dischargePort1
13 - transshipPort
20 - ediCommoditydestinationPort
65 - Optional PORT2
Place/Location Identification
76 originalLoadPort
84 - not supported
85- destinationPort
88 - ediCommodityoriginPort
SEL
MEA
AAE
DTM
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Following code qualifiers are
supported
9, 11, 13, 20, 65, 76, 85, 88
Seal Number
supported.
but only first 4 seal numbers
only will be persisted into n4.
Measurements
only AET and VGM weights are
supported
Date/Time/Period
Date and time when gross mass was
determined. In case of re-determining VGM,
transmission this segment may be used to
identify its latest version.
supported
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
362
Part 1: EDI
Segment
Id
EDI Message Specifications
EDI Message Types
Supported
Qualifier
Element Description
Supported in N4 ?
TDT
Transport Information
To specify information regarding the transport
such as mode of transport, means of
Supported
transport, its conveyance reference number
and the identification of the means of
transport.
RFF
Reference
To specify a reference.
Supported
DOC
Document/Message Details
To identify documents and details directly
related to it.
This segment is available in .dic
but not used in built-in map
DTM
Date/Time/Period
To specify date, and/or time, or period.
Date/Time when the Verified Gross Mass
was determined or Date/Time when the
document/certificate was issued
This segment is available in .dic
but not used in built-in map
NAD
Name and Address
A group to qualify and specify name and
address information in VGM documentation.
Group for specification of a) the party
responsible of SOLAS verified gross mass
This segment is available in .dic
declartion (SOLAS' shipper) b) the person
but not used in built-in map
authorized to sign VGM documents c) the
weighing party for the method specified in
DOC segment d) the party to be referred to
for obtaining identified document e) the party
which had ordered weighing at terminal or
weighing station
CTA
Contact Information
With function code RP the segment is used
for transmission of a signature (person's
name in capital letters).
COM
Communication Contact
This segment is available in .dic
Contact address for party or person
(according to function qualifier in current CTA but not used in built-in map
group)
Supported to map VGM entity/
verifier
The following picture illustrates groups and their segments supported in VERMAS.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
363
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.2 VERMAS - Message Functions
As per EDIFACT standard, Cusres has various message function codes in BGM segment. But N4 supports only
Original & Update function codes.
3.1 N4 Built-in Map
A new built-in map with map id "VERMAS_16A_IN" is added to N4. this map can be used to convert the VERMAS EDI
file into Navis standard VERMAS.xml. This xml in turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• VERMAS_D_16A.mgt - GoXml map
• VERMAS.dic - Edifact standard dictionary
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
364
Part 1: EDI
EDI Message Specifications
EDI Message Types
• VERMAS.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
4 Settings
No special settings are added for this message.
5 Samples
5.1 VERMAS EDI with One Container - Original message function
UNB+UNOA:2+APL+FCP PLANNING+030626:1314+0'
UNH+VERMAS ID+VERMAS:D:16A:UN:SMDG04'
BGM+XXX++9++39'
DTM+137:201602231537:203'
RFF+SI:T/HL007543'
DTM+171:201509160823:203'
NAD+TR+DBF:TERMINALS:306'
CTA+MS+ABC CORP.'
COM+NAME(A)LINE.COM:EM'
EQD+CN+APLU9102398:6346:5+42G1:6346:5+++5'
LOC+9+USOAK+DGE:TERMINALS:306'
LOC+11+NZLYT+DGE:TERMINALS:306'
MEA+AAE+VGM+KGM:22500'
DTM+WAT:201602251632:203'
UNT+16179+1'
UNZ+1+0'
5.2 VERMAS EDI with One Containers but all segments - Original message function
UNB+UNOA:2+APL+FCP PLANNING+030626:1314+0'
UNH+VERMAS ID+VERMAS:D:16A:UN:SMDG04'
BGM+XXX++9++39'
DTM+137:201602231537:203'
RFF+SI:T/HL007543'
DTM+171:201509160823:203'
NAD+TR+DBF:TERMINALS:306'
CTA+MS+ABC CORP.'
COM+NAME(A)LINE.COM:EM'
EQD+CN+APLU9402398:6346:5+42G1:6346:5+APL++5'
RFF+BN:APLBKG01'
LOC+9+USOAK+OAK:TERMINALS:306'
LOC+11+NZLYT+LYT:TERMINALS:306'
LOC+65+SGSIN+SIN:TERMINALS:306'
LOC+76+CNHKG+HKG:TERMINALS:306'
SEL+19876543+AA'
SEL+198765432+AB'
SEL+198765432111+CA'
SEL+198765432123+CU'
MEA+AAE+VGM+KGM:22500'
DTM+WAT:201602201632:203'
TDT+20+123+++HLC:LINES:306+++APL01::11:APL01'
RFF+VON:124'
DOC+SHP:VGM:306+27G92ZZ'
DTM+137:201602230809:203'
NAD+SPC+++BEST FRUIT LTD.+LONG STREET 987:P.O. BOX 321123+NEW YORK CITY++10007+US'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
365
Part 1: EDI
EDI Message Specifications
EDI Message Types
CTA+RP+:authorized person/Weighing company name'
COM+DISPATCH(A)MODERN-FOOTWEAR.COM:EM'
UNT+16179+1'
UNZ+1+0'
5.3 VERMAS EDI for Replace Message Function
UNB+UNOA:2+APL+FCP PLANNING+030626:1314+0'
UNH+VERMAS ID+VERMAS:D:16A:UN:SMDG04'
BGM+XXX++5++39'
EQD+CN+APLU9402398:6346:5+42G1:6346:5+++5'
MEA+AAE+VGM+KGM:34500'
DTM+WAT:201602231632:203'
NAD+TR+DBF:TERMINALS:306'
CTA+RP+:updated3 person/Weighing company name'
UNT+16179+1'
UNZ+1+0'
5.4 VERMAS EDI Message with Cancel message function
UNB+UNOA:2+APL+FCP PLANNING+030626:1314+0'
UNH+VERMAS ID+VERMAS:D:16A:UN:SMDG04'
BGM+XXX++1++39'
EQD+CN+APLU9402398:6346:5+42G1:6346:5+++5'
UNT+16179+1'
UNZ+1+0'
6 Test Instructions
The following section explains how to setup and test a VERMAS message.
Pre-requisite for posting a VERMAS EDI message
Step - 1: Create a session for VERMAS message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
366
Part 1: EDI
EDI Message Specifications
EDI Message Types
Posting a VERMAS EDI message
Step - 3: Post VERMAS Original message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
367
Part 1: EDI
EDI Message Specifications
EDI Message Types
Ensure batch is completed without any error message and unit is created.
VERMAS Original message posted successfully and event is created with field changes.
Step - 4: Post VERMAS EDI Replace message
VERMAS Replace message posted successfully and VGM properties are updated, history event is recorded with field
changes.
Step - 5: Post VERMAS EDI Cancel message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
368
Part 1: EDI
EDI Message Specifications
EDI Message Types
VERMAS Cancel message nullified weight, verified date and updated verifier. History event is recorded for cancel
message with field changes.
1.9.3.17 EDI Inbound Vessel Schedule Message - IFTSAI
D.00B
Purpose
The IFTSAI vessel schedule message is recommended by SMDG as the message for use by ship owners, tonnage/
operation centers , terminal operators, shipping lines etc.to exchange information about the vessel actual arrival/
departure and vessel schedules with trading partners.
"A message from/to a liner agent to/from a local authority (e.g. port authority), Container terminals , Schedule Portal
or consortia member lines , to inform the parties of the long term schedule , mid term schedule, short term schedule
or schedule updates, giving information on the actual vessel schedule information and container or cargo
operations." Shipping lines use the message for broadcasting regular schedule information to customers, port
community centers, container terminals and amongst partner lines of shipping consortia.
Functional Definition
The IFTSAI message is used to transmit a confirmation that a vessel has arrived or departed from a terminal, and can
be used to confirm departure to a carrier, another terminal, or another interested party (such as a tracking service).
The information required reporting arrival and departure is identical, with the different functions being indicated by a
different code in DE 1001 of the BGM segment. The ocean main carriage vessel/voyage is identified in segment group
4 Transport Schedule Details. The TDT segment includes voyage number, vessel operator, Lloyd’s number and vessel
name. In segment 5 Schedule locations, the LOC segment identifies the port by the UN-Locode. The DTM segment
identifies date and time of the vessel arrival or departure. Multiple combinations of vessel/arrival/departure are included
in the same message by repeating the above segments.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
369
Part 1: EDI
EDI Message Specifications
EDI Message Types
The function of this message is to request transport schedule or availability information and to answer to such a
request.
1.1 Objective
The purpose IFTSAI message is:
• To exchange of vessel actual arrival/departure and vessel schedules with trading partners
• To inform the parties of the long term schedule , mid term schedule, short term schedule or schedule updates, giving
information on the actual vessel schedule information and container or cargo operations.
Shipping lines use the message for broadcasting regular schedule information to customers, port community centres,
container terminals and amongst partner lines of shipping consortia.
The IFTSAI message is used to transmit a confirmation that a vessel has arrived or departed from a terminal, and can
be used to confirm departure to a carrier, another terminal, or another interested party (such as a tracking service).
A IFTSAI EDI may contain:
• Vessel Schedule
• Carrier Service
• Routing Points
1.2 IFTSAI Message (IFTSAI D.00B)
N4 supports EDIFACT standard IFTSAI message, release D & version 00B.
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
370
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.1 Scope
The following picture illustrates the groups and their segments supported in EDIFACT standard IFTSAI D 00B
message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
371
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.2 IFTSAI - Message Functions
The IFTSAI posting should do the following:
Original
• Create Carrier Service (the segment from which service name should be picked to be discussed), carrier itinerary
based on the LOC+153 segments (port calls), create vessel visit by attaching the service to the visit.
• The vessel visit should have details like ETA/ETD/STA/STD (if sent in EDI)
• The creation of Adhoc Vessel while posting IFTSAI should be governed by a setting.
• The creation of port rotation based on the LOC segments should be governed by a setting
If creation of port rotation is allowed, then the port rotation should be created by including all the ports specified in
the LOC segments like (LOC+9/11/153)
Creation of new vessel
If the vessel for which schedule is being sent in not available in the system, the vessel needs to be created in N4
based on a setting.
While creating new vessel, the following needs to be populated:
• Vessel id : Lloyds's id or call sign needs to be used based on a setting
• vessel name : as sent in EDI (TDT segment)
• Lloyds' id : as sent in EDI (TDT segment)
• Call sign : as sent in EDI (RFF+VM segment)
• vessel class : UNKNOWN
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
372
Part 1: EDI
EDI Message Specifications
EDI Message Types
• Vessel classification : Deepsea
• Line operator : as sent in TDT segment
New vessel should be created only when the message is original and message is sent by vessel operator (if already
existing vessel).
If both Lloyds id and call sign not received in EDI, throw error.
Determination of Carrier Service Name:
Option 1:
Option to set Carrier service name should be provided in the batches screen (Update Carrier Service -> similar to the
Update Carrier Visit to map the xml of a loadlist/dischlist/stowplan), instead of trying to determine it based on the port
rotation of the IFTSAI-message (or at least it should be parametrized to keep all options open). Provide as well a
column/field in the batches screen and EDI batch inspector to display the shipping line carrier service as an indicator to
map it to the N4 Carrier Service.
Option 2:
Alternatively lines can send the service name in FTX segment (FTX+ZZZ) or in a mutually agreed segment/element.
Cutoff times
The various cut off times needs to be picked from the following DTM segments:
DTM+180 - Dry cutoff
DTM+50- Hazardout cutoff (Full)
Replace
• Replaces all the service, vessel voyage rotation, Arrival/Departure information
• Replaces all the portcalls with the new port call details specified in the EDI.
• Only the main partner can send Replace message
• The logic should be as follows:
▪ Clear the existing itinerary
▪ Repopulate the carrier service with the new itinerary
Change/Update
• Updates only the affect port calls specified in the message (like ETA/ETD etc)
• Other partners can update only their voyage number/cutoff details (seen in the Lines section of Vessel Visit
Inspector). If there is no entry for the line in the Lines section, add an entry and update the respective voyage
details.
• If other partners send without main voyage, use vessel name with ETA to find the vessel visit
Delete
• Deletes specific port calls only that are specified in the EDI.
• Only the main partner/vessel owner can send the delete message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
373
Part 1: EDI
EDI Message Specifications
EDI Message Types
Add
• Add specific port calls to the itinerary
3.1 N4 Built-in Map
A new built-in map with map id "IFTSAI_IN" is added to N4. this map can be used to convert the VERMAS EDI file into
Navis standard VERMAS.xml. This xml in turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• iftsai_D_00_B.mgt - GoXml map
• iftsai.dic - Edifact standard dictionary
• vesselschedule.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
4.1 How to Configure N4 for IFTSAI
To use IFTSAI in N4:
• main partner - creates the visit
• other partners - updates voyage nbr
• main partner - updates ETA
Some considerations/validations:
• If other partners send without main voyage, use vessel name with ETA to find the vessel visit
• If IFTSAI EDI is sent for a vessel visit for updation past ETA, an error should be logged
• When creating new vessel visit, the vessel visit phase should be inbound
• Vessel visit should be created only when the message is sent by the vessel operator.
• Partners should be allowed to update only their respective voyage details
• Cancel is allowed only if the vessel visit phase is in created/inbound phase
Segments used to identify the vessel/voyage information:
• TDT -> inbound voyage number; Lloyds number and vessel name
• RFF+VM -> call sign
• RFF-VON -> outbound voyage number
The IFTSAI posting should do the following:
Original:
Create Carrier Service (the segment from which service name should be picked to be discussed), carrier itinerary
based on the LOC+153 segments (port calls), create vessel visit by attaching the service to the visit.
The vessel visit should have details like ETA/ETD/STA/STD (if sent in EDI)
The creation of Adhoc Vessel while posting IFTSAI should be governed by a setting.
the creation of port rotation based on the LOC segments should be governed by a setting
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
374
Part 1: EDI
EDI Message Specifications
EDI Message Types
If creation of port rotation is allowed, then the port rotation should be created by including all the ports specified in the
LOC segments like (LOC+9/11/153)
Creation of new vessel
If the vessel for which schedule is being sent in not available in the system, the vessel needs to be created in N4
based on a setting.
While creating new vessel, the following needs to be populated:
Vessel id : Lloyds's id or call sign needs to be used based on a setting
vessel name : as sent in EDI (TDT segment)
Lloyds' id : as sent in EDI (TDT segment)
Call sign : as sent in EDI (RFF+VM segment)
vessel class : UNKNOWN
Vessel classification : Deepsea
Line operator : as sent in TDT segment
New vessel should be created only when the message is original and message is sent by vessel operator (if already
existing vessel).
If both Lloyds id and call sign not received in EDI, throw error.
Determination of Carrier Service Name:
Option 1:
Option to set Carrier service name should be provided in the batches screen (Update Carrier Service -> similar to the
Update Carrier Visit to map the xml of a loadlist/dischlist/stowplan), instead of trying to determine it based on the port
rotation of the IFTSAI-message (or at least it should be parametrized to keep all options open). Provide as well a
column/field in the batches screen and EDI batch inspector to display the shipping line carrier service as an indicator to
map it to the N4 Carrier Service.
Option 2:
Alternatively lines can send the service name in FTX segment (FTX+ZZZ) or in a mutually agreed segment/element.
Cutoff times
The various cut off times needs to be picked from the following DTM segments:
DTM+180 - Dry cutoff
DTM+50- Hazardout cutoff (Full)
Replace:
Replaces all the service, vessel voyage rotation, Arrival/Departure information
Replaces all the portcalls with the new port call details specified in the EDI.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
375
Part 1: EDI
EDI Message Specifications
EDI Message Types
Only the main partner can send Replace message
The logic should be as follows:
Clear the existing itinerary
Repopulate the carrier service with the new itinerary
Records the batch details in the Inbound EDI tab in the Vessel Inspector.
Updates the carrier visit in the Batches view (on page 172), Batches view (on page 823).
Change/Update:
Updates only the affect port calls specified in the message (like ETA/ETD etc)
Other partners can update only their voyage number/cutoff details (seen in the Lines section of Vessel Visit Inspector).
If there is no entry for the line in the Lines section, add an entry and update the respective voyage details.
If other partners send without main voyage, use vessel name with ETA to find the vessel visit
Delete:
Deletes specific port calls only that are specified in the EDI.
Only the main partner/vessel owner can send the delete message
Add:
Add specific port calls to the itinerary
Cancel:
Records the batch details in the Inbound EDI tab in the Vessel Inspector.
Updates the carrier visit in the Batches view (on page 172), Batches view (on page 823).
Once the vessel visit is canceled, N4 updates the vessel visit phase to Canceled and records an event in the Vessel
Inspector History, Events tab.
4.2 Settings
Based on the following newly added settings, N4 controls the Vessel visits through the EDI message:
• ARGOEDI013 (EDI_ADHOC_VESSEL_CREATION): If the setting is set to ALLOWED, N4 creates the vessel
during the EDI IFTSAI message posting process. The Default value for this setting is NOT ALLOWED.
• ARGOEDI014 (EDI_ADHOC_ITINERARY_CREATION): If the setting is set to ALLOWED, N4 creates the carrier
itinerary during the EDI IFTSAI message posting process. The Default value for this setting is NOT ALLOWED.
• ARGOEDI015 (EDI_VESSEL_ID_CONVENTION): You can select Call Sign or the Lloyds so that based on this
value N4 creates the Vessel ID.
• ARGOEDI016 (EDI_UNIQUE_VESSEL_VISIT_ID): You can select the format for the Vessel Visit ID for this setting.
The values are MMYY, and SSS.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
376
Part 1: EDI
EDI Message Specifications
EDI Message Types
5 Samples
UNB+UNOA:2+APL+GA+040402:0941+44'
UNH+000031+IFTSAI:D:00B:UN:SMDG2.0'
BGM+404+000031+9'
DTM+137:201702010830:203'
FTX+AAI+++VESSEL ARRIVAL/DEPARTURE SCHEDULE'
TDT+20+14+1++APL01:172:20+++8407319:146:: Vessel Name:DE'
RFF+VON:14'
FTX+ACB++552+ZZZ+306+DGBK'
LOC+9+USOAK:139:6:OAK'
LOC+11+SGSIN:139:6:SIN'
LOC+153+DEHAM:139:6:HAMBURG'
LOC+153+NLRTM:139:6:RTM'
LOC+153+SGSIN:139:6:SIN'
LOC+153+USOAK:139:6:OAK'
NAD+CA+APL:160:87'
UNT+27+000031'
6 Test Instructions
The following section explains how to setup and test a Vermas message.
Pre-requisite for posting the IFTSAI EDI message
Create a session for IFTSAI message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
377
Part 1: EDI
EDI Message Specifications
EDI Message Types
Posting the IFTSAI EDI message
Post IFTSAI Original message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
378
Part 1: EDI
EDI Message Specifications
EDI Message Types
Ensure batch is completed without any error message and vessel visit is created
1.9.3.18 EDI Outbound Container Discharge/Loading Report
Message - COARRI D 95B
Purpose
This specification provides the definition of the Container discharge/loading report message (COARRI) to be used in
Electronic Data Interchange (EDI) between trading partners involved in administration, commerce and transport.
Functional Definition
A message by which the container terminal reports that the containers specified have been discharged from a
seagoing vessel (discharged as ordered, overlanded or shortlanded), or have been loaded into a seagoing vessel.
This message is part of a total set of container-related messages. These messages serve to facilitate the intermodal
handling of containers by streamlining the information exchange. The business scenario for the container messages is
clarified in a separate document, called: 'Guide to the scenario of EDIFACT container messages'.
1.1 Objective
Business area: Loading and discharging of containers/equipment
Sending functions include: Container terminal, Stevedore
Receiving functions include: Ship's agent, Liner agent
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
379
Part 1: EDI
EDI Message Specifications
EDI Message Types
In the context of the 'Guide to the scenario of EDIFACT container messages' (as referred to at the start of section 1)
the following guidelines, rules and functionality apply to this Container discharge/loading report message:
• The message contents can be uniquely identified by a combination of the following data elements:
▪ ordering customer, coded (NAD)
▪ ordering customer agent, coded (NAD)
▪ container discharge/loading order reference (RFF)
The ordering customer agent, coded is needed to supplement the unique identification only in the following situation:
the agent acts on behalf of several ordering customers issuing the same range of reference numbers for each
customer. E.g., the ship's agent acts on behalf of several shipping lines issuing for each shipping line the same range
of numbers.
• A message contains information on only one visit/conveyance of a seagoing container vessel either arriving or
departing.
• A message contains a report of either discharged or loaded containers from or into the seagoing container vessel.
One report message does not necessarily cover all loaded/discharged containers.
• An indicator for the equipment status may be completed on container level (EQD-segment), e.g., import, overlanded
or shortlanded (for a discharged container) or export (for a loaded container).
• One shipping line can be specified on message level.
• The seagoing container vessel and sea voyage number can be specified on message level.
• For each container its cell position on board the container vessel and its port of discharge can be given.
• For each container dangerous goods information can be specified.
• A supplementary container reference number (container sequence number) is used to refer to the information of the
container(s) in the loading order message, if the container prefix and number was not completed in that message.
• Goods item details cannot be completed.
2.1 Scope
The following illustrate the segments of EDIFACT standard COARRI D 95B message & scope of each segment in N4.
This section should be read in conjunction with the Branching Diagram and the Segment Table, which indicate
mandatory, conditional, and repeating requirements.
0010 UNH, Message header
A service segment starting and uniquely identifying a message. The message type code for the Container discharge/
loading report message is COARRI.
Note: Container discharge/loading report messages conforming to this document must contain the following data in
segment UNH, composite S009:
BGM, Beginning of message
A segment to indicate the beginning of a message and to transmit identifying number and the further specification of
the message type (in data element 1001: Document/message name, coded), such as Loading report, Discharge
report.0020
0030 FTX, Free text
A segment to specify free form or processable supplementary information, such as: - change information
0040 RFF, Reference
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
380
Part 1: EDI
EDI Message Specifications
EDI Message Types
A segment to express a reference which applies to the entire message, such as: - container discharge/loading order
reference - reference to previous message
0050 Segment Group 1: TDT-RFF-LOC-DTM
A group of segments to indicate the main carriage means of transport.
0060 TDT, Details of transport
A segment identifying the voyage of the vessel relevant to the message (main transport).
0070 RFF, Reference
A segment identifying a relevant reference number, such as: - shipping - syndicate - marketing organization conference code
0080 LOC, Place/location identification
A segment to identify a location related to the means of transport, such as: - place of departure/arrival (terminal within
the port)
0090 DTM, Date/time/period
A segment identifying a date/time related to the arrival or departure of the vessel, such as: - estimated date/time of
arrival/departure
0100 Segment Group 2: NAD-CTA
A group of segments to identify a party and related contacts.
0110 NAD, Name and address
A segment to identify the party's name, address, and function, and other addresses, such as: - message recipient message sender - ordering customer - ordering customer agent
0120 CTA, Contact information
A segment to identify a person or department of a message sender and/or message recipient, such as: - information
contact
0130 Segment Group 3: EQD-RFF-TMD-DTM-LOC-MEA-DIM-TMP-RNG-SEL-FTXDGS-EQA-PIA-SG4-SG5-NAD A group of segments to specify containers either loaded or discharged; in the latter
case - only in case of shortlanded - the group of segments is to specify containers that had to be discharged (according
to the discharge order message).
In a normal discharge report and load report message the container details are only required if they differ from the
details given in the respective order message. In case of overlanded containers this group will contain the full container
details giving as much information as possible. In case of shortlanded containers this group will only contain the
container prefix and number.
0140 EQD, Equipment details
A segment identifying a container, container size/type. The equipment status may be e.g. overlanded, shortlanded,
import, export.
0150 RFF, Reference
A segment identifying a relevant reference number, such as: - container sequence number - booking reference number
0160 TMD, Transport movement details
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
381
Part 1: EDI
EDI Message Specifications
EDI Message Types
A segment to indicate a Full Container Load (FCL) or a Less than Full Container Load (LCL).
0170 DTM, Date/time/period
A segment to identify a date/time related to the equipment, such as: - actual arrival/departure date/time - CSC
expiration date (International Convention for Safe Containers)
0180 LOC, Place/location identification
A segment to identify a location or country related to the equipment, such as: - stowage cell - (final) place/port of
discharge - transhipment place - place of delivery - country of origin/destination
0190 MEA, Measurements
A segment specifying a physical measurement related to the equipment, such as: - gross weight
0200 DIM, Dimensions
A segment specifying physical dimensions related to the equipment, such as: - gross dimensions - off standard
dimension general - off standard dimension left - off standard dimension right - off standard dimension back - off
standard dimension front
0210 TMP, Temperature
A segment which identifies the transport temperature setting of the container.
0220 RNG, Range details
A segment to specify the transport temperature range setting of the container.
0230 SEL, Seal number
A segment identifying a seal number related to the equipment.
0240 FTX, Free text
A segment to specify supplementary information related to the equipment, such as: - blockade reason - government
inspection service - container loading remarks - container remarks - container order information - additional remarks
concerning the container - container safety convention plate - continuous examination program (ACEP)
0250 DGS, Dangerous goods
A segment to identify the UN-number and the class of the dangerous goods loaded in the container.
0260 EQA, Attached equipment
A segment to identify clip-on units, such as: - generator sets
0270 PIA, Additional product id
A segment to specify a commodity code relating to goods in the container.
0280 Segment Group 4: DAM-COD
A group of segments to specify damage details related to the equipment.
0290 DAM, Damage
A segment to specify equipment damages, such as the point of the damage on the quipment, and the type of damage.
0300 COD, Component details
A segment to specify component details of the damaged equipment.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
382
Part 1: EDI
EDI Message Specifications
EDI Message Types
0310 Segment Group 5: TDT-LOC-DTM
A group of segments to specify the planned on-carriage details in case this message is a discharge report message.
0320 TDT, Details of transport
A segment to identify the on-carriage transport details of the mode, means of transport by which the container will
depart after being discharged.
0330 LOC, Place/location identification
A segment identifying a location related to the transport details, such as: - place of departure
0340 DTM, Date/time/period
A segment to specify a date/time relating to the on-carriage transport, such as arrival or departure date/time.
0350 NAD, Name and address
A segment to specify a related address or party, such as: - container operator
0360 CNT, Control total
A segment to specify the number of containers in the message, explicitly given by the sender.
0370 UNT, Message trailer
A service segment ending a message, giving the total number of segments in the message and the control reference
number of the message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
383
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert COARRI XML message into EDI file . This EDI in turn used for
further processing.
Following are the related files, part of N4 application and can be downloaded:
• coarri_D_95B.mgt- GoXml map
• coarri.dic -Edifact standard dictionary
• activity.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
384
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How to Configure N4 for CODECO ?
N/A
4.2 Special Cases
• Session level extract based on the last run timestamp.
• Vessel Inspector > Outbound Edi > click Add > Extract.
4.3 Settings
N/A
5 Samples
UNB+UNOA:2++MEN+20170912:0921+91'
UNH+23+COARRI:D:95B:UN:ITG10'
BGM+98++9'
TDT+20+1+1++MEN:172:ZZZ+++AB1:146::VVRU4291'
LOC+11+XXXXX:139:6'
LOC+9+USOAK:139:6'
DTM+132:201709080000:203'
DTM+133:201709090000:203'
NAD+CA+MEN:160'
NAD+CF+MEN:160:ZZZ'
EQD+CN+KIRU5384291+2200:102:5++3+4'
RFF+ABT'
TMD+2'
DTM+203:201709060821:203'
LOC+147+0123456:139:5'
LOC+11+SGSIN:139:6'
LOC+9+XXXXX:139:6'
MEA+AAE+G+KGM:1900'
TDT+30++9+9'
CNT+16:1'
UNT+000020+23'
UNH+24+COARRI:D:95B:UN:ITG10'
BGM+270++9'
TDT+20+2+1++MEN:172:ZZZ+++AB1:146::VVRU4291'
DTM+132:201709080000:203'
DTM+133:201709090000:203'
NAD+CA+MEN:160'
NAD+CF+MEN:160:ZZZ'
EQD+CN+COAR1122003+2230:102:5++2+5'
RFF+ABT'
TMD+3'
DTM+203:201709070415:203'
LOC+147+0040521:139:5'
LOC+11+SGSIN:139:6'
LOC+9+USOAK:139:6'
MEA+AAE+G+KGM:12333'
DIM+5+CMT:2'
DIM+6+CMT:1'
DIM+7+CMT::4'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
385
Part 1: EDI
EDI Message Specifications
EDI Message Types
DIM+8+CMT::3'
DIM+9+CMT:::6'
TMP+2+12.0:CEL'
TDT+10++3+31'
CNT+16:1'
UNT+000024+24'
UNH+25+COARRI:D:95B:UN:ITG10'
BGM+98++9'
TDT+20+1+1++MEN:172:ZZZ+++AB1:146::VVRU4291'
LOC+11+XXXXX:139:6'
LOC+9+USOAK:139:6'
DTM+132:201709080000:203'
DTM+133:201709090000:203'
NAD+CA+MEN:160'
NAD+CF+MEN:160:ZZZ'
EQD+CN+COAR1122001+2200:102:5++3+5'
RFF+ABT'
TMD+3'
DTM+203:201709070421:203'
LOC+147+0015144:139:5'
LOC+11+USOAK:139:6'
LOC+9+SGSIN:139:6'
MEA+AAE+G+KGM:12343'
TDT+30++1+13'
CNT+16:1'
UNT+000020+25'
UNH+26+COARRI:D:95B:UN:ITG10'
BGM+98++9'
TDT+20+1+1++MEN:172:ZZZ+++AB1:146::VVRU4291'
LOC+11+XXXXX:139:6'
LOC+9+USOAK:139:6'
DTM+132:201709080000:203'
DTM+133:201709090000:203'
NAD+CA+MEN:160'
NAD+CF+MEN:160:ZZZ'
EQD+CN+COAR1122002+2230:102:5++3+5'
RFF+ABT'
TMD+3'
DTM+203:201709070421:203'
LOC+147+0040522:139:5'
LOC+11+USOAK:139:6'
LOC+9+SGSIN:139:6'
MEA+AAE+G+KGM:12343'
TMP+2+12.0:CEL'
TDT+30++1+13'
CNT+16:1'
UNT+000021+26'
UNZ+4+91'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
386
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.19 EDI Outbound Container Gate-In/Gate-Out Report
Message - EDIFACT CODECO D 95B
Purpose
This specification provides the definition of the Container gate-in/gate-out report message (CODECO) to be used in
Electronic Data Interchange (EDI) between trading partners involved in administration, commerce and transport.
Functional Definition
A message by which a terminal, depot, etc. confirms that the containers specified have been delivered or picked up by
the inland carrier (road, rail or barge). This message can also be used to report internal terminal container movements
(excluding loading and discharging the vessel).
This message is part of a total set of container-related messages. These messages serve to facilitate the intermodal
handling of containers by streamlining the information exchange. The business scenario for the container messages is
clarified in a separate document, called: 'Guide to the scenario of EDIFACT container messages'.
1.1 Objective
Business area: Pre- and on-carriage transport of containers/equipment.
Sending functions include: Container depot, Inland terminal, Container freight station
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
387
Part 1: EDI
EDI Message Specifications
EDI Message Types
Receiving functions include: Shipping agent, Logistic center, Shipper (copy), Freight forwarder (copy) and Inland carrier
(copy)
In the context of the 'Guide to the scenario of EDIFACT container messages' (as referred to at the start of section 1)
the following guidelines, rules and functionality apply to this Container gate-in/gate-out report message:
• The message contents can be uniquely identified by a combination of the following data elements:
▪ ordering customer, coded (NAD)
▪ ordering customer agent, coded (NAD)
▪ container announcement reference number (RFF)
The ordering customer agent, coded is needed to supplement the unique identification only in the next situation: the
agent acts on behalf of several ordering customers issuing the same range of reference numbers for each customer.
E.g. the ship's agent acts on behalf of several shipping lines issuing for each shipping line the same range of numbers.
• A copy of this message may be sent e.g. to the shipper, freight forwarder, the inland waterways and rail carriers,
according to the communication addresses as mentioned in the Container announcement.
• One message may contain several containers.
• A supplementary container reference (container sequence number) is used to refer to the information of the
container(s) in the Container announcement, if the container prefix and number was not completed in that message.
• An indicator for the transport status (i.e. export, import, transhipment or continental) is to be completed on container
level (EQD-segment).
• One shipping line can be specified on message level.
• The seagoing vessel and sea voyage number can be specified on message level.
• Inland transport details can be specified for each individual container.
• For each container its place of discharge or its position of loading (stowage cell) in/on the means of inland transport
can be specified.
• In case of export the port of discharge and any port of transhipment can be specified for each individual container.
• The date/time of pick-up and final address of positioning or the date/time of delivery must be given for each
container.
• For each container seals can be specified affixed by the shipper, container freight station, terminal, sea carrier and
Customs.
1.2 Container Gate-In/Gate-Out Report Message (CODECO D 95B)
N4 supports EDIFACT standard CODECO D 95B Container gate-in/gate-out report message, version D and
release 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following sections illustrates the segments of EDIFACT standard CODECO D 95B Container gate-in/gate-out report
message & scope of each segment in N4.
0010 | UNH, Message header
A service segment starting and uniquely identifying a message. The message type code for the Container gate-in/gateout report message is CODECO.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
388
Part 1: EDI
EDI Message Specifications
EDI Message Types
Note: Container gate-in/gate-out report messages conforming to this document must contain the following data in
segment UNH, composite S009:
0020 BGM, Beginning of message
A segment to indicate the beginning of a message and to transmit identifying number and the further specification of
the message type (in data element 1001: Document/message name, coded), such as Gate-in report, Gate-out report.
0030 FTX, Free text
A segment to specify free form or processable supplementary information, such as: - change information
0040 RFF, Reference
A segment to express a reference which applies to the entire message, such as: - reference to previous message container announcement reference number
0050 Segment Group 1: TDT-RFF-LOC-DTM
A group of segments to indicate information relating to the main carriage stage of the transport (sea).
0060 TDT, Details of transport
A segment to indicate transport details related to the main carriage stage of the transport (sea), such as carrier/liner
service.
0070 RFF, Reference
A segment to provide a reference for the liner service, such as: - conference - marketing organization - syndicate vessel sharing agreement
0080 LOC, Place/location identification
A segment to indicate a place/port corresponding to the main carriage stage.
0090 DTM, Date/time/period
A segment to indicate a date/time relating to the main carriage.
0100 Segment Group 2: NAD-CTA
A group of segments to identify a party and/or addresses and related contacts.
0110 NAD, Name and address
A segment to identify the party's name and address, and function, such as: - message recipient - message sender ordering customer - ordering customer agent
0120 CTA, Contact information
A segment to identify a person or department of a message sender and/or message recipient, such as: - information
contact
0130 Segment Group 3: GID-HAN-FTX-PIA-MEA-TMP-RNG-SGP-SG4
A group of segments to describe the goods items (to be) stuffed in or (to be) stripped from the containers.
0140 GID, Goods item details
A segment to identify a goods item (to be) stuffed in or (to be) stripped from the containers.
0150 HAN, Handling instructions
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
389
Part 1: EDI
EDI Message Specifications
EDI Message Types
A segment to specify handling instructions relating to the goods item, such as: - hazardous cargo - off-dimensions Customs clearance
0160 FTX, Free text
A segment to describe the goods item or to provide special instructions.
0170 PIA, Additional product id
A segment to identify a commodity code.
0180 MEA, Measurements
A segment to specify a measurement, other than dimensions, for the goods item.
0190 TMP, Temperature
A segment to specify a temperature setting for a goods item.
0200 RNG, Range details
A segment to specify a temperature range setting for a goods item.
0210 SGP, Split goods placement
A segment to identify a container in which goods are transported.
0220 Segment Group 4: DGS-FTX
A group of segments to specify dangerous goods details related to the goods item. One goods item may be in different
dangerous goods classes.
0230 DGS, Dangerous goods
A segment to indicate the dangerous goods regulations for the corresponding mode of transport, class of dangerous
goods, additional dangerous goods code, UN-number and shipment flash point.
0240 FTX, Free text
A segment to specify supplementary details related to the dangerous goods, such as: - dangerous goods technical
name - dangerous goods additional information
0250 Segment Group 5: EQD-RFF-TMD-DTM-LOC-MEA-DIM-SEL-FTX-EQA-SG6-NAD A group of segments to specify containers in which goods are
0260 EQD, Equipment details
A segment to specify a container, container size and type used in the transport, and full/empty indication.
0270 RFF, Reference
A segment to specify the identifying number associated with the container, such as: - container sequence number booking reference number (sea)
0280 TMD, Transport movement details
A segment to indicate a Full Container Load (FCL) or a Less than Full Container Load (LCL).
0290 DTM, Date/time/period
A segment to indicate date and time relating to pick-up and delivery of a container, such as: - actual equipment
collection/pick-up date/time - actual delivery date/time
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
390
Part 1: EDI
EDI Message Specifications
EDI Message Types
0300 LOC, Place/location identification
A segment to specify ports/locations associated with the transport of a container, such as: - stowage cell - place of
discharge
0310 MEA, Measurements
A segment to specify measurement, other than dimensions, associated with the container, such as: - gross weight
0320 DIM, Dimensions
A segment to specify dimensions applicable to the container, such as: - external equipment dimensions
0330 SEL, Seal number
A segment to identify seal and seal issuer associated with the container, such as shipper, consolidator, carrier (sea),
Customs or terminal operator.
0340 FTX, Free text
A segment to specify processable supplementary information associated with the container, such as: - damage
remarks
0350 EQA, Attached equipment
A segment to identify related container and means of transport details (rail), such as: - rail car
0360 Segment Group 6: DAM-COD
A group of segments to specify damage details related to the equipment.
0370 DAM, Damage
A segment to specify equipment damages, such as the point of the damage on the equipment, and the type of
damage.
0380 COD, Component details
A segment to specify component details of the damaged equipment.
0390 Segment Group 7: TDT-LOC-DTM
A group of segments to indicate details of the movement of containers by sea and by inland carriers, such as mode
and means of transport and locations.
0400 TDT, Details of transport
A segment to indicate information related to the inland transport stage (road, rail or inland water), such as mode of
transport, identification of the means of transport and inland carrier.
0410 LOC, Place/location identification
A segment to specify ports/locations associated with inland transport of a container, such as: - place of departure place of arrival
0420 DTM, Date/time/period
A segment to specify a date/time relating to the transport details, such as arrival or departure date/time.
0430 NAD, Name and address
A segment to specify the actual address where a piece of euqipment is to be delivered finally (final place of
positioning).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
391
Part 1: EDI
EDI Message Specifications
EDI Message Types
0440 CNT, Control total
A segment to specify the number of containers in the message,.
0450 UNT, Message trailer
A service segment ending a message, giving the total number of segments in the message and the control reference
number of the message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
392
Part 1: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI Message Specifications
EDI Message Types
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
393
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How to Configure N4 for CODECO ?
N/A
4.2 Special Cases
N/A
4.3 Settings
N/A
5 Samples
UNB+UNOA:2++LJO+20170912:0940+93'
UNH+1+CODECO:D:00A:UN:ITG13'
BGM+34++9'
TDT+20+LJOOB+1++POPEYE:172:ZZZ+++LJOLYD:146::LJOV'
LOC+9+USOAK:139:6'
NAD+CF+LJO:160:ZZZ'
EQD+CN+LJPW6112007+4200:102:5++2+5'
TMD+3'
DTM+7:201709120940:203'
LOC+9+USOAK:139:6'
LOC+11+SGSIN:139:6'
MEA+AAE+G+KGM:32000'
TDT+1++3++:172:ZZZ+++:146'
CNT+16:1'
UNT+000014+1'
UNH+2+CODECO:D:00A:UN:ITG13'
BGM+34++9'
TDT+20+LJOOB+1++POPEYE:172:ZZZ+++LJOLYD:146::LJOV'
LOC+9+USOAK:139:6'
NAD+CF+LJO:160:ZZZ'
EQD+CN+LJPX6112008+4200:102:5++2+5'
TMD+3'
DTM+7:201709120940:203'
LOC+9+USOAK:139:6'
LOC+11+SGSIN:139:6'
MEA+AAE+G+KGM:42000'
TDT+1++3++:172:ZZZ+++:146'
CNT+16:1'
UNT+000014+2'
UNZ+2+93'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
394
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.20 EDI Outbound Invoice Message - ANSI 810
Purpose
This specification provides the definition of the Billing invoice message (ANSI X12 810) to be used in Electronic Data
Interchange (EDI) between Billing Customer and N4 Billing.
Functional Definition
This Invoice Message (810) permits the transfer of data to Billing customers to transmit the invoice information (Invoice
(Line) Items, charges, tariffs, tax information and totals).
1.1 Objective
The following sections of this document explain how 810 message is handled in N4 Billing and scope of its
implementation.
In a terminal, an invoice (or invoices) is generated. Then this invoice information can be sent to customer through EDI
Jobs defined.
An 810 Edi may contain:
• Invoice Main Information (Customer Information, totals)
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
395
Part 1: EDI
EDI Message Specifications
EDI Message Types
• Line Items (Item descriptions, line item charges and totals)
• Tax information
• Tariff Information
1.2 Outbound Invoice Message (ANSI 810)
N4 Billing supports EDIFACT standard 810 message, release 0 & version 4020.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of ANSI X12 standard 810 0 4020 message & scope of each segment in N4.
Not used segments were not mentioned in this table.
Segment
Data Element
ISA
ISA01
Authorization Info Qualifier
"00"
ISA02
Authorization Information
""
ISA03
Security Info Qualifier
"00"
ISA04
Security Information
""
Default 10 space characters
ISA05
Interchange Sender Id Qualifier
"ZZ"
If Billing supplies Sender Qualifier then
it is used, otherwise (by default) code
"ZZ" is used.
ISA06
Interchange Sender Id
ISA07
Interchange Receiver Id
Qualifier
ISA08
Interchange Receiver Id
Interchange Recipient Id
ISA09
Transmission Date
YYMMDD
During mapping current date is used
ISA10
Transmission Time
HHMM
During mapping current time is used
ISA11
Interchange Standard Id
"U"
ISA12
Interchange Version Number
"00402"
ISA13
Interchange Control Number
ISA14
Acknowledgement Request
"0"
ISA15
Test Indicator
"P"
ISA16
Component Element Seperator
">"
GS01
Functional Id
"IN"
GS02
Application Sender Code
Interchange Sender Id
GS03
Application Receiver Id
Interchange Recipient Id
GS04
Group Date
CCYYMMDD
During mapping current date is used
GS
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Description
Qualifier
N4 Billing Fields / Notes
Default 10 space characters
Interchange Sender Id
"ZZ"
If Billing supplies Recipient Qualifier
then it is used, otherwise (by default)
code "ZZ" is used.
U: US EDI Community of ASC X12
Interchange Number is automatically
assigned by the Billing Application,
length 9 right aligned
P: Production Data
Invoice Information
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
396
Part 1: EDI
Segment
ST
BIG
CUR
N1
N3
N4
R4
IT1
EDI Message Specifications
EDI Message Types
Data Element
Description
Qualifier
N4 Billing Fields / Notes
GS05
Group Time
HHMM
During mapping current time is used
GS06
Group Control Number
Message Reference Number
GS07
Responsible Agency Code
"X"
GS08
Version/ Release Industry Code
"004020"
ST01
Transaction Set Identifier Code
"810"
ST02
Transaction Set Control Number
Transaction Set Number
Invoice Date
CCYYMMDD
If invoice is finalized, then Finalized
Date is used,
If invoice is draft, then created (date) is
used
BIG02
Invoice Number
If invoice is finalized, then Final Number
is used,
If invoice is draft, then Draft Number is
used
BIG03
Purchase Order Date
Not Used
BIG04
Purchase Order Number
Invoice Customer Reference
BIG05
Release Number
Not Used
BIG06
Change Order Sequence
Number
Not Used
BIG07
Transaction Type Code
Not Used
BIG01
X: X12
Invoice
If invoice is finalized, then Not Used
(Empty)
Empty / "24"
If invoice is draft, then Code "24" (Draft)
is used
BIG08
Transaction Set Purpose Code
CUR01
Entity Identifier Code (Currency) "ZZ"
If Invoice has a currency, then code
"ZZ" is used, otherwise empty
CUR02
Currency Code
Invoice Currency
N101
Entity Identifier Code (Name)
N102
Name
Customer Name
N301
Address Information
Invoice Address: Address Line 1
N302
Address Information
Invoice Address: Address Line 2
N401
City Name
Invoice Address: City
N402
State or Province Code
Invoice Address: State
N403
Postal Code
Not Used
N404
Country Code
Invoice Address: Country
R401
Port or Terminal Function Code
"5"
R402
Location Qualifier
"ZZ"
R403
Location Identifier
Facility Id
IT101
Assigned Identification
Sequence assigned by mapping
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
"RE"
RE: Remit to
5: Operational Activity Location
(for Facility Id)
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
397
Part 1: EDI
Segment
CUR
TXI
PID
DTM
DTM
L7
EDI Message Specifications
EDI Message Types
Data Element
Description
Qualifier
N4 Billing Fields / Notes
IT102
Quantity Invoiced
Invoice Charge: Quantity
IT103
Unit or Basis for Measurement
Code
Invoice Charge: Quantity Unit
IT104
Unit Price
Invoice Charge: Rate Billed
IT105
Basis of Unit Price Code
Not Used
IT106
Product / Service Id Qualifier
Not Used
IT107
Product / Service Id
Invoice Charge: Charge Entity Id
CUR01
Entity Identifier Code (Currency) "PE"
PE: Payee
CUR02
Currency Code
Tariff Rate: Currency
CUR03
Exchange Rate
Tariff Rate: Exchange Rate
TXI01
Tax Type Code
TXI02
Monetary Amount
Charge Tax: Amount
TXI03
Percent
Charge Tax: Rate
PID01
Item Description Type
"ZZ"
"F"
F: Free Form
PID02
Not Used
PID03
Not Used
PID04
Not Used
PID05
Description
Invoice Charge: Description
DTM01
Date / Time Qualifier
DTM02
Date
DTM01
Date / Time Qualifier
DTM02
Date
"196"
196: used for : Invoice Charge: Event
Performed From
CCYYMMDD
Invoice Charge: Event Performed From
"197"
197: used for : Invoice Charge: Event
Performed To
CCYYMMDD
Invoice Charge: Event Performed To
L701
Not Used (Tariff Reference)
L702
Not Used
L703
Not Used
L704
Not Used
L705
Tariff Item Number
Charge Tariff : Id
L706
Not Used
L707
Not Used
L708
Not Used
L709
Not Used
L710
Date
Tariff Rate: Effective Date
TDS
TDS01
Amount
Invoice: Total Total
AMT
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
"N01"
N01: not standard: for Invoice : Total
Charges
Invoice : Total Charges
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
398
Part 1: EDI
EDI Message Specifications
EDI Message Types
Segment
Data Element
AMT
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
AMT01
Amount Qualifier Code
AMT02
Monetary Amount
Invoice : Total Owed
CTT
CTT01
Transaction Totals
Number of Invoice Items
SE
SE01
Number of Included Segments
Segments Count (counted during
mapping)
SE02
Transaction Set Control Number
Transaction Set Number (refer to ST02)
GE01
Number of Transaction Sets
Included
Billing Transaction Count (Number of
Invoices)
GE02
Group Control Number
Message Reference Number (Refer to
GS06)
IEA01
Number of Included Functional
Groups
IEA02
Interchange Control Number
AMT
AMT
AMT
AMT
AMT
AMT
GE
IEA
Description
Qualifier
"N02"
N4 Billing Fields / Notes
N02: not standard: for Invoice : Total
Taxes
Invoice : Total Taxes
"N03"
N03: not standard: for Invoice : Total
Discounts
Invoice : Total Discounts
"N04"
N04: not standard: for Invoice : Total
Total
Invoice : Total Total
"N05"
N05: not standard: for Invoice : Total
Credits
Invoice : Total Credits
"N06"
N06: not standard: for Invoice : Total
Credit Taxes
Invoice : Total Credit Taxes
"N07"
N07: not standard: for Invoice : Total
Payments
Invoice : Total Payments
"N08"
"1"
N08: not standard: for Invoice : Total
Owed
Only Invoice Group will be included
Interchange Number (refer to ISA13)
2.2 ANSI 810 - Message Functions
With 810 message, two different types of invoice message can be generated: Draft and Finalized. The BIG segment
has the distinction between these two types:
If the invoice is finalized:
• BIG01 (Invoice Date): contains Invoice Finalized Date
• BIG02 (Invoice Number): contains Invoice Final Number
• BIG08 (Transaction Set Purpose Code): is empty
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
399
Part 1: EDI
EDI Message Specifications
EDI Message Types
If the invoice is draft:
• BIG01 (Invoice Date): contains Invoice Created Date
• BIG02 (Invoice Number): contains Invoice Draft Number
• BIG08 (Transaction Set Purpose Code): is mapped with qualifier "24" (Draft)
3.1 N4 Billing Built-in Map
N4 Billing serves a built-in map which is used to convert Navis standard release XML into 810 EDI message.
Following are the related files, part of N4 Billing application and can be downloaded:
• ansi810_00_4020.mgt - GoXml map
• 810.dic - Edifact standard dictionary
• invoice.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How To Configure N4 Billing For ANSI 810?
N4 Billing needs to be set up to process an outgoing 810 message. There are 2 steps to configure 810:
• 4.1.1 EDI Release Map (on page 400)
• 4.1.2 EDI Jobs (on page 402)
4.1.1 EDI Release Map
1. Go to Administration > EDI > Message Types.
2. Click Add to add a new EDI Message Type.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
400
Part 1: EDI
EDI Message Specifications
EDI Message Types
3. Edit Values in Required Tab, as shown in the image below:
4. Click Save.
5. Click Add in the Message Map Tab.
6. Edit Map Id, and set Direction to Send as shown below.
7. Click on Import DIC, and locate 810.dic supplied and import it.
8. Click on Import MGT, and locate ansi810_00_4020.mgt supplied and import it.
9. Click Save.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
401
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.1.2 EDI Jobs
1. Go to Administration > EDI > EDI Jobs.
2. Click Add to add a new EDI Job.
3. Edit Values in Required Tab, as shown below:
4. Click Save.
Now, whenever this Job is run: the 810 message is prepared.
4.2 Special Cases
In this Section:
4.2.1 Draft Invoices vs Finalized Invoices:. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
4.2.2 Exceptions / Non-Standard Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
402
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Draft Invoices vs Finalized Invoices:
N4 Billing prepares 810 message for both Draft and Finalized Invoices, please refer to 2.2 810 Message Functions for
detailed information.
4.2.2 Exceptions / Non-Standard Issues
The total amounts used in N4 Billing should be mapped, but there could not be found matching qualifiers for those
amounts. Therefore, the following qualifiers have been introduced (as non-standard) in the mapping:
• N01: Total Charges
• N02: Total Taxes
• N03: Total Discounts
• N04: Total Total
• N05: Total Credits
• N06: Total Credit Taxes
• N07: Total Payments
• N08: Total Owed
4.3 Settings
No settings.
5 Samples
5.1 810 EDI with One Invoice and Three Line Item
ISA*00* *00* *ZZ* *ZZ* *081224*1121*U*00402*000000000*0*P*>~
GS*IN**20081224*1121*X*004020~
ST*810*0001~
BIG*20070318*1~
CUR*ZZ*AUD~
N1*RE~
R4*5*ZZ*LCT~
IT1*1*5.0*ITEMS*7.0***IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F****5 to 8 days~
DTM*196*20070323~
DTM*197*20070327~
L7***STORAGE_GENERAL***20070315~
IT1*2*2.0*ITEMS*2.0***IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F****0 to 2 days~
DTM*196*20070319~
DTM*197*20070320~
L7***STORAGE_GENERAL***20070315~
IT1*3*2.0*ITEMS*5.0***IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F****3 to 5 days~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
403
Part 1: EDI
EDI Message Specifications
EDI Message Types
DTM*196*20070321~
DTM*197*20070322~
L7***STORAGE_GENERAL***20070315~
TDS*4900~
AMT*N01*49.0~
AMT*N02*0.0~
AMT*N03*0.0~
AMT*N04*49.0~
AMT*N05*0.0~
AMT*N06*0.0~
AMT*N07*0.0~
AMT*N08*49.0~
CTT*3~
SE*37*0001~
GE*1~
IEA*1*000009829~
5.2 810 EDI with Two Invoices
ISA*00 *00* *ZZ* *ZZ* *081224*1123*U*00402*000000000*0*P*>~*
GS*IN*20081224*1123*X*004020~*
ST*810*0001~
BIG*20070318*1~
CUR*ZZ*AUD~
N1*RE~
R4*5*ZZ*LCT~
IT1*1*5.0*ITEMS*7.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**5 to 8 days~
DTM*196*20070323~
DTM*197*20070327~
L7**STORAGE_GENERAL**20070315~
IT1*2*2.0*ITEMS*2.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**0 to 2 days~
DTM*196*20070319~
DTM*197*20070320~
L7**STORAGE_GENERAL**20070315~
IT1*3*2.0*ITEMS*5.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**3 to 5 days~
DTM*196*20070321~
DTM*197*20070322~
L7**STORAGE_GENERAL**20070315~
TDS*4900~
AMT*N01*49.0~
AMT*N02*0.0~
AMT*N03*0.0~
AMT*N04*49.0~
AMT*N05*0.0~
AMT*N06*0.0~
AMT*N07*0.0~
AMT*N08*49.0~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
404
Part 1: EDI
EDI Message Specifications
EDI Message Types
CTT*3~
SE*37*0001~
GE*1~
GS*IN*20081224*1123*14*X*004020~
ST*810*0001~
BIG*20070318*1~
CUR*ZZ*AUD~
N1*RE~
R4*5*ZZ*LCT~
IT1*4*5.0*ITEMS*7.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**5 to 8 days~
DTM*196*20070323~
DTM*197*20070327~
L7**STORAGE_GENERAL**20070315~
IT1*5*2.0*ITEMS*2.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**0 to 2 days~
DTM*196*20070319~
DTM*197*20070320~
L7**STORAGE_GENERAL**20070315~
IT1*6*2.0*ITEMS*5.0*IMKU2008141~
CUR*PE*AUD~
TXI*ZZ~
PID*F**3 to 5 days~
DTM*196*20070321~
DTM*197*20070322~
L7**STORAGE_GENERAL**20070315~
TDS*4900~
AMT*N01*49.0~
AMT*N02*0.0~
AMT*N03*0.0~
AMT*N04*49.0~
AMT*N05*0.0~
AMT*N06*0.0~
AMT*N07*0.0~
AMT*N08*49.0~
CTT*3~
SE*37*0001~
GE*1*14~
IEA*1*000009829~
6 Test Instructions
After an invoice is generated / created, and 810 configuration is done as described in the N4 Billing configuration,
related EDI Job can be executed, and the output EDI is placed in the EDI mailbox.
1.9.3.21 EDI Outbound Invoice Message - EDIFACT INVOIC
Purpose
This specification provides the definition of the Billing invoice message (INVOIC) to be used in Electronic Data
Interchange (EDI) between Billing Customer and N4 Billing Application.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
405
Part 1: EDI
EDI Message Specifications
EDI Message Types
Functional Definition
This Invoice Message (INVOIC) permits the transfer of data to Billing Customers to transmit the invoice information
(Invoice (Line) Items, charges, tariffs, tax information and totals).
1.1 Objective
The following sections of this document explain how INVOIC message is handled in N4 Billing and scope of its
implementation.
In a terminal, an invoice (or invoices) is generated. Then this invoice information can be sent to customer through EDI
Jobs defined.
An INVOIC EDI may contain:
• Invoice Main Information (Customer Information, totals)
• Line Items (Item descriptions, line item charges and totals)
• Tax information
• Tariff Information
1.2 Outbound Invoice Message (INVOIC)
N4 Billing supports EDIFACT standard INVOIC message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard INVOIC D 95B message & scope of each segment in
N4. Not used segments were not mentioned in this table.
Segment
UNB
Data
Element
S001
S002
S003
S004
0020
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Component
Element
Description
Qualifier
N4 Billing Fields / Notes
0001
Syntax Identifier
"UNOA"
0002
Syntax Version Number
"1"
0004
Sender Identification
Interchange Sender Id if
exists, else Interchange
Sender
0007
Sender Identification
Qualifier
Interchange Sender Qualifier
0010
Recipient Identification
Interchange Recipient Id if
exists, else Interchange
Recipient
0007
Recipient Identification
Qualifier
Interchange Recipient
Qualifier
0017
Date of Preparation
YYMMDD
Mapping Date
0019
Time of Preparation
HHMM
Mapping Time
Interchange Control
Reference
Interchange: Interchange
Number
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
406
Part 1: EDI
Segment
EDI Message Specifications
EDI Message Types
Data
Element
Component
Element
Description
Qualifier
UNG
UNH
Not Used
DTM - 3
NAD - IV
Message Reference
Number
0062
S009
BGM
N4 Billing Fields / Notes
C002
Billing Transaction: Message
Reference Number
0065
Message Type Identifier
"INVOIC"
0052
Message Type Version
Number
"D"
0054
Message Type Release
Number
"95B"
0051
Controlling Agency
"UN"
1001
Document Name Code
"380"
380: Commercial Invoice
If the invoice is finalized, then
Final Number
Else Draft Number
1004
Document Identifier
1225
Invoice Status:
Message Function Code "64" or "9" 64: Verification (Draft)
9: Original
C507
2005
Invoice Date Time
Qualifier
"3"
3: Invoice Date Time
CCYYMMDD
If the invoice is finalized, then
Finalized Date
Else Created (Draft) Date
2380
Invoice Date
2379
Date or Time Format
Code
"102"
102: CCYYMMDD
Party Qualifier
"IV"
Invoicee
3035
C082
3039
Part Identifier
Invoice Payee Customer:
Customer Id
C058
3124-1
Address
Invoice Address: Address
Line 1
3124-2
Address
Invoice Address: Address
Line 2
3124-3
Address
Invoice Address: Address
Line 3
3036-1
Party Name
Invoice Payee Customer:
Customer Name
C059
Street
Not Used
3164
City Name
Invoice Address: City
Country Sub Entity
Invoice Address: State
3251
Postcode Identification
Not Used
3207
Country Coded
Invoice Address: Country
C080
C819
MOA-9 (SG9) C516
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
3229
5025
Monetary Amount
Qualifier
5004
Monetary Amount
"9"
9: Amount Due: Invoice: Total
Owed
Invoice: Total Owed
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
407
Part 1: EDI
Segment
MOA-39
(SG9)
LOC (SG12)
EDI Message Specifications
EDI Message Types
Data
Element
C516
DTM - 1
(SG26)
DTM - 475
(SG26)
MO - 203
(SG27)
PRI
(SG29)
RFF - AFG
(SG30)
5004
Monetary Amount
Place Location Qualifier
3225
"39"
N4 Billing Fields / Notes
9: Invoice Total Amount:
Invoice: Total Charges
Invoice: Total Charges
"7"
7: Place of Delivery
Invoice: Facility Id
1082
Line Item
Automatically Generated
Sequence
1229
Action Request Coded
Not Used
Item Number
Identification
Invoice Charge: Charge Entity
Id
7140
7077
Not Used
7081
Not Used
C273
QTY-47
(SG26)
Monetary Amount
Qualifier
Qualifier
Location Identification
C212
IMD
Description
5025
3227
C517
LIN
Component
Element
C186
C507
C507
C516
C509
C506
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
7008-1
Item Description
Invoice Charge: Charge Event
Type Id
7008-2
Item Description
Invoice Charge: Description
6063
Quantity Details Qualifier "47"
47: Invoiced Quantity
6060
Quantity
Invoice Charge: Quantity
2005
Date Time Qualifier
2380
Date
2379
Date or Time Format
Code
"102"
102: CCYYMMDD
2005
Date Time Qualifier
"475"
1: Service Start Date Time,
Actual
2380
Date
2379
Date or Time Format
Code
"102"
102: CCYYMMDD
5025
Monetary Amount
Qualifier
"203"
203: Line Item Amount
5004
Monetary Amount
5125
Price Information
Qualifier
5118
Price Amount
5375
Price Type Code
"PE"
PE: Per Each
1153
Reference Code
Qualifier
"AFG"
AFG: Tariff Number
1154
Reference Identifier
"1"
1: Service Completion Date
Time, Actual
CCYYMMDD
Invoice Charge: Event
Performed To
CCYYMMDD
Invoice Charge: Event
Performed From
Invoice Charge: Total
Charged
"INV"
INV: Invoice
Invoice Charge: Rate Billed
Charge Tariff: Id
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
408
Part 1: EDI
Segment
DTM - 7
(SG26)
EDI Message Specifications
EDI Message Types
Data
Element
C507
Component
Element
Description
Qualifier
"475"
N4 Billing Fields / Notes
2005
Date Time Qualifier
7: Effective From Date / Time
2380
Date
2379
Date or Time Format
Code
"102"
102: CCYYMMDD
Allowance or Charge
Qualifier
"C"
C: Charge
"OTH"
OTH: Other
CCYYMMDD
Tariff Rate: Effective Date
ALC-C
(SG39)
5643
TAX
(SG44)
C241
5153
Tax Type
C243
5278
Tax Account Detail
Charge Tax: rate
0074
Number of Segments In
the Message
Segment Count: calculated
during mapping
0062
Message Reference
Number
Billing Transaction : Message
Reference Number
0036
Interchange Control
Count
# of Billing Transactions:
calculated during mapping
0020
Interchange Control
Reference
Interchange: Interchange
Number
UNT
UNZ
2.2 INVOIC - Message Functions
As per EDIFACT standard, INVOIC has various message function codes in BGM segment. But N4 supports only
Original & Update function codes.
With INVOIC message, two different types of invoice message can be generated: Draft and Finalized. The BIG
segment has the distinction between these two types:
If the invoice is finalized:
• DTM-3/2380 (Invoice Date): contains Invoice Finalized Date
• BGM/1004 (Invoice Number): contains Invoice Final Number
• BGM/1225 (Invoice Status): is mapped to "9" (original)
If the invoice is draft:
• DTM-3/2380 (Invoice Date): contains Invoice Created Date
• BGM/1004 (Invoice Number): contains Invoice Draft Number
• BGM/1225 (Invoice Status): is mapped to "64" (verification)
3.1 N4 Billing Built-in Map
N4 Billing serves a built-in map which is used to convert Navis standard release xml into INVOIC EDI message.
Following are the related files, part of N4 application and can be downloaded:
• invoic_D_95B.mgt - GoXml map
• invoic.dic - Edifact standard dictionary
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
409
Part 1: EDI
EDI Message Specifications
EDI Message Types
• invoice.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > message Types
3.2 Built-in Map - Special cases
N/A
4.1 How To Configure N4 Billing For INVOIC?
N4 Billing needs to be set up to process an outgoing INVOIC message. There are 2 steps to configure INVOIC:
• 4.1.1 EDI Release Map (on page 410)
• 4.1.2 EDI Jobs (on page 411)
4.1.1 EDI Release Map
1. Go to Administration > EDI > Message Types.
2. Click Add to add a new EDI Message Type.
3. Edit Values in Required Tab, as shown below:
4. Click Save.
5. Click Add in the Message Map Tab.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
410
Part 1: EDI
EDI Message Specifications
EDI Message Types
6. Edit Map Id, and set Direction to Send, as shown below:
7. Click on Import DIC, and locate invoic.dic supplied and import it.
8. Click on Import MGT, and locate invoic_D_95B.mgt supplied and import it.
9. Click Save.
4.1.2 EDI Jobs
1. Go to Administration > EDI > EDI Jobs.
2. Click Add to add a new EDI Job.
3. Edit Values in Required Tab, as shown below:
4. Click Save.
Then whenever this Job is run: the INVOIC message is prepared.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
411
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2 Special Cases
In this Section:
4.2.1 Draft Invoices vs Finalized Invoices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
4.2.2 Exceptions / Non-Standard Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
413
412
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Draft Invoices vs Finalized Invoices
N4 Billing prepares INVOIC message for both Draft and Finalized Invoices, please refer to 2.2 INVOIC Message
Functions (on page 409) for detailed information.
4.2.2 Exceptions / Non-Standard Issues
The total amounts used in N4 Billing should be mapped, but there could not be found matching qualifiers for those
amounts. Therefore the following qualifiers have been introduced (as non-standard) in the mapping for the MOA
segments:
???: Total Charges
???: Total Taxes
???: Total Discounts
???: Total Total
???: Total Credits
???: Total Credit Taxes
???: Total Payments
???: Total Owed
4.3 Settings
No settings.
5 Samples
5.1 INVOIC EDI with One Invoice and Three Line Item
UNB+UNOA:1+MSC+081224:0204+9829+INVOIC'
UNH+13+INVOIC:D:95B:UN'
BGM+380+1+9'
DTM+3:20070318:102'
NAD+IV'
MOA+9:49.0'
MOA+39:49.0'
LOC+7+LCT'
LIN+1++IMKU2008141'
IMD+++:::STORAGE:5 to 8 days'
QTY+47:5.0'
DTM+1:20070327:102'
DTM+475:20070323:102'
MOA+203:35.0'
PRI+INV:7.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+2++IMKU2008141'
IMD+++:::STORAGE:0 to 2 days'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
413
Part 1: EDI
EDI Message Specifications
EDI Message Types
QTY+47:2.0'
DTM+1:20070320:102'
DTM+475:20070319:102'
MOA+203:4.0'
PRI+INV:2.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+3++IMKU2008141'
IMD+++:::STORAGE:3 to 5 days'
QTY+47:2.0'
DTM+1:20070322:102'
DTM+475:20070321:102'
MOA+203:10.0'
PRI+INV:5.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
UNT+000041+13'
UNZ+1+9829'
5.2 INVOIC EDI with Two Invoices
UNB+UNOA:1+MSC+081224:0204+9829+INVOIC'
UNH+13+INVOIC:D:95B:UN'
BGM+380+1+9'
DTM+3:20070318:102'
NAD+IV'
MOA+9:49.0'
MOA+39:49.0'
LOC+7+LCT'
LIN+1++IMKU2008141'
IMD+++:::STORAGE:5 to 8 days'
QTY+47:5.0'
DTM+1:20070327:102'
DTM+475:20070323:102'
MOA+203:35.0'
PRI+INV:7.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+2++IMKU2008141'
IMD+++:::STORAGE:0 to 2 days'
QTY+47:2.0'
DTM+1:20070320:102'
DTM+475:20070319:102'
MOA+203:4.0'
PRI+INV:2.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+3++IMKU2008141'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
414
Part 1: EDI
EDI Message Specifications
EDI Message Types
IMD+++:::STORAGE:3 to 5 days'
QTY+47:2.0'
DTM+1:20070322:102'
DTM+475:20070321:102'
MOA+203:10.0'
PRI+INV:5.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
UNT+000041+13'
UNZ+1+9829'
UNB+UNOA:1++081224:0204++INVOIC'
UNH++INVOIC:D:95B:UN'
BGM+380+1+9'
DTM+3:20070318:102'
NAD+IV'
MOA+9:49.0'
MOA+39:49.0'
LOC+7+LCT'
LIN+4++IMKU2008141'
IMD+++:::STORAGE:5 to 8 days'
QTY+47:5.0'
DTM+1:20070327:102'
DTM+475:20070323:102'
MOA+203:35.0'
PRI+INV:7.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+5++IMKU2008141'
IMD+++:::STORAGE:0 to 2 days'
QTY+47:2.0'
DTM+1:20070320:102'
DTM+475:20070319:102'
MOA+203:4.0'
PRI+INV:2.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
LIN+6++IMKU2008141'
IMD+++:::STORAGE:3 to 5 days'
QTY+47:2.0'
DTM+1:20070322:102'
DTM+475:20070321:102'
MOA+203:10.0'
PRI+INV:5.0:PE'
RFF+AFG:STAORAGE_GENERAL'
DTM+7:20070315:102'
ALC+C'
TAX++OTH'
UNT+000041'
UNZ+1'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
415
Part 1: EDI
EDI Message Specifications
EDI Message Types
6 Test Instructions
After an invoice is generated/created, and INVOIC configuration is done as described in the N4 Billing configuration,
related EDI Job can be executed, and the output EDI is placed in the EDI mailbox.
1.9.3.22 EDI Outbound LoadList Message - COPRAR D 95B
Purpose
This specification provides the definition of the COPRAR D 95B Inbound LoadList message to be used in Electronic
Data Interchange (EDI) between line operator and the marine terminal primarily to indicate which containers should be
loaded to a vessel.
Functional Definition
This COPRAR LoadList Message (COPRAR D 95B) permits the transfer of data from a line operator to the terminal
operator.
The line operator may send the following details to the terminal operator:
• Outbound Vessel Visit Details
• Container Details
• Equipment Order Details
• Hazard Details
• Commodity Details
1.1 Objective
The following sections of this document explain how COPRAR D 95BLoadList message is handled in N4 and scope of
its implementation. This message is basically used for the following purposes:
• The terminal operator will plan for the containers on to a vessel.
• The terminal operator will send the outbound vessel visit details to the line/vessel operator.
1.2 COPRAR LoadList Message (COPRAR D 95B)
N4 supports EDIFACT standard COPRAR LOADLIST outbound message, release D & version 95B.
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
416
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map, which is used to convert COPRAR Edi message into Navis standard loadlist xml. This xml in
turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• coprar(load)out_D_95B.mgt- GoXml map
• coprar.dic -Edifact standard dictionary
• loadlist.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
417
Part 1: EDI
EDI Message Specifications
EDI Message Types
5 Samples
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
418
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.9.3.23 EDI Outbound Message - BAPLIE 3.1.1 D.13B
Purpose
The Bayplan/stowage plan occupied and empty locations message may be used for both national and international
applications. The reporting of empty locations has to be mutually agreed between partners.
The BAPLIE message is typically exchanged between a container terminal operator / stevedore, vessel operator,
shipping line, ship's master, tonnage center, non-vessel operating common carrier, container operator, slot charterer,
customs and other authorities.
Functional Definition
A message to transmit information about equipment (mostly containers) and goods on a means of transport (typically a
container vessel), including their location on the means of transport.
The Bayplan/stowage plan occupied and empty locations message may be used for both national and international
applications. The reporting of empty locations has to be mutually agreed between partners.
The BAPLIE message is typically exchanged between a container terminal operator / stevedore, vessel operator,
shipping line, ship's master, tonnage center, non-vessel operating common carrier, container operator, slot charterer,
customs and other authorities.
It is based on universal practice related to monitoring the logistics transport chain and is not dependent on the type of
business or industry.
1.1 Objective
Overall objective for version 3 of BAPLIE was to enhance the message in a way to reduce necessity for additional
communication about details unaccounted for in the message. Improving accuracy and completeness of transmitted
data serves for higher standards in vessel safety.
There are many cases where dimensions of containerized equipment are not sufficiently determined by its ISO size
type code. New qualifiers for the DIM segment are provided (width of body, width at corner posts, actual height of
telescopic end-walls, height of internal floor). The height specification allows for exact calculation of containers’ vertical
position in stacks. For containers the maximum allowable stacking weight can be specified.
Specifications for transport of un-containerized (breakbulk) data are improved. The weight of large breakbulk units can
be distributed across multiple units of supporting equipment. This allows for more accurate validation of stack-weight
limits. A qualifier for breakbulk’s vertical center of gravity is added for more accurate determination of centers of gravity
for vessel’s stability calculation.
Stowage locations which can/must not be used can be specified together with the according reason. Blocking by
oversize of other equipment (lost slot) refers to the equipment in charge.
Temperature settings and ranges for reefer containers can now be specified dependent as a function of date/time.
Parameter settings for atmosphere control can be specified.
1.2 Outbound BAPLIE Message (BAPLIE 3.1.1 D.13B)
N4 supports EDIFACT standard BAPLIE message, release D & version 13B.
UI Navigation: Administration > EDI > Message Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
419
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard BAPLIE D.13B message & scope of each segment in N4
The following picture illustrates groups and their segments supported in IFTSAI.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
420
Part 1: EDI
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EDI Message Specifications
EDI Message Types
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
421
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
A new built-in map with map id "BAPLIE_IN" is added to N4. this map can be used to convert the vermas edi file into
Navis standard vermas.xml. This xml in turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
• baplieout_31_13B.mgt.mgt - GoXml map
• baplie_3_1.dic - Edifact standard dictionary
• stowplan.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
Remove the below from FTX with ATT segment (Additional FTX segments should not be used for identification of
hazards)
Please note, the EDIFACT directory allows composite C956 to be repeated up to 5 times in each ATT segment
1.ATT+26+QTY:DGATT:306+TLQ:DGQTY:306' - Limited quantity
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
422
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.ATT+26+PSN:DGATT:306+:::CHLOROSULPHONIC ACID' - Proper shipping name CHLOROSULPHONIC
ACID
3.ATT+26+TNM:DGATT:306+:::SOLVENT NAPHTHA' Technical name solvent naphtha
4.MEA+AAE+A AA+KGM:20000’ Net weight: 20t - hazard weight - move from FTX to MEA DGS
group
5.CTA+HG‘ Dangerous goods contact - map to emergency contact in DGS group
Data about attribute detail are transmitted in composite C956. Most data are transmitted as code in data element 9019.
ATT segment’s reference description in section x specifies the according code lists for each type.
Proper shipping name and Technical name are transmitted in data element 9018.
Please note, the EDIFACT directory allows composite C956 to be repeated up to 5 times in each ATT segment.
6. Container with controlled atmosphere - Reefer requirements
MEA+AAE+AAO+P1:20’ Humidity: 20%
MEA+AAE+AAS+MQH:20’ Air flow: 20 m3/h (vent reqd)
MEA+AAE+ZO+P1:20’ Oxygen: 20%
MEA+AAE+ZC2+P1:10’ Carbon dioxide: 10%
7. In case of bundled units:
MEA+AAE+AET+KGM:4800’ - Includes weight of bundled units.
For Inbound BAPLIE:
The weight in the MEA segment is divided by the count of containers in the bundle (including the primary unit in the
EQD segment and the payload unit in the EQA segment). For e.g., if the MEA segment is the Inbound BAPLIE is ‘MEA
+AAE+AET+KGM:6000’, assuming the bundle has three containers (1 primary + 2 payload), the weight of individual
containers in the bundle is updated in N4 as 2000.
For Outbound BAPLIE:
If the unit being extracted in the BAPLIE is a bundle of 4 containers (1 primary + 3 payload) each with gross weight as
1200, then the BAPLIE file extracts the MEA segment as MEA+AAE+AET+KGM:4800’.
For empty containers that have no commodity code, N4 displays the commodity code as ‘MT’ in the extracted
BAPLIE file.
4.1 How to Configure N4 for an Outbound BAPLIE?
The following section explains how to setup and test a Vermas message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
423
Part 1: EDI
EDI Message Specifications
EDI Message Types
To set up an Inbound BAPLIE message:
1. Create a session for BAPLIE message.
To post the BAPLIE EDI message:
1. Post Baplie message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
424
Part 1: EDI
EDI Message Specifications
EDI Message Types
2. Ensure batch is completed without any error message and Unit is created
5 Samples
UNB+UNOA:3+++181217:1105+1+++++1'
UNH+test001+BAPLIE:D:13B:UN:SMDG31'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
425
Part 1: EDI
EDI Message Specifications
EDI Message Types
BGM+659+M-EX11+9'
DTM+137:201812171105:203'
TDT+20++++LINES:172:20+++9501332:146:11:NEW YORK EXPRESS'
LOC+5+BEANR'
DTM+133:201304301048:201'
DTM+136:201304301048:201'
LOC+61+DEHAM'
DTM+132:201305012100:201'
LOC+147+0501490:9711:5'
EQD+CN+MAR1234567::5+45G1::5++4'
NAD+CF+HLC:LINES:306'
MEA+AAE+AET+KGM:12000'
GDS+57:cmd 1'
LOC+9+GBSOU:139'
LOC+11+DEHAM:139'
TMP+2+-1.5:c'
RNG+5+CEL:-21:-24'
EQA+2200+BSEU0321392'
DGS+IMD+2.1+1954+055:c+1+F-E,S-E'
ATT+26+PSN:DGATT:306+:::CHLOROSULPHONIC ACID'
ATT+26+TNM:DGATT:306+:::SOLVENT NAPHTHA'
MEA+AAE+AAA+KG:2000'
DGS+IMD+2.1+1954+055:c+1+F-E,S-E'
ATT+26+PSN:DGATT:306+:::CHLOROSULPHONIC ACID'
ATT+26+TNM:DGATT:306+:::SOLVENT NAPHTHA'
MEA+AAE+AAA+KG:3000'
DGS+IMD+2.1+1954+055:c+1+F-E,S-E'
ATT+26+PSN:DGATT:306+:::CHLOROSULPHONIC ACID'
ATT+26+TNM:DGATT:306+:::SOLVENT NAPHTHA'
CNT+8:1'
LOC+147+0260490:9711:5'
EQD+CN+XLXU8523991::5+45G1::5++4'
MEA+AAE+VGM+KGM:12000'
MEA+AAE+AAO+P1:20'
MEA+AAE+AAS+MQH:20'
MEA+AAE+ZO+P1:20'
MEA+AAE+ZC2+P1:10'
DIM+5+CM:101'
DIM+6+IN:201'
DIM+7+CM:301'
DIM+8+CM:401'
DIM+13+MM:501'
GDS+58:cmd 2'
LOC+9+USOAK:139'
LOC+11+SGSIN:139'
TMP+2+-3.5:c'
RNG+5+CEL:-15:-15'
CNT+8:1'
LOC+147+032154:9711:5'
EQD+CN+MARU09112018::5+2200::5++4'
MEA+AAE+AET+KGM:3000'
DIM+5+CM:102'
DIM+6+IN:202'
DIM+7+CM:303'
DIM+8+CM:404'
DIM+13+MM:505'
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
426
Part 1: EDI
EDI Message Specifications
EDI Message Types
GDS+59:cmd 3'
LOC+9+HKHKG:139'
LOC+11+BEANR:139'
EQA+2200+BSEU0321392'
CNT+8:1'
UNT+63+test001'
UNZ+1+1'
1.9.3.24 EDI Outbound Rail Consist Message - ANSI 418 00
4020
Purpose
This specification provides the definition of the ANSI 418 Outbound Rail Consist message to be used in Electronic Data
Interchange (EDI) between a terminal operator and a rail operator in the marine/rail domain.
Functional Definition
This message is used to inform the railroad about what containers are shipped out of the terminal via rail. This can be
typically sent after planning and loading the containers to the train and when the railroad is about to move them out of
the terminal.
The Outbound Rail Consist Message (ANSI 418) permits the transfer of data from a terminal operator to a rail operator.
The terminal will send the following details to a rail operator:
• Train visit details
• Attached railcar details
• Loaded container details
• Attached equipment details
• Hazard information, if any, for the individual containers
1.1 Objective
The following sections of this document explain how ANSI 418 Outbound Rail Consist message is handled in N4 and
the scope of its implementation. This message is basically used for the following operations carried out by the terminal/
rail operators:
• The terminal will send the outbound train visit details to the rail road once the planning of the containers is
completed.
• The rail operator will plan for the train visit that is sent by the terminal.
• The rail operator will also plan for the containers received through the EDI message.
1.2 Outbound Rail Consist Message (ANSI 418)
N4 supports ANSI standard 418 RAILCONSIST message, release 00 & version 4020.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
The following table illustrates the segments of ANSI standard RAILCONSIST 00 4020 (418) message and the scope of
each segment in N4.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
427
Part 1: EDI
EDI Message Specifications
EDI Message Types
Supported
Qualifier
S. No. #
Segment ID
Description
Supported in N4?
1
ST
Transaction Set Header
Supported
1
BAX
Beginning Segment for Advance Consist and
Transportation Automatic Equipment
Supported
2
W1
Block Identification
Not Supported
3
W2
RR
Equipment Identification (Railcar)
Supported
4
W2
CN
Equipment Identification (Container)
Supported
5
W3
Consignee Information
Supported
6
IMA
Interchange Move Authority
Not Supported
7
W4
Consignor Information
Supported
8
W5
Route Information
Supported
9
PS
Protective Service Instructions
Supported
10
REF
Reference Identification
Not Supported
11
LS
Loop Header
Not Supported
12
LH1
Hazardous Identification Information
Supported
13
LH2
Hazardous Classification Information
Supported
14
LH3
Hazardous Material Shipping Name
Supported
15
LFH
Freeform Hazardous Material Information
Not Supported
16
LEP
EPA Required Data
Not Supported
17
LH4
Canadian Dangerous Requirements
Not Supported
18
LHT
Trans-border Hazardous Requirements
Not Supported
19
LHR
Hazardous Material Identifying Reference Numbers
Not Supported
20
PER
Administrative Communications Contact
Not Supported
21
N1
Name
Not Supported
22
N3
Address Information
Not Supported
23
N4
Geographic Location
Not Supported
24
PER
Administrative Communications Contact
Not Supported
25
LE
Loop Trailer
Not Supported
26
PER
Administrative Communications Contact
Not Supported
27
LH2
Hazardous Classification Information
Not Supported
28
LHR
Hazardous Material Identifying Reference Numbers
Not Supported
29
SE
Transaction Set Trailer
Supported
2.2 Rail Consist - Message Functions
As per ANSI standard, the Rail Consist Inbound message has various message function codes in the BAX (in the 13th
element) segment. But in the Outbound message, N4 supports only one message function which is Original (00).
The terminals need to send the EDI as per ANSI standard format. In N4, the outbound Rail Consist map is a way of
mapping the data available in the application (persistent data) from Navis XML format to the EDI format.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
428
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map for converting the Navis standard rail consist.xml file to the ANSI 418 Outbound EDI message
standard using the Navis standard schema file: railconsist.xsd.
Following are the related files that can be downloaded as part of N4 application:
• ansi418out_00_4020.mgt - GoXml map
• 418.dic - ANSI standard dictionary
• railconsist.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
4.1 How to Configure N4 for Outbound Rail Consist?
N4 needs to be set up to process an outbound Rail Consist message. Following are the preliminary steps to be
performed to process an outbound Rail Consist message:
1. Create an outbound train visit and attach railcars to the train.
2. Load the containers to the respective rail cars.
3. Perform the extract for the outbound train to get the outbound rail consist.
After the containers are loaded to the train,
1. Open the Train Visits view
2. Open the Train Inspector for the train.
3. Go to the Outbound EDI tab (in the left pane of the Train inspector)
4. Click on the '+'. A new pop-up will open displaying the train Id and a drop-down list displaying all available outbound
Rail Consist sessions.
5. Select a specific session from the drop-down and click Extract.
4.2 Special Cases
No Railcars attached to the Train
If there are no railcars attached to an outbound train visit, then the extract will fail with the error message "No Railcars
attached to the train visit TRAIN_XYZ".
No Containers attached to the Train
If there are no containers attached to an outbound train visit, that is, if only railcars are attached, then the extract will
send the train and railcar visit details.
Applying the filter criteria
By default, the extract will send all the railcars and the containers details that are attached to an outbound train visit. If
the filter criteria is selected from the outbound rail consist session, then it will extract only those containers which
satisfy the selection criteria and those railcars on which there are containers loaded with the above selection criteria.
5 Samples
5.1 ANSI 418 Outbound Rail Consist EDI with one railcar and a container
GS*IC*APL*APL*040609*1135*13*X*004020~
ST*418*130001~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
429
Part 1: EDI
EDI Message Specifications
EDI Message Types
BAX*FCY111*T*139*040511*1328*SPTRLHA509**IN*040511*2115*02~
W2*APLR*777*RR*L*135BNSF*****2*2ST~
W3**040507*APL*LA HARB*CA~
W4*APL***BARBOURS*TX~
W6*IB~
W2*APLU*112266*4950130*CN*L*8********1B1*U201~
W3*570315*040506*MAERSK*LA HARB*CA~
W4*APL*APL*35101*BARBOURS*TX~
W5*BNSF~
REF*BN*BKMA280300~
LS*0800~
LH1*PL*11*UN11**11111*KG*11~
LH2*6.2*P*PLACARDED CLASS 6.1*NONE~
LH3*VEHICLE, FLAMMABLE LIQUID*D~
LE*0800~
SE*82*130001~
GE*1*13~
5.2 ANSI 418 Outbound Rail Consist EDI with multiple railcars and containers
GS*IC*****6*X*004020~
ST*418*123~
BAX**T*139**TEST_OUT_TRAIN*OUT***00~
W2*TEST*OBRC02*RR*L********2~
W2*CNTU*777777*CN*FCL*0.0*******TESTOBRC02.2B2~
W5*VKR~
PS*830*M*C~
LH1*PL*1.2*HZ Tech Name111*KG~
LH2*HZ Proper Name111*P~
LH3*HZ Tech Name111*D*NOS~
W2*CNTU*888888*CN*FCL*0.0*******TESTOBRC02.2B1~
W2*APLC*APLC17*RR*L*********2ST~
W2*KRTU*249628*CN*FCL*0.0*******APLC17.2B2~
W5*Test RR~
PS*830*M*C~
LH1*PL*4.1**KG~
LH2**P~
LH3**D*NOS~
SE*10*2~
GE**65~
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
430
Part 1: EDI
EDI Message Specifications
EDI Message Types
6 Test Instructions
To setup and test an ANSI 418 Outbound Rail Consist in N4.
1. In the Message Type UI, configure the message type and the message map by loading the dictionary and the
mapping file.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
431
Part 1: EDI
EDI Message Specifications
EDI Message Types
2. Create an outbound rail consist session.
3. Create an outbound train visit with the phase as Arrived.
4. Attach a railcar to the Train visit.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
432
Part 1: EDI
EDI Message Specifications
EDI Message Types
5. Load a container to the Railcar visit.
6. Open the Train Inspector view for this train visit. Click on the Outbound EDI tab on the left side of the Train
Inspector view and click on the + button.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
433
Part 1: EDI
EDI Message Specifications
EDI Message Types
7. Select the outbound rail consist session from the pop-up displayed for the corresponding train visit and click on the
Extract Button.
8. Go to the corresponding mailbox and verify the latest extracted file.
1.9.3.25 EDI Outbound Terminal Performance Report
Message - EDIFACT TPFREP 30 00B
Purpose
This Electronic Data Interchange (EDI) specification provides the definition of the EDIFACT Terminal Performance
Report (TPFREP) message that will be used to transmit information relating to the move operations such as loading,
discharging and re-handling of containers carried out by terminal operators. The TPFREP message will be transmitted
by a terminal operator to the ship operator, crane operator, tonnage center or shipping line. This is typically sent after
the operation has been completed.
Functional Definition
The terminal operators will send the following details in TPFREP message to the respective receivers:
• Extracts the number of moves specific to particular line/crane statistics.
• The moves performed on specific vessel/voyage (i.e. Load/Discharge/Shift moves.)
• Reflects the Expected/Actual arrival/departure information.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
434
Part 1: EDI
EDI Message Specifications
EDI Message Types
1.1 Objective
The following sections of this document explain how TPFREP - Terminal Performance Report message is handled in
N4 and scope of its implementation.This message is basically used for the following purposes:
• The terminal will send the Terminal Performance Report to the shipping line/crane operator/tonnage center/vessel
operator once the operation has been completed.
• This will help the associated parties to evaluate the performance of the operations.
1.2 Terminal Performance Report Message (TPFREP 30 00B)
N4 supports EDIFACT standard TPFREP PERFORMANCE message, version 30 and release 00B.
UI Navigation: Administration > EDI > Message Types
2.1 Scope
Following table illustrates the segments of EDIFACT standard PERFORMANCE 30 00B (TPFREP) message & scope
of each segment in N4.
S. No. #
Segment ID
Supported Qualifier
Description
Supported in N4?
1
UNH
Message Header
Supported
2
BGM
Beginning of Message
Supported
3
DTM
Date/Time/Period
Supported
4
FTX
Free Text
Supported
5
TDT
20
Details of Transport
Supported
6
LOC
5
Place/Location Identification Supported
7
DTM
Date/Time/Period
Supported
8
RFF
Reference
Supported
9
EQD
Equipment Details
Supported
10
CNT
Control Total
Supported
11
QTY
IDI, DIS, CDI, TDI, ELD, TLD, RST,
LOD
Quantity
Supported
12
DTM
137,203
Date/Time/Period
Supported
13
FTX
Free Text
Not Supported
14
NAD
Name and Address
Supported
15
EQD
Equipment Details
Supported
16
QTY
Quantity
Supported
17
FTX
Free Text
Not Supported
18
UNT
Message Trailer
Supported
19
UNZ
Interchange Number
Supported
137,203
CN
CN
2.2 Terminal Performance Report - Message Functions
N4 supports only one message function i.e. Original (9) for TPFREP message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
435
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.1 N4 Built-in Map
N4 serves a built-in map which is used to convert the Navis standard performanceXML file to the EDIFACT Standard
Terminal Performance Report (TPFREP) message standard using the Navis standard schema file i.e. performance.xsd.
Following are the related files, part of N4 application and can be downloaded:
• tpfrep_30_00B.mgt - GoXml map
• tpfrep.dic - EDIFACT standard dictionary
• performance.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.2 Built-in Map - Special cases
N/A
4.1 How to Configure N4 for TPFREP?
N4 needs to be set-up to process an outbound Terminal Performance Report message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
436
Part 1: EDI
EDI Message Specifications
EDI Message Types
To process outbound TPFREP:
1. Create the Message Types and the Message Map for the TPFREP message.
2. Create the basic setups like Partner, Mail box and the Session for the PERFORMANCE message class.
3. Create a Vessel Visit (e.g. TEST_TPFREP_S).
4. Open the Vessel Inspector for the above vessel visit (TEST_TPFREP_S)
5. Click on the Line Stats on left panel to add the Line Statistics and click on the "+" button appearing at the right
center of the form. A new pop up will display with the Container Length and the Line Operator drop down lists along
with the other text boxes for providing the required data.
6. Now select the required data form these drop-down lists and provide the other required data.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
437
Part 1: EDI
EDI Message Specifications
EDI Message Types
7. Click on the Save button.
8. Similarly click on the Crane Stats on the left panel to add the Crane Statistics and click on the "+" button appearing
at the right center of the form. A new pop up will display with the Crane drop-down list along with the other date and
text fields.
9. Now select the required data from the drop-down list and provide the other required data.
10. Click on the Save button.
11. Now click on the Outbound EDI on the left panel to view the EDI extract session. Click on the "+" button appearing
at the right center of the form. A new pop up will display with Visit Ref and Session drop-down list.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
438
Part 1: EDI
EDI Message Specifications
EDI Message Types
12. Now select the associated PERFORMANCE session from the drop-down list and click on the Extract button.
The Terminal Performance Report (TPFREP) message will be extracted to the specified mailbox folder.
4.1.1 EDI Outbound Terminal Performance Report (TPFREP) Map
The terminals will send the EDI as per EDIFACT standard format. In N4, the outbound Performance map is a way of
mapping the data available in the application (persistent data) to the EDI format.
4.2 Special Cases
In this Section:
4.2.1 Crane Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
4.2.2 Line Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
4.2.3 Applying the filter criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
439
Part 1: EDI
EDI Message Specifications
EDI Message Types
4.2.1 Crane Stats
When we click on the Crane Stats, it opens the Add Crane Statistics form to provide the required data. But the field
Crane drop down list displays the data that is received through XPS (SPARCS) to the N4 application.
We need to select the corresponding Crane and provide the Shift Start and Shift End date/time along with the other
data (if required).
4.2.2 Line Stats
When we click on the Line Stats, it opens the Add Line Statistics form to provide the required data. Here the data
come from N4 only unlike the above Crane Stats where the data comes from the XPS.
We need to select the corresponding Line Operator and provide the other data (if required).
If we add both the details then it will extract both the data for the associated vessel visit. Otherwise it will just fetch the
added information corresponding to the Crane/Line Operator statistics.
4.2.3 Applying the filter criteria
NA
5 Samples
5.1 Sample Extracted with the Line Statistics
UNB+UNOA:1+:ZZZ+APL:ZZZ+090202:0409+5'
UNH+5+TPFREP:00B:UN:SMDG30'
BGM+265+5+9'
DTM+137:200902020409:203'
TDT+20+999+1+ +ANL:172:ZZZ+ANL9999:146:ZZZ:KOTA JASA'
LOC+5+USOAK+USOAK+CASHIN QUAY'
RFF+VON:999'
EQD+GC'
QTY+CMV:0'
DTM+::401'
NAD+CF+1wq'
EQD+CN+ +40FT+5'
QTY+IDI:1'
QTY+DIS:3'
QTY+CDI:0'
QTY+TDI:2'
QTY+ELD:2'
QTY+TLD:1'
QTY+RST:0'
QTY+LOD:3'
UNT+000048+5'
1.9.3.26 EDI Inbound Inventory Update Message - COHAOR D
04B
Purpose
COHAOR is used for generic inventory updates announced by trading partners to terminals, to either create or update
existing unit details such as special stow code, hazards, reefer temperature, Trucking Company, etc.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
440
Part 1: EDI
EDI Message Specifications
EDI Message Types
Purpose
This message is part of a total set of container-related messages. These messages serve to facilitate the intermodal
handling of containers by streamlining the information exchange. The Terminal will receive COHAOR message from
shipping lines/shipping agents/freight forwarders to announce about container special handling instruction for
dangerous goods on it.
1.1 Objective
The following sections of this document explain how COHAOR message is handled in N4 and scope of its
implementation.
COHAOR is primarily used for updating stow instructions and hazards information of units.
It may contain:
List of containers
Hazards information and Stow instructions of each container
Line operator, vessel details for identifying the unit
1.2 COHAOR Message Type
N4 supports EDIFACT standard COHAOR message, release D & version 04B.
UI Navigation: Administration > EDI > Message Types
2.1 Message Function
As per EDIFACT standard, Cohaor supports Original,Replace,Cancel function codes.
Segment
ID
Supported
Qualifier
Element Description
Supported in N4?
UNH
Message Header
Will get message ,version,release and message
reference number
BGM
Beginning of Message
Following function codes are supported currently
1 - Cancellation 5 - Replace 9 - Original
Date/Time/Period
DTM
To specify date, and/or time,
or period.
This segment is available in dic but not used in built-in
map
FTX
Free Text
This segment is available in dic but not used in built-in
map
RFF
Reference
This segment is available in dic but not used in built-in
map
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
441
Part 1: EDI
EDI Message Specifications
EDI Message Types
Date/Time/Period
DTM
To specify date, and/or time,
or period.
This segment is available in dic but not used in built-in
map
Name and Address
To specify the name/address
This segment is available in dic but not used in built-in
and their related function,
map
either by C082 only and/or
unstructured by C058 or
structured by C080 thru
3207.
NAD
CTA
Contact Information
This segment is available in dic but not used in built-in
map
COM
Communication Contact
This segment is available in dic but not used in built-in
map
Equipment Details
supported
Reference
This segment is available in dic but not used in built-in
map
EQD
CN
RFF
Date/Time/Period
DTM
To specify date, and/or time,
or period
This segment is available in dic but not used in built-in
map
LOC
Place/Location Identification
This segment is available in dic but not used in built-in
map
FTX
Free Text
This segment is available in dic but not used in built-in
map
GOR
Governmental Requirements
This segment is available in dic but not used in built-in
map
HAN
Handling Instructions
Supported to map stow intructions
MEA
Measurements
This segment is available in dic but not used in built-in
map
PCD
Percentage Details
This segment is available in dic but not used in built-in
map
TDT
Transport Information
Supported to map outbound vessel visit
Date/Time/Period
DTM
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
To specify date, and/or time,
or period
This segment is available in dic but not used in built-in
map
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
442
Part 1: EDI
EDI Message Specifications
EDI Message Types
RFF
Reference
This segment is available in dic but not used in built-in
map
Place/Location Identification
Supported
9 - loadPort
LOC
11 dischargePort
Date/Time/Period
DTM
To specify date, and/or time,
or period
This segment is available in dic but not used in built-in
map
Name and Address
NAD
To specify the name/address
and their related function,
This segment is available in dic but not used in built-in
either by C082 only and/or
map
unstructured by C058 or
structured by C080 thru
3207.
CTA
Contact Information
This segment is available in dic but not used in built-in
map
COM
Communication Contact
This segment is available in dic but not used in built-in
map
DGS
Dangerous Goods
Supported to map hazard details
FTX
Free Text
This segment is available in dic but not used in built-in
map
MEA
Measurements
This segment is available in dic but not used in built-in
map
CTA
Contact Information
This segment is available in dic but not used in built-in
map
COM
Communication Contact
This segment is available in dic but not used in built-in
map
TMP
Temperature
This segment is available in dic but not used in built-in
map
RNG
Range Details
This segment is available in dic but not used in built-in
map
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
443
Part 1: EDI
EDI Message Specifications
EDI Message Types
2.2 N4 Built-in Map
A new built-in map with map id "COHAOR_D_04B_IN" is added to N4. This map can be used to convert the cohaor edi
file into Navis standard cohaor.xml. This xml in turn used for further processing.
Following are the related files, part of N4 application and can be downloaded:
cohaor_D_04B.mgt - GoXml map
cohaor.dic - Edifact standard dictionary
inventoryUpdates.xsd - Navis standard xml schema
UI Navigation: Administration > EDI > Message Types
3.1 Settings
As part of this NFRM, we have introduced 2 new settings:
ARGOCORE014 - This is for auto creation of vessel visits if the vessel is not found.
ARGOCORE015 - This is to check if the category given in the EDI is accurate or not
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
444
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.2 Pre-requisite
Step - 1: Create a session for Cohaor message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
445
Part 1: EDI
EDI Message Specifications
EDI Message Types
3.3 Posting of COHAOR EDI message
Step - 2: Post Cohaor Original message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
446
Part 1: EDI
EDI Message Specifications
EDI Message Types
Ensure batch is completed without any error message and unit is created with hazard and stow informations.
Step - 3: Post Cohaor EDI Replace message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
447
Part 1: EDI
EDI Message Specifications
EDI Message Types
Cohaor Replace message posted successfully and hazard and stow instructions are updated, history event is recorded
with field changes
Step - 4: Post Cohaor EDI Cancel message
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
448
Part 1: EDI
EDI Message Specifications
EDI Message Types
COHAOR Cancel message nullified hazard and stow informations. History event is recorded for cancel message with
field changes.
3.4 Posting Logic
A new poster “InventoryUpdatesPoster” is created for posting the mappings to N4.
The facility is resolved based on:
VesselcallFacility – The user can override this element to provide the facility , against which the unit gets posted.
EDI_FACILITY_FOR_POSTING – User can set the value for this setting at edi session level
Otherwise, the facility is resolved based on the outbound carrier visit.
A new setting has been introduced to determine if the equipment category provided in edi is accurate or not- If not
accurate we determine the category based on the port of load,port of discharge,port of transhipment.
Another setting for auto creation of vessel visit is introduced - INV_UPDATES_ALLOW_FOREIGN_VESSEL_VISIT
We record the UNIT_PROPERTY_UPDATE,UNIT_HAZARD_INSERT/UNIT_HAZARD_UPDATE events notes property
with the reference number passed in edi.
The poster supports 3 message functions- Original(O),replace(X),cancel(D)
When a replace or cancel message is posted , we validate reference number with the already recorded events
(UNIT_PROPERTY_UPDATE/ UNIT_HAZARD_INSERT/UNIT_HAZARD_UPDATE) in the unit and then only post the
changes.Only if the reference number matches we proceed to post the changes otherwise we throw a error message.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
449
Part 1: EDI
EDI Message Specifications
EDI Message Types
It provides posting rule support for Stow instructions, Hazards and general rule.
We have extended data quality support for the poster.
Sample Edi File for Original message:
Sample EDI file with Replace Message:
Replace message for the same container with matching reference number.
Sample EDI file for Cancel message:
Cancel message for the same container with matching reference number.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
450
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
451
Part 2
Services Management
In this Section:
Services Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hold Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Orders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related Terminal Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services How Do I.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
453
459
486
512
520
524
533
452
2.1 Services Process Flows
This section contains the following process flows:
In This Section
Setting up Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
453
Part 2: Services Management
Services Process Flows
Setting up Services
2.1.1 Setting up Services
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
454
Part 2: Services Management
Services Process Flows
Setting up Services
2.1.1.1 Adding Event Types
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
455
Part 2: Services Management
Services Process Flows
Setting up Services
2.1.1.2 Adding Auto Update Rules
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
456
Part 2: Services Management
Services Process Flows
Setting up Services
2.1.1.3 Adding Service Business Rules
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
457
Part 2: Services Management
Services Process Flows
Setting up Services
Selecting a Rule Type
Same impediment displays more than once for a unit
This will occur for the units that fit the criteria defined for more than one service business rule, when the service
business rules use the same service event and hold/permission. For example, if you have a:
• Service business rule called CUSTOMS1 to apply the hold X to all import containers preventing delivery until
released.
• Service business rule called CUSTOMS2 to apply the hold X to ABC import containers preventing delivery until
released.
The ABC import containers fit the criteria for both the CUSTOMS1 and CUSTOMS2 service business rules. Therefore
the hold X road impediment displays twice for the ABC import containers.
To avoid this in the example above, you can update the filter criteria for the CUSTOMS1 service business rule to add a
NOT ALL OF group (a negated "AND" Group) to exclude the ABC import containers. For more information, see
Grouping filter criteria (on page ) and Negating filter criteria (on page ) in the online help or on the NCC.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
458
2.2 Service Events
In This Section
Event Types view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Record Service Event form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
N4 Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
459
Part 2: Services Management
Service Events
Event Types view
2.2.1 Event Types view
Configuration
Services
Event Types
Event Types view
The Event Types view displays the event types that exist at the current scope level. Event types define the actions
such as load, discharge, activate, and create that can be recorded for a business entity such as a unit, equipment,
vessel, vessel visit, or booking. Each event type can apply to only one logical business entity also called the target
entity for the event type. For a list of events (on page 466), see the Navis N4: Reference Guide.
N4 may record an event as part of an internal process or for a user initiated action for the target entity. For example, if
a unit is loaded on a vessel, N4 records the associated event in the event history of the unit. You can use the Event
History tab in the Unit Inspector to view the events recorded for a unit.
The events recorded for a target entity build the history of the entity and can also be intercepted to generate notification
requests. The event types can be:
• Built-in event types: Are pre-defined in the system and may or may not be service event types.
• Custom-defined event types: Are defined based on user requirement and are always service event types.
When you add a new event type, N4 add a new privilege for each event type and names the privilege as follows:
Services: Apply <event type Id> Service
A user can record only the event types for which you assign a privilege to the user account.
If you want to allow a user to record any user-defined event type for any entity, assign the Services: Apply
*Any* Service privilege to the role assigned to the user.
You use the Actions Record Service Event option to record a service event type as an action for the target entity,
such as when a service is performed. In addition, you can define service business rules that require a prerequisite
event to occur before a service event can be recorded for the target entity. For more information on adding service
business rules, see Service Business Rule form (on page 503).
For your initial setup, we recommend that you add the standard list of event types. For more information, see
Set-up Database view.
You can add new event types, and edit or delete existing event types from this view.
In addition, you can use the Actions menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted event types.
• Purge (on page 208), Purge (on page 1215): Purge event types.
• Copy Reference Set (on page 1191): Copy events types from another entity set.
You cannot delete an event type if it is used in an active service business rule (on page 502) or auto update
rule (on page 505). In addition, you cannot delete a Built In event type.
A built-in event type displays a period in the Built In column in the Event Types view. If you double-click the
record to open the Event Type form for this event type, the Is Built In check box is selected and you cannot
edit most fields in the form.
To add a new record:
Click
.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
460
Part 2: Services Management
Service Events
Event Types 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).
▪ N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related cargo/
units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4 displays
an error message, Cannot delete bill of lading {0}, as it is associated with Units
Event Types Columns
Short Label
Long Label
In Filter?
Sorting?
Applies To
Applies To
X
X
Billable
Billable
X
X
Built In
Is Built In
X
X
Bulkable
Can be Bulk-applied
X
X
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Description
Description
X
X
Functional Area
Functional Area
X
X
Id
Id
X
X
Is Service
Is Service
X
X
LifeCycleState
LifeCycleState
X
X
Notifiable
Notifiable
X
X
2.2.1.1 Event Type form
Configuration
Services
Event Types
Event Types view
Event Type form
The Event Type form enables you to add and edit an event type and add effects for an event type. An event type
defines an action or an internal event that is recorded to the event history of the target entity. Use this form to manually
add event types or use the Actions Copy Reference Set (on page 1191) option to copy event types defined in an
existing entity set.
For your initial setup, we recommend that you add the standard list of event types. For more information, see
Set-up Database view.
N4 provides a set of built-in event types which may or may not be service event types. If an event type is built in, the Is
Built In check box is checked. A built-in event type such as UNIT_LOAD, cannot be directly recorded for a target entity
using the Record Service Event form. It is an action recorded internally by the system.
For built-in event types, except the UNIT_STRIP and UNIT_STUFF event types, you can only edit the description, or
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
461
Part 2: Services Management
Service Events
Event Types view
make them billable or notifiable. In addition, you can add fields with the 'Is Traced' effect for the built-in event types.
For the UNIT_STRIP and UNIT_STUFF built-in event types you can add all the available effects. For more information
on effects, see Effect form (on page 463).
If an event type is a service event type, the Is Service check box will be checked. All custom-defined event types are
created as service event types and can be recorded as an action for the target entity. Use the Actions Record
Service Event option to record a service event for the entity.
You can define service business rules that determine when a service event can be recorded for the target entity. For
more information on adding service business rules, see Service Business Rule form (on page 503).
To add or edit an event type:
1. In the Id field, enter an ID that uniquely identifies the event type.
2. Optionally, in the Description field, enter a short description for the event type.
3. From the Applies To drop-down list, select the target entity such as unit, equipment, export booking, vessel visit,
train visit, or vessel, for the event.
4. Select the applicable check boxes for the event:
▪ Billable: Recording this event type is a billable action and the customer can be billed for the service performed.
▪ Notifiable: Recording this event type is a notifiable action. The event type can be used to create a notice request.
For more information on notice requests, see Notice Request form.
▪ Orderable: Events marked as ‘Orderable’, are displayed in the Event Type ID drop-down list in the Record
Service Event form and, in the Event Type drop-down list in the Items Service Type form.
▪ Acknowledgeable: Specify whether the event type can be marked as handled (dismissed) by the Crane Team
UI.
If you have set up a General Notice for an event to be displayed in the XPS EC Alarms window, selecting
this attribute has no effect on whether the event can be deleted from EC Alarms unless you have added
Extension Triggers in N4 for managing the service events through Crane Automation System (CAS)
messages. See Manage QC exceptions through CAS events in the N4 Automation Configuration manual.
▪ Can be Bulk-applied: The event type can be recorded for multiple target entities simultaneously. For example, if
you have a Wash event for washing dirty containers, and you select the check box, you can record the service
event for multiple containers simultaneously.
▪ Auto Extract: Select this check box for a pre-pay service that you want to be invoiced immediately.
You can select this check box only if the event type is also marked as Billable.
When you select this check box for a pre-paid event and that event is then recorded against a unit, an
appointment (transaction appointment or a truck visit appointment), or a vessel visit, N4 extracts the event to the
corresponding chargeable events table as soon as the event is recorded. It does not wait for the next iteration of
the billing extract cycle.
You should exercise caution when selecting this check box for an event type. If you do this for too many
event types, it may lead to performance issues. It is recommended that you limit the use of this check box
only for event types that must be invoiced as soon as they are recorded.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
462
Part 2: Services Management
Service Events
Event Types view
5. If adding an event for the cargo lot entity, select the Applicable to Cargo module option from the Functional Area
drop-down list.
For more information on using billable events with the cargo lot entity, see How do I Record a Billable Event Type for
a Cargo Lot?
6. On the Filter tab, define a filter to narrow the possible targets of the event type to those entities that meet the filter
criteria. The filter attributes available on the Filter tab depend on the target entity type selected. For more
information on adding filter criteria, see Creating a filter (on page ).
When you record a service event for a target entity of the type selected in step 3, N4 checks if the selected
entity fulfills the filter criteria. If you do not define a filter, the service event can be recorded for all entities of
the correct type.
7. Click Save.
You must save an event type before you can add effects for the event type.
Effects tab
Configuration
Services
Event Types
Event Types view
Event Type form
Effects tab
The Effects tab displays the effects defined for the selected event type. Use an effect to trace or update selected fields
for the target entity when an event is recorded. You can add new effects, and edit or delete existing effects on this tab.
Effect form
Configuration
Services
Event Types
Event Types view
Event Type form
Effects tab
Effect form
The Effect form enables you to add and edit an effect. An effect traces or updates a selected field for the target entity
when an event is recorded. You can define multiple effects for an event type.
To add or edit an effect:
1. From the Field drop-down list, select the field you want to trace or update when an event is recorded.
The fields displayed in the drop-down list depend on the target entity type selected for the event type.
If the event applies to the Unit entity, the drop-down list also displays any unit and unit facility visit flex fields
(on page 1072) configured for the current scope.
2. Optionally, in the Order field, enter a numerical value that represents the order you want the field selected in step 1
to display in the appropriate data entry form, such as the Record Service Event form.
All effect fields display below existing fields in the appropriate data entry form. If you add more than one effect for
the same data entry form and enter a value in the Order field for each effect, N4 displays the effect fields in order
from lowest numerical value to highest numerical value. In addition, N4 displays effect fields without an order value
before effect fields with an order value, and displays effect fields with the same order value next to each other.
3. Select the applicable effects for the field selected in step 1:
▪ Is Traced: Registers the previous and the new values for the selected field when the event is recorded.
If you select the check box, the old and the new values of the selected field are displayed in the Fields Changed
area in the Event Details form (on page 948).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
463
Part 2: Services Management
Service Events
Record Service Event form
▪ Is Updated: Prompts the user to enter a value for the selected field when the event is recorded.
▪ Is Required: Ensures that the value in the selected field is updated when the event is recorded.
If you select the Is Required check box, you must select one or both Is Updated and Is Auto-Updated check
boxes, to either prompt the user for a new value or use a default value.
▪ Is Auto-Updated: Updates the selected field with a preset value.
If both Is Updated and Is Auto-Updated settings are selected, the system prompts the user to enter a new value
while the auto-update value is displayed as the default value that the user can override.
4. If you select the Is Auto-Updated check box, specify the default value to be used in the Automatic Value area.
The field displayed in the Automatic Value area, depends on the selected field. If the field in the Automatic Value
area is a required field (an asterisk is displayed next to the field label), you must specify a value. If the field in the
Automatic Value area is not required, you may or may not specify a value.
If the Is Auto-Updated check box is selected, and no value is specified in the field displayed in the
Automatic Value area, the entity is updated to have no value for the field.
5. Click Save.
2.2.2 Record Service Event form
You can access the Record Service Event form from the Actions menu in most views and Inspectors for entities such as units, bills of
lading, bookings, EDOs, ELOs, vessel visits, truck visits, and train visits.
The Record Service Event form enables you to record a service event for the selected entity.
The Description and Billable Event fields in this form are read-only. N4 uses these fields to provide a short
description of the event and indicate whether the event is billable to the customer.
The Field Updates area in this form displays any fields that require user input. The fields displayed in this area depend
on the effects defined for the selected event. For more information, see Effects tab (on page 463).
To record a service event:
1. From the Event Type ID drop-down list, select the service event that you want to record for the selected entity.
The drop-down list displays only the service event types defined at the current scope level that apply to the selected
target entity and for which you have the required privilege (on page 795). For more information on adding a service
event type, see Event Type form (on page 461).
2. Optionally, select the Service Order Number associated with the event.
The Service Order Number drop-down list displays only the service orders that have either the In Progress or the
New status. It does not display a service order if the status is either Completed or Cancelled.
When you record an event with a service order number, N4 updates the service order item status to Completed. For
more information, see Service Order Inspector Units tab.
N4 extracts the selected service order number to the Service Order field in the Chargeable Unit Events view (on
page 546) for the event.
3. From the Responsible Party lookup field, select the party responsible. If N4 automatically fills in the Responsible
Party field using the value specified in the Billing Party field in the Service Order form, the value cannot be edited.
N4 extracts this value to the Payee Id field in the Chargeable Unit Events view for the event.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
464
Part 2: Services Management
Service Events
Record Service Event form
4. Optionally, record the Quantity and Quantity Unit associated with the selected event type.
For example, if you have an event that records power supplied for reefers, you can enter a value in the Quantity
field and select the unit of time (days or hours) in the Quantity Unit field.
5. Optionally, in the Note field, enter any notes for the service event.
6. Optionally, in the Apply Date field, enter the date when the event is performed.
By default, N4 displays the current system date in this field.
7. Click OK.
N4 displays the recorded service event for the selected entity on the History, Event tab.
If the selected service event type is bulk-applicable, but a validation prevents you from recording it for one or more of
the selected items, N4 does not record the service event for any of the selected items.
In addition, if N4 is configured to automatically update a field, add/release a hold, or grant/cancel a permission, per a
service event type effect or auto update rule (on page 507), N4 attempts to perform these tasks. If the change is
unsuccessful, N4 displays an error message. But for an auto update rule, if any of the following are true then N4 does
nothing:
• To release a hold when the hold is not active for the target entity.
• To cancel a permission when the permission is not granted for the target entity (permission will still be required).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
465
2.2.3 N4 Events
This section lists recorded events. You can use events to create Auto Update Rules (on page 508), Event Notifications,
or Notice Requests. You can also use events to trigger code extensions.
In This Section
Yard events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Rail Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Road events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cargo Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Booking and Booking Item Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unit Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vessel Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EC Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
467
468
468
469
479
479
466
Part 2: Services Management
Service Events
N4 Events
2.2.3.1 Yard events
N4 records the following events in the event history for a unit when:
• UNIT_YARD_MOVE: You move the unit from one yard location to another yard location, including manual
rehandles.
• UNIT_YARD_SHIFT: You move the unit due to an automatic rehandle.
2.2.3.2 Rail Events
N4 records the following events in the event history of the unit, when:
• UNIT_ENABLE_RAIL: The Stop-Rail field in the Units view is false, and a unit no longer has REQUIRED
permissions or ACTIVE holds that prevent you from performing the rail operations such as RAMP, or DERAMP. The
intended outbound carrier visit of the unit must be ‘train’.
• UNIT_DISABLE_RAIL: The Stop-Rail field in the Units view is true, and you add a hold or a permission for a unit
that prevents you from performing the rail operations such as RAMP, or DERAMP.
• RAILCAR_SPOTTING_FAILED - This error is thrown in the following cases:
▪ Transfer point does not correspond to the location on track plan.
▪ Meter mark does not correspond to location on track plan.
▪ GPS coordinate does not correspond to location on track plan.
▪ Railcar does not fit on track plan as spotted.
▪ Railcar length not defined.
2.2.3.3 Road events
N4 records the following events in the event history of the unit for the primary equipment, when:
• UNIT_ENABLE_ROAD: The Stop-Road field in the Units view is false, and a unit no longer has REQUIRED
permissions or ACTIVE holds that prevent you from delivering the unit out the gate. The intended outbound carrier
visit of the unit must be ‘truck’.
• UNIT_DISABLE_ROAD: You add a hold or a permission that prevents you from delivering the unit out the gate after
N4 recorded the UNIT_ENABLE_ROAD event for the unit.
IN/OUT events
N4 records specific events when a unit enters or exits a facility. These events can be categorized as:
• IN events: Are recorded when the unit transit state progresses to the EC-IN or YARD. This usually occurs when you
discharge a unit from a vessel or a train, or when you receive a unit through the gate.
• OUT events: Are recorded when the unit transit state progresses to DEPARTED. This usually occurs when a carrier
(vessel, truck, or train) on which you loaded the unit departs the facility.
The specific events that N4 records for a unit depend on the carrier mode:
• If the unit arrives by Truck, N4 records the UNIT_IN_GATE event (external ID: IN_GATE_CONTAINER); if the unit
departs by Truck, N4 records the UNIT_OUT_GATE event (external ID: OUT_GATE_CONTAINER).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
467
Part 2: Services Management
Service Events
N4 Events
• If the unit arrives by Vessel, N4 records the UNIT_IN_VESSEL event; if the unit departs by Vessel, N4 records the
UNIT_OUT_VESSEL event.
• If the unit arrives by Train, N4 records the UNIT_IN_RAIL event; if the unit departs by Train, N4 records the
UNIT_OUT_RAIL event.
In addition, N4 records the move events in each of the above cases when a CHE handles the unit. For example, when
you receive a unit through the gate, N4 records the UNIT_IN_GATE event and then records the UNIT_RECEIVE event
when the CHE places the unit into the yard. Similarly, when you deliver a container through the gate, N4 records the
UNIT_DELIVER event when the CHE places the unit onto the Truck and then records the UNIT_OUT_GATE event
when the truck exits the gate. However, not all fields are available for all events. For example, the Planned Position
field (PositionPlanned) is not available until after the unit is received (UNIT_IN_GATE is recorded).
2.2.3.4 Cargo Events
N4 records the following events for the Cargo entity:
CARGO_PROPERTY_UPDATE
• CARGO_PROPERTY_UPDATE: When you update the cargo lot details in the Edit Cargo Lot form.
You can view this event in the History, Events tab of the Unit Inspector and the Cargo Lot Inspector.
2.2.3.5 Booking and Booking Item Events
N4 records the following events related to the booking and booking item entities:
• BOOKING_CREATE: When a new booking is created.
• BOOKING_PROPERTY_UPDATE: When any of the following booking attributes are updated:
▪ Agent
▪ Booking Nbr
▪ Line Operator
▪ Trucking Co
▪ Client Ref Number
▪ Dispatch Reserved
▪ Owned/Lease
▪ Shipping Mode
▪ Dray Status
▪ Special Stow
▪ Stow block
▪ Stuffing Location
▪ Latest Date
▪ Override Cutoff
▪ Hold Partials
▪ Prevent Type Substitution
▪ Empty Pickup Location
▪ Full Return Location
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
468
Part 2: Services Management
Service Events
N4 Events
▪ Freight Kind
▪ Category
▪ Notes
▪ Remarks
• EQ_UPDATE_BKG: When youdelete a booking itemor if you update any of the following booking item attributes:
▪ Seq Nbr
▪ Equipment Type
▪ Accessory Type
▪ Tally Limit
▪ Receive Limit
• COMMODITY _UPDATE_BKG: When any of the following booking item attributes are updated:
▪ Commodity Description
▪ OOG - Back
▪ OOG - Front
▪ OOG - Left
▪ OOG - Right
▪ OOG - Height
▪ ISO OOG
2.2.3.6 Unit Events
This section describes some of the built-in events for the unit entity in N4. To view the event details of each event, use
the History, Event tab in the Unit Inspector for the unit.
Bundle events
N4 records the following events when you attach or detach payload equipment from the primary equipment in the unit:
Action
Event for Primary Unit
Event for Payload Unit
Attach the first Payload to a Primary unit
UNIT_BUNDLE
UNIT_BUNDLE_PAYLOAD_ADD
Detach a Payload from the Primary and the
Primary is no longer part of a bundle
UNIT_UNBUNDLE
UNIT_BUNDLE_PAYLOAD_SWIPE
Attach an additional Payload
UNIT_BUNDLE_ADD
UNIT_BUNDLE_PAYLOAD_ADD
Detach a Payload
UNIT_SWIPE
UNIT_BUNDLE_PAYLOAD_SWIPE
You can view the event details on the Event History tab in the Unit Inspector for the unit.
For a list of various events recorded for Primary, carriage, payloads, and accessories, see Primary, Carriage, Payload,
and Accessory Events (on page 468).
LOADLIST events
N4 records the following events when:
• UNIT_LOADLIST_EDI_CREATED: You successfully post a LOADLIST EDI for a container that is not at the facility.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
469
Part 2: Services Management
Service Events
N4 Events
• UNIT_LOADLIST_EDI_UPDATED: You successfully post a LOADLIST EDI for a container that is already at the
facility.
Each event traces the details of the field changes that were a result of posting the LOADLIST EDI. For a new unit,
changes are shown as null -> <new value>; for an existing unit the changes are shown as <previous value> -> <new
value>.
N4 records the changes to a field even if they appear to be the same before and after posting the EDI.
Mount events
The following table displays the events recorded in the event history of the units involved when you mount or unmount
a container/accessories on a carriage (cassette/chassis):
Equipment Role
Event Recorded on Mount
Event Recorded on Dismount
Primary
UNIT_MOUNT
UNIT_DISMOUNT
Carriage
UNIT_CARRIAGE_MOUNT
UNIT_CARRIAGE_DISMOUNT
Accssry/Ctr
UNIT_CTR_ACCESSORY_MOUNT
UNIT_CTR_ACCESSORY_DISMOUNT
Accssry/Chs
UNIT_CHS_ACCESSORY_MOUNT
UNIT_CHS_ACCESSORY_DISMOUNT
For more information on attaching and detaching equipment from a unit, see All Equipment tab.
SNX events
N4 records the following events when you use SNX to update an existing unit:
• UNIT_SNX_UPDATE: When N4 successfully creates or updates a unit through SNX.
If you use SNX to create a unit, N4 records "Unit created through SNX" in the Notes field for the event.
If you use SNX to update an existing unit, N4 records one of the following values in the Notes field for the event:
▪ Value of the snx-update-note attribute if the snx-update-note attribute is present
▪ "Unit updated through SNX" if the snx-update-note attribute is not present
When you use Administration DBA Import SNX File SNX Importer form to update an existing unit,
in addition to the UNIT_SNX_UPDATE event, N4 also records any field changes for the unit.
• UNIT_SNX_UPDATE_REJECTED: When N4 encounters an error and cannot successfully update an existing unit
through SNX.
UNIT_EQUIPMENT_MEASURED_WEIGHT event
When a unit’s yard measured weight is updated via script, ECN4, third-party, or TEAMS, N4 records the
UNIT_EQUIPMENT_MEASURED_WEIGHT event against the unit. You can view the event details on the History,
Events tab in the Unit Inspector.
N4 updates the Field Changes area in the Event Details form with the following information for the
UNIT_EQUIPMENT_MEASURED_WEIGHT event:
• Applied by: The user who was logged in when the event was recorded. The previous value is null.
• CHE ID: The CHE currently handling/fetching the container/last work instruction of the unit. The previous value is
null.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
470
Part 2: Services Management
Service Events
N4 Events
• Apply Date: The date and time at which the event was recorded. The previous value is null.
• Yard-wt (kg): The yard measured weight sent by the CHE. Displays the previous and updated values.
The Yard-wt field is not viewable in the Unit Inspector, by default. You can add a database-backed variform override
(on page 1079) for the Unit Inspector to view the Yard-wt field value in the Unit Inspector.
UNIT_EQ_OWNER_OPERATOR_CHANGE event
N4 records this event in the Event History of a unit when you update the Equipment Owner or Equipment Operator
fields for a unit. However, N4 does not record this event if the previous operator/owner was UNKN. You can view the
event details on the History, Events tab in the Unit Inspector.
UNIT_PROPERTY_UPDATE event
N4 records the UNIT_PROPERTY_UPDATE event at well defined places in the code and should not be expected for
each and every change in the system. This event does not duplicate a field change that is part of another system event
in the same transaction.
In addition, if you want to execute a general notice or an auto update rule (on page 507) based on an event recorded
for a unit, it is not recommended to use the UNIT_PROPERTY_UPDATE event; instead you must use a more specific
event. If a more specific event is not available, you can create a new custom event for this purpose that can be used in
a code extension based on the ENTITY_LIFECYCLE_INTERCEPTION (on page 977) code extension type.
From a performance point of view, it is better to use a specific or custom event. If you use a generic
UNIT_PROPERTY_UPDATE event, it may be called too many times, making it difficult and time consuming to find the
specific property you want.
N4 records the UNIT_PROPERTY_UPDATE event in the following cases:
• For Equipment Type updates when you post a Discharge List (BAPLIE).
• When you update the Container Weight using any form in N4.
• When you update unit inspection data using the Yard Inspector in N4 Mobile.
• When you update Observed Placards using any form in N4.
• When N4 receives Sparcs Details updates for a unit.
• When you get a VGM update for a container.
• When you update a unit's visibility in XPS using the Visibility form.
• When you update the temperature of a reefer container using the Temp field in XPS.
In addition to the above cases, the following sections list the various unit actions and instances where N4 records the
UNIT_PROPERTY_UPDATE and other specific events:
Events related to Unit Update Actions
Action
Routing
Fields
Data
Changed?
Event
Recorded?
Event Name
Carrier O/B
Intended
Yes
Yes
UNIT_REROUTE
Carrier O/B
Declared
Yes
Yes
UNIT_REROUTE
Category
Yes
Yes
UNIT_REROUTE
POD
Yes
Yes
UNIT_REROUTE
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
471
Part 2: Services Management
Action
Service Events
N4 Events
Fields
Overdimensions
Damages
Event
Recorded?
Event Name
Second POD
Yes
Yes
UNIT_REROUTE
Optional POD 1
Yes
Yes
UNIT_REROUTE
Optional POD 2
Yes
Yes
UNIT_REROUTE
Optional POD 3
Yes
Yes
UNIT_REROUTE
Group
Yes
Yes
UNIT_REROUTE
Destination
Yes
Yes
UNIT_REROUTE
Dray Status
Yes
Yes
UNIT_REROUTE
Bonded Destination Yes
Yes
UNIT_REROUTE
Yes
No
None
Hold/Permission
Yes
No
None
Description
No
No
None
Target Entity Type
No
No
None
Relation to
Reference
Guardian
No
No
None
Referenced
Guardian Entity
No
No
None
Reference ID
Yes
No
None
Note
Yes
No
None
Equipment Type
Yes
Yes
UNIT_PROPERTY_UPDATE
Freight Kind
Yes
Yes
UNIT_PROPERTY_UPDATE
Gross Weight
Yes
Yes
UNIT_PROPERTY_UPDATE
Requires Power
Yes
Yes
UNIT_PROPERTY_UPDATE
Reefer Type
Yes
Yes
UNIT_PROPERTY_UPDATE
Special Stow
Yes
Yes
UNIT_PROPERTY_UPDATE
Equipment Grade
Yes
Yes
UNIT_PROPERTY_UPDATE
Deck Stowage
Requirements
Yes
Yes
UNIT_PROPERTY_UPDATE
Unit Notes
Yes
Yes
UNIT_PROPERTY_UPDATE
M&R Status
Yes
Yes
UNIT_PROPERTY_UPDATE
Condition
Yes
Yes
UNIT_PROPERTY_UPDATE
Color
Yes
Yes
UNIT_PROPERTY_UPDATE
Overwide Left
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overwide Right
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overheight
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overlong Back
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overlong Front
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Height
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Damage Type
Yes
Yes
UNIT_DAMAGES_UPDATED
Holds/Permission Action
Physical Status
Data
Changed?
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
472
Part 2: Services Management
Action
Service Events
N4 Events
Fields
Data
Changed?
Event
Recorded?
Event Name
(If you add a new damage type, N4
records the UNIT_DAMAGED event.)
Hazards
Component
Yes
Yes
UNIT_DAMAGES_UPDATED
Severity
Yes
Yes
UNIT_DAMAGES_UPDATED
Location
Yes
Yes
UNIT_DAMAGES_UPDATED
Quantity
Yes
Yes
UNIT_DAMAGES_UPDATED
Length
Yes
Yes
UNIT_DAMAGES_UPDATED
Width
Yes
Yes
UNIT_DAMAGES_UPDATED
Depth
Yes
Yes
UNIT_DAMAGES_UPDATED
Reported on
Yes
Yes
UNIT_DAMAGES_UPDATED
Repaired on
Yes
Yes
UNIT_DAMAGES_UPDATED
Notes
Yes
Yes
UNIT_DAMAGES_UPDATED
IMDG Class
Yes
Yes
UNIT_HAZARDS_INSERT
UNIT_HAZARDS_UPDATE
UN/NA Number
Yes
Yes
UNIT_HAZARDS_INSERT
UNIT_HAZARDS_UPDATE
Hazard Number
Type
Yes
No
None
Proper Name
Yes
No
None
Technical Name
Yes
No
None
Notes
Yes
No
None
Quantity
Yes
Yes
UNIT_HAZARDS_INSERT
UNIT_HAZARDS_UPDATE
Packing Group
Yes
No
None
Explosive Class
Yes
No
None
Emergency
Contact
Yes
No
None
Limited Quantity
Yes
No
None
Marine Pollutants
Yes
No
None
Inhalation Zone
Yes
No
None
MFAG
Yes
No
None
Substance Id,
Lower Part
Yes
No
None
Move Method
Yes
No
None
IMO2
Yes
No
None
Package Type
Yes
No
None
Weight
Yes
Yes
UNIT_HAZARDS_INSERT
UNIT_HAZARDS_UPDATE
Flash Point
Yes
Yes
UNIT_HAZARDS_INSERT
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
473
Part 2: Services Management
Action
Service Events
N4 Events
Fields
Data
Changed?
Event
Recorded?
Event Name
UNIT_HAZARDS_UPDATE
Emergency
Response Guide
Nbr
Yes
No
None
IMDG Page
Number
Yes
No
None
DcLgRef
Yes
No
None
EMS
Yes
No
None
Hazard Id, Upper
Part
Yes
No
None
Planner Reference
Number
Yes
No
None
IMO1
Yes
No
None
Deck Restrictions
Yes
No
None
Seal Number 1
Yes
Yes
UNIT_SEAL
Seal Number 2
Yes
Yes
UNIT_SEAL
Seal Number 3
Yes
Yes
UNIT_SEAL
Seal Number 4
Yes
Yes
UNIT_SEAL
Yes
Yes
UNIT_PROPERTY_UPDATE
Shipper
Yes
Yes
UNIT_PROPERTY_UPDATE
Origin
Yes
Yes
UNIT_PROPERTY_UPDATE
Destination
Yes
Yes
UNIT_PROPERTY_UPDATE
Commodity Code
Yes
Yes
UNIT_PROPERTY_UPDATE
BL Number
Yes
Yes
UNIT_PROPERTY_UPDATE
Inbond Status
Yes
Yes
UNIT_PROPERTY_UPDATE
Exam Status
Yes
Yes
UNIT_PROPERTY_UPDATE
Last Free Day
Override
Yes
Yes
UNIT_STORAGE_UPDATE
Carrier I/B
Declared
Yes
Yes
UNIT_PROPERTY_UPDATE
Port of Load
Yes
Yes
UNIT_PROPERTY_UPDATE
Original Port of
Load
Yes
Yes
UNIT_PROPERTY_UPDATE
Last Day Override
Yes
Yes
UNIT_STORAGE_UPDATE
UNIT_PROPERTY_UPDATE
Fire Code
Seals
Shipment Details Consignee
Storage
Guarantee Through
Day
Etc
Other Details
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
474
Part 2: Services Management
Action
SPARCS Details
Service Events
N4 Events
Fields
Data
Changed?
Event
Recorded?
Event Name
Storage Paid
Through Day
Yes
Yes
UNIT_STORAGE_UPDATE
UNIT_PROPERTY_UPDATE
Restow Type
Yes
No
None
Handling Reason
Yes
No
None
Yard Stowage Type Yes
No
None
Is Sparcs Stopped
Check Box
Yes
No
None
Is Changed Check
Box
Yes
No
None
Verified Yard
Yes
Position Check Box
No
None
Anomaly For Ed
Check Box
Yes
No
None
Validate Release
Group Check Box
Yes
No
None
Release Is
Yes
Transferable Check
Box
No
None
Ignore Payload
Yes
Weighs Check Box
No
None
Ignore Payload
Yes
Heights Check Box
No
None
Needs Review
Check Box
Yes
No
None
Sparcs Notes
Yes
Yes
UNIT_PROPERTY_UPDATE
Ec-in Time
Yes
No
None
Time Facility In
Yes
No
None
Time Facility Out
Yes
No
None
Delivery Time
Yes
No
None
Inventory Time
Yes
No
None
Complete Time
Yes
No
None
Yes
Yes
UNIT_OPERATOR_CHANGE
UNIT_PROPERTY_UPDATE
Yes
Yes
UNIT_REROUTE
Show Unit Details Line Operator
Editor
Category
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
475
Part 2: Services Management
Action
Service Events
N4 Events
Fields
Data
Changed?
Event
Recorded?
Event Name
Freight Kind
Yes
Yes
UNIT_PROPERTY_UPDATE
Commodity Code
Yes
Yes
UNIT_PROPERTY_UPDATE
Reefer Type
Yes
Yes
UNIT_PROPERTY_UPDATE
Carrier O/B
Intended
Yes
Yes
UNIT_REROUTE
Pol
Yes
Yes
UNIT_PROPERTY_UPDATE
Pod
Yes
Yes
UNIT_REROUTE
Second POD
Yes
Yes
UNIT_REROUTE
Destination
Yes
Yes
UNIT_REROUTE
Seal Number 1
Yes
Yes
UNIT_SEAL
Seal Number 2
Yes
Yes
UNIT_SEAL
Seal Number 3
Yes
Yes
UNIT_SEAL
Seal Number 4
Yes
Yes
UNIT_SEAL
Overwide Left
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overwide Right
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
Overheight
Yes
Yes
UNIT_OVERDIMENSIONS_UPDATE
SPARCS Notes
Yes
Yes
UNIT_PROPERTY_UPDATE
Special Stow
Yes
Yes
UNIT_PROPERTY_UPDATE
Hazards
Yes
Yes
Unit Notes
Yes
Yes
UNIT_PROPERTY_UPDATE
Gross Weight
Yes
Yes
UNIT_PROPERTY_UPDATE
Require Power
Check Box
Yes
Yes
UNIT_PROPERTY_UPDATE
Temp Required
Yes
Yes
Equipment Type
Yes
Yes
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
UNIT_PROPERTY_UPDATE
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
476
Part 2: Services Management
Action
Service Events
N4 Events
Fields
Data
Changed?
Event
Recorded?
Event Name
Line Operator
Line Operator
Yes
Yes
UNIT_OPERATOR_CHANGE
Update Delivery
Requirements
Trucking Company Yes
Yes
UPDATE_DELIVERY_RQMNTS
UNIT_TRUCKER_ASSIGNED
Destination
Yes
Yes
UPDATE_DELIVERY_RQMNTS
Return to Location
Yes
Yes
UPDATE_DELIVERY_RQMNTS
Pin Number
Events related to Unit Reefer Actions
Action
Fields
Update Reefer
Requirements
Data
Changed?
Temperature
Required
Yes
Event
Recorded?
Yes
Event Name
REEFER_SETTINGS_RECORDED
Temp Max
Etc
Update Reefer Power
Status
Check Boxes
Record Reefer Readings
Time
Temperature
Etc
Events related to Unit Transaction Actions
Action
Record Guarantee
Fields
Data
Changed?
Event
Recorded?
Event Name
Extract Event Type
Id
Customer
Start Day
End Day
Quantity
Amount
Notes
Customer Reference
Record Waiver
Extract Event Type
ID
Yes
No
None
Customer
Yes
No
None
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
477
Part 2: Services Management
Service Events
N4 Events
Action
Fields
Reserve Equipment
Data
Changed?
Event
Recorded?
Event Name
Start Day
Yes
No
None
End Day
Yes
No
None
Quantity
Yes
No
None
Amount
Yes
No
None
Notes
Yes
No
None
Customer Reference Yes
No
None
Waiver Type
Yes
No
None
Waiver Start Date
Yes
No
None
Order Number
Yes
Yes
UNIT_RESERVE
Carrier O/B Intended Yes
Yes
UNIT_RESERVE
Yes
Yes
UNIT_CANCEL_RESERVATION
Cancel Equipment
Reservation
Events related to Unit Administration Actions
Action
Fields
Data Changed?
Refresh Unit
Rectify Unit
Renumber
Event Recorded?
Event Name
No
NONE
Transit State
Yes
Yes
UNIT_RECTIFY
Carrier I/B Actual
Yes
Yes
UNIT_RECTIFY
Carrier O/B Actual
Yes
Yes
UNIT_RECTIFY
Time of Loading
Yes
Yes
UNIT_RECTIFY
Time Facility In
Yes
Yes
UNIT_RECTIFY
Time Facility Out
Yes
Yes
UNIT_RECTIFY
Slot/Slow
Yes
Yes
UNIT_RECTIFY
Visit State
Yes
Yes
UNIT_RECTIFY
Note
Yes
Yes
UNIT_RECTIFY
Enter Number
Yes
Yes
UNIT_RENUMBER
Depart Unit
Yes
Yes
UNIT_OUT_GATE
Cancel Advised
Yes
VGM recording events
N4 records the following events in the History, Events tab of the Unit Inspector to record the changes related to the
VGM for a unit.
• UNIT_VGM_ASSIGNED: When the VGM is initially recorded for a unit, either manually or through EDI.
• UNIT_VGM_UPDATED: When the existing VGM is updated for a unit, either manually or through EDI.
• UNIT_VGM_CANCEL: When the VGM is deleted for a unit, either manually or through EDI.
The event UNIT_PROPERTY_UPDATE is no longer functional for VGM related changes. When you update the VGM
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
478
Part 2: Services Management
Service Events
N4 Events
through Update Verified Gross Mass form and create an auto update rule using the above events to replace the
gross weight with the VGM weight, N4 updates the gross weight for the unit with the field changes.
There is no VGM field in XPS, but you can update the XPS Gross Weight value with the N4 VGM. See Push VGM to
XPS Gross Weight field for more information.
2.2.3.7 Vessel Events
N4 records the following built-in events for the vessel entity in the History, Event tab in the Vessel Inspector for the
vessel visit:
• ADD_VV_COMPLEX_ROTATION: You add a vessel visit to a complex rotation.
• CAS_VESSEL_VISIT_UPDATE: A response is sent to CAS when a vessel visit is updated.
• CAS_VV_REQUEST_CONTAINER_LIST: CAS requests for the on-board container list or crane work lists for a
vessel visit.
• CAS_VV_REQUEST_GEOMETRY: CAS requests for the geometry of a vessel.
• DEL_FROM_COMPLEX_ROTATION: Vessel visit deleted for facility <FCY> from the complex rotation.
• DELETE_STOWPLAN: You delete the vessel stowplan.
• NOTICE_VV: A notice is generated for the vessel visit.
• PHASE_VV: The vessel visit phase is changed.
• REPLACE_STOWPLAN: The stowplan is replaced for the vessel.
• UPDATE_VV: The vessel visit is updated.
• VESSEL_DIVERTED: You divert a vessel visit.
• VESSEL_VISIT_ARRIVING_EARLIER : Vessel visit shifted earlier in complex rotation.
• VESSEL_VISIT_ARRIVING_LATER : Vessel visit shifter later in complex rotation.
2.2.3.8 EC Events
N4 uses EC Events to record CHE activities and for calculating CHE statistics. Investigating EC events is helpful when
debugging the application. The EC Events view in N4 lists all EC events along with their gkey, timestamp, type
description, sub type, position ID, CHE name, and so on. You can also view EC events on the EC Events tab in the
Work Assignment Inspector.
EC Events are categorized under the following headings:
• Operator events
• Move EC Events
• Move EC Events ( Enhanced)
• Advanced EC Events
• Crane EC Events
• Abort EC Events
• Status Update EC Events
• Unit Capture EC Events
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
479
Part 2: Services Management
Service Events
N4 Events
Operator events
The following table lists the Operator (CHE) events.
Description
Event ID
EC Event Type
Operator logs in
LGON
1 - CheLogin
Operator logs out
LGOF
2 - CheLogout
Operator starts break
BKON
3 - CheStartBreak
Operator ends break
BKOF
4 - CheEndBreak
Operator goes available
AVAL
5 - CheAvailable
Operator pending unavailable
PEND
6 - ChePending
Operator goes unavailable
UNAV
7 - CheUnavailable
Move EC Events
The following table lists the Move EC Events.
Description
Event ID
EC Event Type
Job is dispatched to CHE
DSPT
8 - CheJobDispatch
CHE fetches the job
FTCH
9 - CheJobFetch
CHE completes the job
CMPL
10 - CheJobComplete
CHE is idle
IDLE
11 - Che_JobStep_Idle
CHE arrives at row to drop container
AYDR
12 - Che_JobStep_AtRowToDropCntr
CHE sent to row to drop container
TYDR
13 - Che_JobStep_ToRowToDropCntr
CHE arrives at row to lift container
AYCO
14 - Che_JobStep_AtRowToCollectCntr
CHE sent to row to lift container
TYCO
15 - Che_JobStep_ToRowToCollectCntr
CHE arrives at ship to drop container
AVDR
16 - Che_JobStep_AtShipToDropCntr
CHE sent to ship to drop container
TVDR
17 - Che_JobStep_ToShipToDropCntr
CHE arrives at ship to lift container
AVCO
18 - Che_JobStep_AtShipToCollectCntr
CHE sent to ship to lift container
TVCO
19 - Che_JobStep_ToShipToCollectCntr
CHE arrives at rail to drop container
ARDR
20 - Che_JobStep_AtRailToDropCntr
CHE sent to rail to drop container
TRDR
21 - Che_JobStep_ToRailToDropCntr
CHE arrives at rail to collect container
ARCO
22 - Che_JobStep_AtRailToCollectCntr
CHE sent to rail to collect container
TRCO
23 - Che_JobStep_ToRailToCollectCntr
CHE enters parallel buffer
ENPB
36 - Enter_Parallel_Buffer
CHE exits parallel buffer
EXPB
37 - Exit_Parallel_Buffer
CHE exits origin
EXOR
38 - Exit_Origin
CHE activity ends
ASRT
CHE assigned to a zone
AEND
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
480
Part 2: Services Management
Service Events
N4 Events
Move EC Events (Enhanced)
The following table lists the Move EC Events (Enhanced).
Description
Event ID
EC Event Type
EC Event Subtype
CHE is laden to grid
LTGD
24 - Che_JobStep_Enhanced 1 - JSLadenToGrid
CHE laden to row
LTRW
24 - Che_JobStep_Enhanced 2 - JSLadenToRow
CHE laden to ship
LTSH
24 - Che_JobStep_Enhanced 3 - JSLadenToShip
CHE laden to rail
LTRL
24 - Che_JobStep_Enhanced 4 - JSLadenToRail
CHE laden at grid
LAGD
24 - Che_JobStep_Enhanced 5 - JSLadenAtGrid
CHE laden at row
LARW
24 -Che_JobStep_Enhanced 6 - JSLadenAtRow
CHE laden at ship
LASH
24 - Che_JobStep_Enhanced 7 - JSLadenAtShip
CHE laden at rail
LARL
24 - Che_JobStep_Enhanced 8 - JSLadenAtRail
CHE sent empty to grid
ETGD
24 - Che_JobStep_Enhanced 9 - JSEmptyToGrid
CHE sent empty to row
ETRW
24 - Che_JobStep_Enhanced 10 - JSEmptyToRow
CHE sent empty to ship
ETSH
24 - Che_JobStep_Enhanced 11 - JSEmptyToShip
CHE sent empty to rail
ETRL
24 - Che_JobStep_Enhanced 12 - JSEmptyToRail
CHE empty at grid
EAGD
24 - Che_JobStep_Enhanced 13 - JSEmptyAtGrid
CHE empty at row
EARW
24 - Che_JobStep_Enhanced 14 - JSEmptyAtRow
CHE empty at ship
EASH
24 - Che_JobStep_Enhanced 15 - JSEmptyAtShip
CHE empty at rail
EARL
24 - Che_JobStep_Enhanced 16 - JSEmptyAtRail
CHE shift in row
SIRW
24 - Che_JobStep_Enhanced 17 - JSShiftInRow
CHE empty at buffer heap
EABH
24 - Che_JobStep_Enhanced 18 - JSEmptyAtBufferHeap
CHE laden with twin to row
LTTR
24 - Che_JobStep_Enhanced 19 - JSLadenTwinToRow
CHE laden with twin to ship
LTTS
24 - Che_JobStep_Enhanced 20 - JSLadenTwinToShip
CHE laden with twin at row
LTAR
24 - Che_JobStep_Enhanced 21 - JSLadenTwinAtRow
CHE laden with twin at ship
LTAS
24 - Che_JobStep_Enhanced 22 - JSLadenTwinAtShip
CHE send to fetch 2nd twin to
row
FTTR
24 - Che_JobStep_Enhanced 23 - JSFetch2ndTwinToRow
CHE fetch 2nd twin at row
FTAR
24 - Che_JobStep_Enhanced 24 - JSFetch2ndTwinAtRow
CHE laden in ship buffer entry
LSBN
24 - Che_JobStep_Enhanced 33 - JSLadenInShipBufferEntry
CHE empty in ship buffer entry
ESBN
24 - Che_JobStep_Enhanced 34 - JSEmptyInShipBufferEntry
CHE laden in ship buffer exit
LSBX
24 - Che_JobStep_Enhanced 35 - JSLadenInShipBufferExit
CHE empty in ship buffer exit
ESBX
24 - Che_JobStep_Enhanced 36 - JSEmptyInShipBufferExit
CHE laden in row to container
position
LRTP
24 - Che_JobStep_Enhanced 37 - JSLadenInRowToContainerPosition
CHE empty in row to Carry CHE
ERTC
24 - Che_JobStep_Enhanced 38 - JSEmptyInRowToCarryChe
CHE laden in row to Carry CHE
LRTC
24 - Che_JobStep_Enhanced 39 - JSLadenInRowToCarryChe
CHE empty in row to container
position
ERTP
24 - Che_JobStep_Enhanced 40 - JSEmptyInRowToContainerPosition
CHE repositioning
RPSN
24 - Che_JobStep_Enhanced 41 - JSRepositioning
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
481
Part 2: Services Management
Service Events
N4 Events
Description
Event ID
EC Event Type
CHE Assign Zone
CZAS
27 - Che_Zone
CHE Unassign Zone
CZAU
27 - Che_Zone
CHE In Service
INSV
26 - Che_Service
CHE Out of Service
OTSV
26 - Che_Service
CHE Assign POW
PWAS
28 - Che_Pow
CHE Unassign POW
PWUA
28 - Che_Pow
CHE Link Trailer
TRLK
32 - Che_Trailer
CHE Unlink Trailer
TRUK
32 - Che_Trailer
Empty in row at container
position
ERAP
Empty in row at carry CHE
ERAC
Laden in row at container
position
LRAP
Laden in row at carry CHE
LRAC
EC Event Subtype
Laden Twin in Row To Container
LTTP
Position
Laden Twin in Row To Carry
CHE
LTTC
Laden Twin At Container
Position
LTCP
Laden At Carry CHE
LTCC
Advanced EC Events
The following table lists the Advanced EC Events.
Description
Event ID
EC Event Type
EC Event Subtype
Login to ship and crane
LSAC
25 - Che_Advanced
25 - LogonToShipAndCrane
Update pool
UPOL
25 - Che_Advanced
26 - UpdatePool
QC waiting for load
QCWL
25 - Che_Advanced
29 - QCWaitingForTTLoad
QC waiting for discharge
QCWD
25 - Che_Advanced
30 - QCWaitingForTTDischarge
QC fetch from TT
QCFI
25 - Che_Advanced
31 - QCFetchFromTT
QC Put to TT
QCPI
25 - Che_Advanced
32 - QCPutToTT
CHE Drop
DROP
25 - Che_Advanced
55 - CheDrop
QC fetch from lane
QCFL
42 - QCFetchFromLane
QC Put to lane
QCPL
43 - QCPutToLane
QC Reconcile
QCRC
CHE Lift
LIFT
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
25 - Che_Advanced
54 - CheLift
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
482
Part 2: Services Management
Service Events
N4 Events
Crane EC Events
The following table lists the Crane EC Events.
Description
Event ID
EC Event Type
EC Event Subtype
Crane Shift Work Start
WSTT
30 - CraneShift_Work
27 - Begin
Crane Shift Work End
WEND
30 - CraneShift_Work
28 - End
Crane Shift First Lift
SFLF
31 - CraneShift_Lift
27 - Begin
Crane Shift Last Lift
SLLF
31 - CraneShift_Lift
28 - End
Abort EC Events
The following table lists the Abort EC Events.
Description
Event ID
EC Event Type
EC Event Subtype
Abort on Door
ABDR
34 - Che_JobAbort 46 - AbortDoorDir
Abort on Crane Lift
ABLF
34 - Che_JobAbort 47 - AbortCraneLift
Abort on Crane Set
ABST
34 - Che_JobAbort 48 - AbortCraneSet
Abort on Crane Error
ABER
34 - Che_JobAbort 49 - AbortCraneError
Abort on TOS Cancel
ABCN
34 - Che_JobAbort 50 - AbortTOSCancel
Abort on ECS
Rejection
ABRJ
59 - AbortECSRejection
Abort on Unladen
ABUL
60 - AbortUnladen
Abort on Laden
ABLA
61 - AbortLaden
CHE Cancel Job
CNCL
34 - Che_JobAbort 57 - CheCancelJob
CHE Abandon Job
ABJB
34 - Che_JobAbort 56 - CheAbandonJob
Status Update EC Events
The following table lists the Status Update EC Events.
Description
Event ID
EC Event Type
EC Event Subtype
Status Update Offline
SUOF
24 - Che_JobStep_Enhanced
53 - CheStatusOffline
Status Update Automatic TOS
SUTS
24 - Che_JobStep_Enhanced
51 - CheStatusAutoTOS
Status Update Manual
SUMA
24 - Che_JobStep_Enhanced
52 - CheStatusManual
Status Update Break Down
SUBD
24 - Che_JobStep_Enhanced
58 - CheFault
Unit Capture EC Events
The following table lists the Unit Capture EC Events.
Description
Event ID
UCID
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
EC Event Type
EC Event Subtype
45 - UnitCaptureIdentify
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
483
Part 2: Services Management
Description
Event ID
Service Events
N4 Events
EC Event Type
UCIM
46 - UnitCaptureImage
UCMI
51 - UnitCaptureMisidentify
TROK
47 - UnitTransferAllowed
TRNO
50 - UnitTransferNotAllowed
EC Event Subtype
UC1C
68 - UnitCorrectedOnChe
UC0C
69 - UnitCorrectedOffChe
EC Event Type Categories
An EC Event is identified by a (EC Event type / EC Event subtype) pairing. The EC Event type categories are noted
below. The EC Event subtypes which apply for a specific EC Event are noted in the breakout tables above.
Type
Description
0
Unknown
1
CHE Login
2
CHE Logout
3
CHE Start Break
4
CHE End Break
5
CHE Available
6
CHE Pending
7
CHE Unavailable
8
CHE Job Dispatch
9
CHE Job Fetch
10
CHE Job Complete
11
CHE Jobstep IDLE
12
CHE Jobstep AT Row To Drop Cntr
13
CHE Jobstep TO Row to Drop Cntr
14
CHE Jobstep AT Row To Collect Cntr
15
CHE Jobstep TO Row To Collect Cntr
16
CHE Jobstep AT Ship To Drop Cntr
17
CHE Jobstep TO Ship To Drop Cntr
18
CHE Jobstep AT Ship To Collect Cntr
19
CHE Jobstep TO Ship To Collect Cntr
20
CHE Jobstep AT Rail To Drop Cntr
21
CHE Jobstep TO Rail To Drop Cntr
22
CHE Jobstep AT Rail To Collect Cntr
23
CHE Jobstep TO Rail To Collect Cntr
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
484
Part 2: Services Management
Type
Service Events
N4 Events
Description
24
CHE Jobstep Enhanced
25
CHE Advanced
26
CHE Service
27
CHE Zone
28
CHE POW
29
CHE Act
30
Craneshift Work
31
Craneshift Lift
32
CHE Trailer
33
CHE Quay Crane
34
CHE Job Abort
35
CHE Corrected
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
485
2.3 Hold Management
In This Section
Holds/Permissions Groups view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Holds/Permissions view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hold/Release Inbound Unit form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Business Rules view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auto Update Rules view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hold Settings in XPS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
487
488
501
502
505
510
486
Part 2: Services Management
Hold Management
Holds/Permissions Groups view
2.3.1 Holds/Permissions Groups view
Configuration
Services
Holds/Permissions Groups
Holds/Permissions Groups view
The Holds/Permissions Groups view displays the hold/permission groups that exist at the current scope level. You
can use a hold/permission group to group together holds and permissions that share a similar business need or
purpose. For example, you can use a Customs hold/permission group for holds and permissions that are associated
with customs.
If you associate a group to one or more holds/permissions with associated service business rules (on page 502), then
N4 displays the hold/permission group in the following columns:
• Unit Hold/Perm Groups column in the Units view as follows:
▪ When a unit or its guardian has one or more active holds or required or granted permissions that are associated
with a hold/permission group.
• Unit Impediments View column in the Units view and Appointments view as follows:
▪ When a unit or its guardian has one or more active holds or required permissions that are associated with a hold/
permission group.
▪ If all of the holds and permissions associated with a group have been released or granted, the associated hold/
permission group does not display.
If more than one hold/permission group applies, then N4 displays them in a comma-separated list in the
Hold/Perm Groups and Unit Impediments View columns.
For example, if there is a Line, Terminal, and Customs hold/permission group defined and associated with various line,
terminal, and customs holds/permissions, then N4 displays the following in the Unit Impediments View column:
• Line, Terminal, Customs: If a unit has at least one active hold or required permission for each group.
• Line, Terminal: If all of the holds and permissions associated with the Customs group are released and granted,
respectively.
• blank: If a unit does not have any active holds or required permissions associated with the Line, Terminal, or
Customs group.
Holds/Permissions Groups Columns
Short Label
Long Label
In Filter?
Sorting?
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Description
Description
X
X
ID
Id
X
X
2.3.1.1 Hold/Permission Groups form
Configuration
Services
Holds/Permissions Groups
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Holds/Permissions Groups view
Hold/Permission Groups form
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
487
Part 2: Services Management
Hold Management
Holds/Permissions view
The Hold/Permission Groups form enables you to add and edit hold/permission groups. You can use a hold/
permission group to group together holds and permissions that share a similar business need or purpose, such as for
customs holds/permissions.
To add or edit a hold/permission group:
1. In the Id field, enter a unique identifier for the hold/permission group.
2. Optionally, in the Description field, enter a short description for the hold/permission group.
3. Click Save.
2.3.2 Holds/Permissions view
Configuration
Services
Holds/Permissions
Holds/Permissions view
The Holds/Permissions view displays the holds and permissions that exist at the current scope level. You use a hold/
permission to define a service business rule (on page 502) to set up a condition that prevents an event from occurring
for the target entity.
When choosing between a hold and a permission type, the most important consideration is whether preventing the
associated event from happening is a common occurrence or an exception. If it is a common occurrence, we
recommend you use Permissions types to prevent an event from occurring for all target entities of a specific type.
For example, if you define a Customs Export Permission for all export containers leaving the country, it will ensure that
no container leaves the terminal until the required permission is granted.
A Hold type, on the other hand, can be used for more specific situations that are not applicable to a large set of target
entities.
For example, in some countries, the Customs Department randomly selects import containers arriving on a vessel to
require being X-Rayed before they can be delivered. The X-Ray hold will have to be applied to the specified units while
the other units will remain unaffected.
To use a hold or permission, you must define a corresponding service business rule. For more information, see
Service Business Rules view (on page 502).
When a corresponding service business rule is defined, a Permission type by default:
• Is automatically applied to all target entities that satisfy the filter criteria defined in the service business rule and,
• Is required and prevents an event from occurring.
• Must be granted for the target entity to allow the event to occur.
• If granted, must be canceled for a target entity to prevent the event from occurring.
For example, a container may require a customs permission before it can be delivered.
When a corresponding service business rule is defined, a Hold type by default:
• Must be manually added to a target entity to prevent the event from occurring
• Must be released for a target entity to allow the event to occur.
• If released, must be manually added again to a target entity to prevent the event from occurring.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
488
Part 2: Services Management
Hold Management
Holds/Permissions view
For example, you must add a customs inspection hold to a container to prevent the container from being delivered
before it is inspected.
For an existing Simple Hold or Simple Permission service business rule, you can configure an auto update
rule to automatically add/release a hold or grant/cancel a permission when an event occurs. You should also
consider that instead of using a Permission type, you can configure an auto update rule to automatically add a
Hold type to a large set of target entities when an event occurs. For more information, see Auto Update Rule
form (on page 507).
You can add holds/permissions, and edit or delete existing holds/permissions from this view.
You cannot delete a hold/permission if it is used in an active service business rule.
In addition, you can use the Actions menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted holds/permissions.
• Purge (on page 208), Purge (on page 1215): Purge holds/permissions.
Holds/Permissions Columns
Short Label
Long Label
In Filter?
Sorting?
Applies To
Applies To
X
X
Apply Event
Apply Event
X
X
Billing Hold
Billing Hold Required
X
X
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Description
Description
X
X
Hold/Perm Groups
Hold/Permission Groups
X
X
ID
Id
X
X
LifeCycleState
Life Cycle State
X
X
MultipleHolds Allowed
MultipleHolds Allowed
X
X
Ref ID Required
Reference ID Required
X
X
Type
Type
X
X
Unique by RefId
Unique by Reference ID
X
X
Veto Event
Veto Event
X
X
2.3.2.1 Hold/Permission Type form
Configuration
Services
Holds/Permissions
Holds/Permissions view
Hold/Permission Type form
The Hold/Permission Type form enables you to add and edit hold/permission types. A hold/permission is one of the
two components that you need to define to prevent an event from occurring for a target entity type. After you have
defined the holds/permissions for your site, you must associate these holds/permissions with service business
rules (on page 502) before you can apply/grant these holds/permissions to the target entity type.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
489
Part 2: Services Management
Hold Management
Holds/Permissions view
To add or edit a hold/permission:
1. In the Id field, enter an ID that uniquely identifies the hold/permission.
Use a short meaningful name that provides information about the type of hold/permission.
Ensure that the hold/permission ID does not end in a period as N4 uses these IDs to generate the privilege
names for privileges required to add/release/grant these holds/permissions.
2. Optionally, in the Description field, enter a short description for the hold/permission.
3. From the Applies To drop-down list, select the business entity type such as equipment, unit, or vessel visit, to which
you want to apply the hold/permission.
N4 keeps active holds/permissions applied to equipment while in use within a complex until the hold/
permission is released or granted, regardless of the number of visits the equipment makes to a facility. For
example, if a full container departs a facility with an active hold/permission, when the container returns to a
facility within the complex N4 keeps the active hold/permission applied to the container. This is not true for
active holds/permissions applied to a unit.
4. From the Type drop-down list, select Hold or Permission to indicate if you are adding a hold or a permission.
5. Optionally, select the Reference ID Required check box to ensure that a reference ID is specified when the hold is
added/released or the permission is granted/canceled.
6. Optionally, select the Unique by Reference ID check box if you want to apply multiple holds/permissions of the
same type to an entity by using a unique reference ID for each instance of the hold/permission.
7. Optionally, select the Billing Hold Required check box if the hold is a payment hold. For more information, see
Payment Holds (on page 491).
8. Optionally, select the Is a Covert Hold/Permission check box if the hold is a covert hold. For more information, see
Create covert holds (on page 498).
9. Optionally, select the MultipleHolds Allowed check box if you want to add multiple holds for the same reference ID.
In addition, if you process EDI with multiple codes that are associated with a hold where the MultipleHolds Allowed
check box is selected, N4 can apply the same hold multiple times for that reference Id. For example, you can use
this to process a 350 message with multiple US customs 7H disposition codes that apply a hold for each disposition
code on the associated bill of lading. For more information, see Configure EDI to apply a hold multiple times for the
same reference ID (on page 255).
If you select the MultipleHolds Allowed check box and the Unique by Reference ID check box for the
same hold/permission, N4 does not allow you to apply multiple holds with the same reference Id. In this
case, N4 displays this warning message: "Multiple holds cannot be applied since hold with reference Id
already exists."
10. Optionally, from the Apply Event drop-down field, select the event type you want to record in the event history of
the entity when N4 applies the hold/grants the permission. For permissions, the Apply event is only created when
the permission is granted.
The drop-down list displays only the user-defined events that exist at the current scope level; it does not display any
built-in event types. To add a new event type, use the Event Type form (on page 461).
11. Optionally, from the Veto Event drop-down field, select the event type you want to record in the event history of the
entity when N4 releases the hold/withdraws the permission.
The drop-down list displays only the user-defined events that exist at the current scope level; it does not display any
built-in event types.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
490
Part 2: Services Management
Hold Management
Holds/Permissions view
12. Optionally, from the Hold/Permission Groups drop-down list, select a group for the hold/permission applied.
Using a hold/permission group enables you to keep similar holds and permissions together. For more information
and adding hold/permission groups, see Holds/Permissions Groups view (on page 487).
13. Click Save.
Next step(s):
• After you have added a hold/permission, you must associate it with a service business rule (on page 502), before
you can apply the hold/permission to an entity, such as a unit.
2.3.2.2 Determine when to use a permission versus a hold
If an entity is held by default, you should use a permission. A hold must be manually applied to an entity to work, but
N4 automatically applies permissions to the applicable entities per the filter criteria defined in a service business rule.
For example, if you want to prevent a deliver gate event for all ABC import containers, you can use a permission with a
service business rule for the UNIT_DELIVER event and with a filter criteria for ABC import containers.
A hold or permission by itself does not work unless it is associated with a service business rule.
For more information, see Holds/Permissions view (on page 488) and Service Business Rules view (on page 502).
2.3.2.3 Payment Holds
Some sites require that certain charges be either pre-paid or guaranteed before a unit can be delivered. These may be
charges for explicit events, such as an inspection or a vessel discharge, or these could be for a time-based service,
such as storage or reefer power.
A payment hold is a hold that may be applied automatically to a unit when an event is performed for the unit. When a
payment is received or guaranteed for the service provided the hold is released and the unit may be delivered.
To define a hold as a payment hold, select the Billing Hold Required check box in the Hold/Permission Type
form (on page 489).
Time-based services do not require payment holds as the release of a unit owing storage or power charges is
managed through either paid through date or guaranteed through date. Payment holds are required only for explicit
events.
For explicit events in N4, you can:
• Configure payment holds to be automatically created when a specific service is performed.
• Release payment holds when payments or guarantees have been recorded for the service.
• Re-apply payment holds when guaranteed expire or are voided by a user.
The payment holds can only be defined for chargeable unit events (on page 546); you cannot define
payment holds for chargeable marine events (on page 563), such as vessel berthing or pilotage.
To use payment holds:
1. Define a payment hold (on page 492).
2. Record the service event (on page 493) associated with the payment hold.
3. Extract the service event (on page 494) so that it is displayed in the Chargeable Unit Events view.
4. Update the payment hold (on page 494).
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
491
Part 2: Services Management
Hold Management
Holds/Permissions view
Define a payment hold
For chargeable unit events (on page 546) in N4, you can use payment holds to prevent a unit from being processed
(such as from being delivered out the gate or loaded on a vessel) if there are unpaid charges associated with the unit.
Once the guarantee party pays or guarantees the charges, you can release the payment hold and allow the unit to be
delivered.
The first step is to define the service event, the payment hold, the associated service business rule, and the auto
update rule.
To define a payment hold:
1. If it does not already exist, use the Event Type form (on page 461) to add the event type that should trigger the
payment hold.
Ensure that the event type Applies To units and is Billable.
For example, add an event type, PAY EVENT where the event applies to units and is billable, as shown in the
graphic below:
2. Use the Hold/Permission Type form (on page 489) to define the payment hold.
Ensure that the Billing Hold Required check box is selected, as shown is the graphic below:
3. Next, use the Service Business Rule form (on page 503) to add a service business that associates the hold
created in step 2 with the event that you want to prevent using the payment hold.
For example, if you want to prevent the unit from being delivered if the PAY HOLD (defined in step 2) is active,
define the service business rule as shown in the graphic below:
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
492
Part 2: Services Management
Hold Management
Holds/Permissions view
4. Now, use the Auto Update Rule form (on page 507) to define an auto update rule for the event type, defined in step
1, that automatically applies the hold, defined in step 2, to the target entity.
Use the Auto Update Rule form Holds/Permissions tab Auto Update Hold/Perm form (on page 509) to
associate the hold with the auto update rule, as shown below:
This ensures that whenever the PAY EVENT is recorded for a unit, N4 automatically applies the PAY HOLD to the
unit.
The service business rule, defined in step 3, ensures that the unit cannot be delivered unless the PAY HOLD is
released.
Next Step: Record the service event (on page 493)
Record the service event
After you define a payment hold and the associated service business rule and auto update rule, the second step is to
record the service event for a unit.
Use the Units view Actions Transactions Record Service Event Record Service Event form to record the
event type associated with the payment hold. Ensure that the event is displayed in the Unit Inspector History,
Events tab.
For example, in this scenario, use the Record Service Event form to record the PAY EVENT and ensure that the PAY
EVENT is displayed in the History, Events tab in the Unit Inspector for the unit.
Use the Unit Inspector
Holds/Perms tab to ensure that the payment hold is applied to the selected unit.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
493
Part 2: Services Management
Hold Management
Holds/Permissions view
For example, in this scenario, the PAY HOLD must be displayed as an Active hold for the unit for which you recorded
the PAY EVENT.
Next Step: Extract the service event (on page 494)
Extract the service event
After you record the service event for a unit, the third step is to extract the service event for the unit. You can do this
manually or run the Launch Event Billing Extract background job (on page 929) to extract the chargeable events for
a unit.
To manually extract the service event:
1. Use the Units view Actions Transactions
the unit to which you applied the payment hold.
Extract Events option to extract the chargeable unit events for
2. In the Chargeable Unit Events view (on page 546), ensure that the unit event is extracted and note the Gkey for
the event.
If not displayed already, select the 7 - Other
Gkey column to display the Gkey for an event.
For example, in this scenario, the Gkey of the extract event (PAY EVENT) is 118319775.
Next Step: Update a payment hold (on page 494)
Update a payment hold
After you define a payment hold and record the appropriate service event for a unit, N4 updates the status of the
payment hold, when the:
• Charges owed are paid (on page 494)
• Charges owed are guaranteed (on page 495)
• Guarantee for the charges owed expires or is voided (on page 494)
Update a payment hold when a guarantee expires or is voided
When the guarantee for the charges owed for the service event, which triggered the payment hold, expires or is voided,
N4 re-applies the payment hold to the unit.
To void the guarantee for the charges owed for service event that triggered a payment hold:
1. From the Unit Inspector
void.
Guarantees tab (on page 585), note the Guarantee ID of the guarantee you want to
2. Use the argoservice Tester view (on page 1095) to void the guarantee for the service event.
3. From the Unit Inspector
ACTIVE.
Holds/Perms tab, verify that the payment hold is re-applied and has the Status set as
Update a payment hold when charges are paid
Once a payment hold is defined and the associated service event is recorded for a unit, N4 updates the payment hold
when the charges owed for the service event are paid by the responsible party.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
494
Part 2: Services Management
Hold Management
Holds/Permissions view
To pay the charges owed for service event that triggered a payment hold:
1. In N4 Billing, define the tariff rate for the service event.
For more information on defining tariff rates, see the N4 Billing online documentation.
2. In N4, use the Units view
unit charges.
Actions
Transactions
Query Unit Charges
Query Charges form to query the
3. In the View Charges form, click Pay Invoice.
4. Use the Pay Unit Charges form to pay the charges owed for the container.
5. In N4 Billing,
a. Verify that the invoice is generated and finalized.
b. Verify that a payment record is created and recorded against the invoice.
6. In N4,
a. Verify that the status of the extracted service event in the Chargeable Unit Events view (on page 546) is
updated as INVOICED.
b. From the Unit Inspector
Holds/Perms tab, verify that the payment hold is released.
Update a payment hold when charges are guaranteed
N4 also releases a payment hold if the charges owed for the service event, which triggered the payment hold, are
guaranteed by the responsible party.
To guarantee the charges owed for service event that triggered a payment hold:
1. From the Chargeable Unit Events view (on page 546), note the Gkey of the extracted service event.
If not displayed already, select the 7 - Other
Gkey column to display the Gkey for an event.
2. Use the argoservice Tester view (on page 1095) to record a guarantee for the service event.
3. From the Unit Inspector
service event.
Guarantees tab (on page 585), verify that the guarantee is recorded for the correct
You can do this by matching the Extract GKey in the Guarantees tab with the GKey in the Chargeable Unit
Events view.
4. From the Unit Inspector
Holds/Perms tab, verify that the payment hold is released.
Release a payment hold manually
N4 provides the release-container-hold web service to enable third-party applications to send a request to
manually release a payment hold. You can use the argoservice Tester view (on page 1095) to test the releasecontainer-hold web service.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
495
Part 2: Services Management
Hold Management
Holds/Permissions view
To release a payment hold:
1. In the Administration Debug
container-hold web service:
argoservice Tester view, perform the following steps to test the release-
a. In the left panel, click the plus sign next to Request.
b. Click the plus sign next to EVENT.
c. Select release-container-hold.
d. In the right panel, replace the required values.
The following code segment represents the release-container-hold web service modified according to the
above scenario:
<event>
<release-hold>
<release-type>PAYMENT</release-type>
<extract-gkey>118319775</extract-gkey>
<entity-type>INV</entity-type>
<event-type>PAY EVENT</event-type>
<user>user</user>
<reference-number>123</reference-number>
<invoice-draft-nbr>12345</invoice-draft-nbr>
<notes>This is a payment hold release.</notes>
</release-hold>
</event>
The modified values are displayed in bold:
- The extract-gkey is the Gkey noted from the Chargeable Unit Events view (on page 546).
- The event-type is the event type defined for the payment hold. For more information, see Defining a
payment hold (on page 492).
- The user represents the user authorized to run the web service.
e. From the top panel, click Send Generic Request.
f. If the Status is successful, double-click Results and view the response for the release-container-hold web
service.
The following code segment represents the response for the above scenario:
<argo:event-response xmlns:argo="http://www.navis.com/argo">
<argo:hold-released>
<argo:flag-type-id>PAY HOLD</argo:flag-type-id>
<argo:flag-reference-number />
<argo:entity-id>LOPU3987645</argo:entity-id>
</argo:hold-released>
</argo:event-response>
2. Use the Unit Inspector
Holds/Perms tab to ensure that the payment hold is released for the selected unit.
For example, in the above scenario, the PAY HOLD must be displayed as a RELEASED hold for the unit for which
you recorded the PAY EVENT.
2.3.2.4 Update Hold/Permission form
You can access the Update Hold/Permission form from the Actions menu in most views in the Operations menu and in their
corresponding inspectors.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
496
Part 2: Services Management
Hold Management
Holds/Permissions view
The Update Hold/Permission form enables you to add/release holds, or grant/cancel permissions for the selected
entities.
Prerequisites
• In this form, you can select a hold/permission in step 2 only if it exists at the current scope level and has a service
business rule (on page 502) defined. For more information, see Holds/Permissions view (on page 488).
To update a Hold/Permission:
1. From the Action drop-down list, select one of the following options:
▪ Add Hold: Add a hold for the selected entity/entities.
▪ Release Hold: Release an ACTIVE hold for the entity/entities.
▪ Grant Permission: Grant a REQUIRED permission for the entity/entities.
▪ Cancel Permission: Cancel a GRANTED permission for the entity/entities.
2. From the Hold/Permission drop-down list, select the hold that you want to add/release or the permission that you
want to grant/cancel.
The values listed depend on the selected entity and the option selected in step 1.
The Description and Target Entity Type fields are view-only and display information about the selected hold/
permission.
3. From the Relation to Referenced Guardian drop-down list, select the guardian entity type for the selected hold/
permission.
This list is only enabled for guarded holds/permissions. For more information, see Rule types (on page 504).
For a list of target entities and the related guardian entity types, see Target and guardian entity types.
4. From the Referenced Guardian Entity drop-down list, select the specific guardian entity for the hold/permission.
The values in the drop-down list depend on the option selected in step 4.
This list is only enabled for guarded holds/permissions. For more information, see Rule types (on page 504).
5. The Has Unique Reference Id and Reference Id Required check boxes are read-only and display the options set
at the time the hold/permission was defined. For more information, see Hold/Permission Type form (on page 489).
6. If the Reference Id Required check box is selected, you must enter a reference ID in the Reference ID field, and if
the Has Unique Reference Id check box is selected, the reference ID entered in the Reference ID field must be
unique for the entity and hold/permission combination.
To change the reference ID for an existing hold/permission, you must release/cancel the hold/permission and
read the hold/permission with the new reference ID.
7. Optionally, in the Note field, enter a note for any special considerations for the hold/permission.
8. Click OK.
When updating a hold/permission:
• If you select multiple entities in a list view and a validation prevents you from applying the hold/permission to one or
more selected entities, N4 still applies the hold/permission to the other selected entities.
• If the selected hold/permission already exists as an ACTIVE hold or a REQUIRED permission for a selected entity,
N4 does not apply the same hold/permission twice.
• If a hold/permission that requires a unique reference ID already exists as an ACTIVE hold or a REQUIRED
permission for a selected entity, N4 does not apply the same hold/permission twice if the reference ID that you
specify is the same as the reference ID that already exists.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
497
Part 2: Services Management
Hold Management
Holds/Permissions view
2.3.2.5 Add filter criteria to holds
You can add filter criteria to holds using the Update Hold/Permission form (on page 496).
To add filter criteria to a hold:
1. Create a new hold in the Update Hold/Permission form (on page 496).
2. Create a new service business rule using your hold permission (Configuration Services
Rules Service Business Rules view Service Business Rules form (on page 503)).
Service Business
Typically, to allow containers with holds to go out the gate, you prevent the events UNIT_OUT_GATE or
UNIT_DELIVER. To allow container with holds to gate in, prevent the events UNIT_RECEIVE or UNIT_GATE_IN.
See also IN/OUT events (on page 467) in the N4 online help.
3. Make sure that this hold:
▪ Is associated with your unit.
▪ Is available on the Holds/Perms tab in the Unit Inspector.
4. Make sure that the business tasks at the gate are set to check for holds.
If you try to gate out or gate in the container at this point (depending on what you are trying to achieve), you should
get an error because of the hold.
5. In the Edit Service Business Rule form, in the Filter Criteria area, set up your filer.
For example, to add filter criteria to a hold to check if there is a specific dray status, select the following:
▪ From the Category list: Dray Status
▪ From the filter operator list: is not (!=)
If you set this up to say is instead of is not, the hold only stops containers that have the dray status and normal
containers that should be stopped are let out/in.
▪ From the attribute list: The specific dray status that you want to use
At this point, if you gate out or gate in your unit (depending on your goal), it should still get stopped because it has
no dray status.
6. Add a dray status to the unit.
Now, when you gate the unit in/out, it should pass the gate without errors.
Notes
• If you use a permission instead of a hold, it disappears from the Unit Inspector when then dray status (or other
criteria) is set. The hold does not disappear; it remains visible, but it does not stop the container at the gate.
• You should test the filter with and without the dray status on the units to be sure you are getting the desired
behavior.
• If you set additional criteria on the hold (because dray status can be used for other things), make sure that the hold
is getting ignored for the correct reason. The categories Inbond Status and Exam Status are often also added to
the filter criteria, so they can have a second check because they can be populated by posting the EDI Release that
tells them to take the container to an offsite exam.
2.3.2.6 Create covert holds
A covert hold is a hold that is hidden throughout the application unless you have the designated privileges to view,
create, apply, and release the hold. This hold/permission prevents actions in the same manner as any other hold,
however the hold is not observed until the restricted action is attempted.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
498
Part 2: Services Management
Hold Management
Holds/Permissions view
For example, if a unit has a covert hold that prevents delivery, the hold won't be apparent until the trucker tries to take
the unit out of the gate. At that time, the gate clerk will receive an error that there's a covert hold, but won't have any
details about the hold unless the clerk has been assigned the Covert Hold privilege.
Prerequisites
• Add the following privilege ID: VIEW_COVERT_HOLD_PERMISSIONS/Name: Covert Holds/Permission - View All
• Once set up, you will need to exclude covert holds from reports and suppress covert holds at the ingate.
Notes
• Covert holds are only intended for Full containers. Therefore, if you use them with entities that deal specifically with
Empty containers, such as EDOs, they do not have any impact and N4 does not prevent the action associated with
the covert hold.
• Information about covert holds is not passed to XPS or ECN4, and therefore these applications will handle the unit
as though there was no hold.
• For terminals using Covert Holds, it's recommended that you have a well-planned process for how to handle Covert
Hold trouble-tickets.
• If your terminal uses Groovy, by default, the Groovy code will not restrict Covert Hold information from being used. It
is the terminal's responsibility to make sure any necessary fixes to the Groovy are made to ensure covert hold
information is not displayed on account of the Groovy.
Exclude covert holds from reports
Before you start using covert holds, you will need to do the following to prevent covert information from appearing in
reports:
1. Select Operations Reports Report Designs.
2. Sort the Report Design list by Entity.
3. For all reports with the UnitFlag entity, you will need to add the following Filter Criteria: Covert Hold = FALSE.
Otherwise covert holds will appear in those reports.
Suppress covert holds at the ingate
By default, the gate evaluates covert holds at both the ingate and outgate. This is due to the parameter
IncludeCovertHold that is included in the gate business task RejectUnitServiceRules. By default this parameter is set to
True. However, you will want to set this to FALSE for the ingate. So for each Tran Type under Gate Stage Ingate, for
the business task RejectUnitServicesRules you'll need to set parameter includeCovertHold = FALSE.
Create a covert hold
1. Select Configuration Services Holds/Permissions Holds/Permissions view Hold/Permission Type form.
2. Click
to open the Hold/Permission Type box.
3. Enter details for the hold as described in the Hold/Permission Type form (on page 489), then click the Is a Covert
Hold/Permission check box. Note, this box will only appear if you have the
VIEW_COVERT_HOLD_PERMISSIONS privilege.
We recommend that you give the hold a name that will give the gate clerk direction in the absence of having any
ability to view the hold. For example, you could name it See_Customs_TroubleDesk_ (keyXXXX) or something that
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
499
Part 2: Services Management
Hold Management
Holds/Permissions view
would indicate exactly what the clerk should do when the hold is triggered. You may not want to include the name
COVERT in the name since that would alert others that it is a covert hold.
View covert holds
A user who has the VIEW_COVERT_HOLD_PERMISSIONS privilege can see covert hold information in the following
views:
• Holds/Permissions table of Unit Inspector
• Service Business Rules List View
• N4 Mobile Yard Inventory View
• N4 Reports
• SNX Export of Unit
If the user has the VIEW_COVERT_HOLD_PERMISSIONS privilege AND the Hold Type Add../Hold Type Remove..
privileges for a particular covert hold, the user will also see the covert hold in the LOV for:
• Add Auto Update Hold/Permission
• Edit Auto Update Hold/Permission
• Unit Action Update Hold/Permission
• Unit Inspector + add on Hold/Permission Panel
The ADMIN user will always be able to see covert holds. If the terminal doesn't want general IT people to see this hold
they will need to create a separate administrator role and remove the privilege to see this.
When a new covert hold is created, the following Hold/Permission Type Add/Remove privileges will be created
dynamically as they are for other holds:
• Hold Type Add..
• Hold Type Remove..
These privileges will control seeing the Covert hold in the LOV of:
• Add Auto Update Hold/Permission
• Edit Auto Update Hold/Permission
• Unit Action Update Hold/Permission
• Unit Inspector + add on Hold/Permission Panel
However, a user cannot view or remove a covert hold without the VIEW_COVERT_HOLD_PERMISSIONS privilege.
Where covert holds are hidden from view
Covert Hold/Permissions are never visible in the following applications/views, regardless as to whether the
VIEW_COVERT_HOLD_PERMISSIONS is applied to the user:
• XPS and ECN4
• Universal Query API
• EDI
• List Views
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
500
Part 2: Services Management
Hold Management
Hold/Release Inbound Unit form
In addition, Covert Hold/Permissions will never be seen in the following Unit List View Rules Fields:
• Impediments Road
• Impediments Vessel
• Impediments Rail
• SLOW Delivery Impediments
• SLOW Load Impediments
• SLOW Rail Impediments
• STOP Road
• STOP Rail
• STOP Vsl
• Unit Granted Hold/Permission
• Unit Hold/Permission
• Unit Hold/Permission Groups
• Unit Impediments
• Unit Impediment Groups
Use HPU service to apply/release covert holds
If a user has the VIEW_COVERT_HOLD_PERMISSIONS privilege, it's possible to apply/release covert holds/
permissions using the HPU webservice.
2.3.2.7 Mark a container with stop signs for manual fetch
You can mark a WI that has a container with a stop sign for manual fetch when the XPS plan override settings
OVRSTP (on page 511) and OVRVST (on page 511) are enabled by setting XPS setting MANMRF (on page 510) to
“Y.”
2.3.3 Hold/Release Inbound Unit form
Operations
Vessel
Hold/Release Inbound Unit
Hold/Release Inbound Unit form
Prerequisites
• To access this view, you need to assign the Vessel - Hold/Release I/B Unit privilege to your user role.
The Hold/Release Inbound Unit form enables you to add a hold or add/grant a permission for a unit on an inbound
vessel. Use this form to hold or release a specific unit on an inbound vessel.
To hold or release a unit on an inbound vessel:
1. From the Visit Reference lookup field, select the vessel visit ID.
2. In the Unit Nbr text field, enter the unit number.
3. From the Hold/Permission drop-down list, select the hold/permission you want to add or the permission you want
to grant for the unit.
If you select a permission that already exists for the selected unit, the permission is granted.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
501
Part 2: Services Management
Hold Management
Service Business Rules view
4. Specify any optional information, such as a reference ID or short note associated with the hold/permission.
5. Click Save.
2.3.4 Service Business Rules view
Configuration
Services
Service Business Rules
Service Business Rules view
The Service Business Rules view displays the service business rules that exist at the current scope level. Use a
service business rule to associate a hold/permission with an event type and define a condition that prevents the event
from occurring. You can define a service business rule for user-defined service event types and built-in event types.
For more information on event types, see Event Types view (on page 460).
In addition, you can define filter criteria (on page ) to determine the entities for which the service business rule
applies. This is especially important for a permission, since N4 automatically applies the permission to the entities that
satisfy the defined filter criteria in the service business rule.
You can also use a service business rule to prevent an event type from occurring until you record a prerequisite service
event for the target entity. For more information, see Rules types (on page 504).
For an existing Simple Hold or Simple Permission service business rule, you can configure an auto update
rule to automatically add/release a hold or grant/cancel a permission when an event occurs. For more
information, see Auto Update Rule form (on page 507).
You can add service business rules, and edit or delete existing service business rules from this view.
In addition, you can use the Actions menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted service business rules.
• Purge (on page 208), Purge (on page 1215): Purge service business rules.
• Export SNX File (on page 1109): Export the selected service business rules as an XML file using the snx.xsd
format.
• Copy Reference Set (on page 1191): Copy service business rules from another entity set.
Service Business Rules Columns
Short Label
Long Label
In Filter?
Sorting?
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Guardian
Guardian
X
X
Hold/Permission
Hold/Permission
X
X
LifeCycleState
Life Cycle State
X
X
Prerequisite
Prerequisite
X
X
Rule
Rule Name
X
X
Rule Type
Rule Type
X
X
Service Evnt
Target Service Event Type
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
502
Part 2: Services Management
Hold Management
Service Business Rules view
Short Label
Long Label
Service Evnt Applies To
In Filter?
Target Service Event Type Applies To
X
Sorting?
X
2.3.4.1 Service Business Rule form
Configuration
Services
Service Business Rules
Service Business Rules view
Service Business Rule form
The Service Business Rule form enables you to add and edit service business rules. Use a service business rule and
a hold/permission to set up a condition that prevents an event from occurring for the target entity type. A service
business rule determines the conditions under which an event type can occur for a target entity type.
An event can only occur if one of the following applies:
• The associated hold is not present or is released.
• The associated permission is granted.
• The prerequisite event is already recorded for the target entity.
Adding more than 250 service business rules can impact performance.
To add or edit a service business rule:
1. In the Rule Name field, enter a name that uniquely identifies the service business rule.
2. From the Target Service Event Type drop-down list, select the target event type.
The drop-down list displays the event types defined at the current scope level. For more information on adding event
types, see Event Type form (on page 461).
3. From the Rule Type drop-down list, select the rule type (on page 504) that determines how a hold/permission needs
to be applied to the target entity.
4. If the selected rule type applies to a guardian or is in relation to a guardian, the Guardian drop-down list is enabled.
From the Guardian drop-down list, select the guardian type for the service business rule.
The available guardian types depend on the target entity type of the event type selected in step 2. For a list of target
entities and the related guardian entity types, see Target and guardian entity types.
If the target entity is the equipment that makes up a unit, select Unit Equipments.
5. From the Hold/Permission drop-down list, select the hold/permission that controls the effect of the service business
rule.
The values listed in the Hold/Permission drop-down list depend on the Rule Type selected in step 3, and the
holds/permissions defined at the current scope level. For more information on adding a holds/permissions, see
Hold/Permission Type form (on page 489).
6. If you selected the Prerequisite rule type in step 3, the Prerequisite drop-down list is enabled. From the
Prerequisite drop-down list, select the event that must occur or be recorded for the target entity before the event
type selected in step 2 can occur or be recorded.
In the Unit Inspector, a unit with a Prerequisite rule type applied has the Holds/Permission status of PREREQUISITE.
7. In the Filter Criteria area, define a filter criteria that determines the entities for which N4 enforces the service
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
503
Part 2: Services Management
Hold Management
Service Business Rules view
business rule. If no filter criteria exists, the service business rule affects all entities or guarded entities, if the rule
type applies to a guardian.
The filter attributes available in the Filter Criteria area depend on the target entity type such as unit, booking, or
vessel visit for the event type. For more information on adding filter criteria, see Creating a filter (on page ).
8. Click Save.
Adding more than 250 service business rules can impact performance.
When you add a new service business rule or edit an existing service business rule for a permission, N4 runs a
background job to apply these updates to the target entities that satisfy the filter criteria defined in step 7. These
updates are saved in the database and display in the impediments fields in the Units view when you open or refresh
the list view.
You can specify the frequency and batch size for the background job that applies the service business rule updates to
the target entities. The refresh-units job depends on these configuration settings: INVREFRESH001 (RFRSH_FREQ),
INVREFRESH002 (RFRSH_BATCH), INVREFRESH003 (RFRSH_STALE), INVREFRESH004
(RFRSH_UNIT_NUMBER), and INVREFRESH005 (RFRSH_THREAD_NUMBER).
When processing an event, N4 always checks for a service business rule for a permission. If a service business
rules exists, even if it has not been applied, N4 enforces it for the target entities satisfied by the filter criteria.
For more information on editing the configuration settings in N4, see Settings view (on page 1042).
Rule types
You use a service business rule to define the conditions that prevent N4 from recording an event for the target entity
type. A rule type determines whether a hold, a permission, or a prerequisite event type controls the effect of the service
business rule. For more information on holds/permission types, see Holds/Permissions view (on page 488).
The various rule types available in the Rule Type drop-down (on page 503) list are:
• Simple Hold (Service Event is prevented by Hold)
Use this rule type to prevent the selected event type from occurring for a target entity until you release the active
hold on the target entity.
For example, you can use this rule type to define a service business rule for an off-hire hold that prevents the
delivery of an empty unit through the gate.
You must manually apply a hold to a target entity. The target entity you specify for the event type must be the
same as the target entity you specified for the selected hold.
• Simple Permission (Service Event requires Permission)
Use this rule type to prevent the selected event type from occurring for the target entity until you grant the selected
required permission to the target entity.
For example, you can use this rule type to define a service business rule for a customs export permission that is
required for all units that are to be loaded on a vessel leaving the country.
N4 automatically applies the selected permission to the entities that satisfy the defined filter criteria.
• Hold on Guardian (Service Event is prevented by Hold on Guardian)
Use this rule type to prevent the selected event type from occurring for a target entity until you release the active
hold on the guardian entity.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
504
Part 2: Services Management
Hold Management
Auto Update Rules view
For example, you can use this rule type to define a hold on a booking that prevents the units associated with the
booking from being loaded on a vessel. The hold is on the guardian (booking) rather than the target entity (unit).
Or you can use this rule type to define a no empty return hold on a container to prevent a full container from
returning to a facility as an empty container. The hold is on the guardian (equipment) rather than the target entity
(unit).
You must manually apply a hold to a guardian entity. The hold on the guardian applies to all of the associated
entities until the hold is released.
• Permission on Guardian (Service Event requires Permission on Guardian)
Use this rule type to prevent the selected event type from occurring for a target entity until the selected permission is
granted to the guardian entity such as a booking, vessel visit, or bill of lading.
For example, you can use this rule type to define a bill of lading release that is required before you can deliver any
of the units associated with a specific bill of lading via the gate. The bill of lading is the guardian entity that guards
the associated units.
N4 automatically applies the selected permission to the guardian entities that satisfy the defined filter criteria.
The permission on the guardian applies to all of the associated entities until the permission is granted.
You can release/grant a Hold/Permission on Guardian for the guardian or for a specific target entity. For example,
if you release the quarantine hold on a vessel at the guardian level, N4 releases the hold for all the guarded units. If
you release the quarantine hold for a specific unit, you can only discharge the selected unit and N4 still prevents you
from discharging the other units with the active hold on the guardian.
• Hold on Guarded (Service Event is prevented by Hold with respect to Guardian)
Use this rule type to prevent the selected event type from occurring for a target entity until you release the active
hold on the target entity with respect to a specific guardian entity.
For example, you can use this rule type to define a customs hold that prevents you from loading a unit on a specific
vessel visit, such as VSL001. However, the service business rule does not prevent you from loading the unit on any
other vessel visit, such as VSL002.
• Permission on Guarded (Service Event requires Permission with respect to Guardian)
Use this rule type prevent the selected event type from occurring for a target entity until you grant the permission to
the target entity with respect to a specific guardian such as a booking, vessel visit, or bill of lading.
For example, you can use this rule type to define a customs export permission that is required for a specific vessel
before you can load the unit on that vessel.
• Prerequisite Service Event (Service Event requires other Service Event)
Use this rule type to prevent the selected event type from occurring for a target entity until you record the selected
prerequisite event for the target entity type.
For example, you can use this rule type to define the WASH event as a prerequisite event for all empty reefer units
before they can leave the terminal through the gate.
2.3.5 Auto Update Rules view
Configuration
Services
Auto Update Rules
Auto Update Rules view
The Auto Update Rules view displays the auto update rules that exist at the current scope level. An auto update rule
enables you to update selected fields, add/release a hold, and grant/cancel a permission for an entity when the event
associated with the auto update rule occurs.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
505
Part 2: Services Management
Hold Management
Auto Update Rules view
The auto update rule is especially useful for built-in event types for which you cannot edit the 'Is Updated' effect. For
more information on adding effects for an event type, see Effect form (on page 463).
By default the auto update rule applies to all entities that are of the target entity type for the event type selected. For
example, if you select the UNIT_DISCH event, the target entities are all units that are discharged. You can add filter
criteria in the auto update rule to define a subset of the target entities for the target entity type, such as only units with a
category of import.
For more information, see Auto Update Rule form (on page 507).
You can add auto update rules, and edit or delete existing auto update rules from this view.
In addition, you can use the Actions menu to:
• Recover Obsolete (on page 208), Recover Obsolete (on page 1177): Recover deleted auto update rules.
• Purge (on page 208), Purge (on page 1215): Purge auto update rules.
• Copy Reference Set (on page 1191): Copy auto update rules from another entity set.
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).
N4allows you to delete a BL even if it is assigned to a unit/cargo lot provided the unit’s transit state is either
Advised, Inbound, or Retired. However, N4 does not allow you to delete a BL if some or all of the related
cargo/units/containers have one of the following transit states EC/IN, EC/OUT, Yard, or Loaded. Instead, N4
displays an error message, Cannot delete bill of lading {0}, as it is associated with Units
Auto Update Rules Columns
Short Label
Long Label
In Filter?
Sorting?
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
Event Type
Event Type
X
X
Event Type Applies To
Event Type Applies To
X
X
LifeCycleState
Life Cycle State
X
X
Name
Name
X
X
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
506
Part 2: Services Management
Hold Management
Auto Update Rules view
2.3.5.1 Auto Update Rule form
Configuration
Services
Auto Update Rules
Auto Update Rules view
Auto Update Rule form
The Auto Update Rule form enables you to add and edit an auto update rule. Use an auto update rule to automatically
update selected fields, add/release a hold, and grant/cancel a permission for an entity when an event (on page 460)
occurs. Auto update rules are generally used in combination with a filter that defines a subset of the target entities
affected by the rule.
For example, you can:
• Update the equipment grade to an out of service grade for units with severe damage when damage is recorded.
• Update the group code to RAIL for import containers for a specific line operator with a defined set of destinations
that are always served by rail, when the container is discharged from a vessel.
By using an auto update rule to update the group code to RAIL, you can easily list the import containers that must
depart by rail for the specific line operator.
• Release an inspection hold that was applied by an EDI message on a container when an inspection service event is
performed and recorded for the container.
• Add a hold to all empty containers when they are deramped from rail to verify that they are really empty.
• Grant a customs permission and update the group code when a customs inspection service event is performed and
recorded for a unit.
In addition, instead of using a permission you can use an auto update rule to add a hold to a large set of target entities.
For example, if you need to prevent all full export containers from being loaded to a vessel until customs approves, you
can use:
• A permission that N4 automatically applies to all full export units per a service business rule, or
• An auto update rule that automatically adds a hold to all full export units when a UNIT_RECEIVE or UNIT_DERAMP
event occurs.
If you use an auto update rule to add/release or grant/cancel a hold/permission, we recommend that you define filter
criteria on the Filter tab to determine the subset of target entities for which the auto update rule is enforced. If no filter
criteria are defined, the auto update rule affects all entities and therefore N4 will automatically add/release or grant/
cancel a hold/permission on all entities that incur the associated event type.
To add or edit an auto update rule:
1. In the Name field, enter a name that uniquely identifies the auto update rule.
2. From the Event Type drop-down list, select the event type that triggers the auto update rule.
3. Optionally, on the Filter tab, define filter criteria to determine the target entities for which the auto update rule is
enforced. If no filter criteria are defined, the auto update rule affects all entities that are of the target entity type for
the event type selected in step 2.
The filter attributes available in the Filter Criteria area depend on the target entity type such as unit, booking, or
vessel visit for the event type. For more information on adding filter criteria, see Creating a filter (on page ).
4. Click Save.
You must save the auto update rule before you can add fields to be updated for the target entities or holds/permissions
to be added/released or granted/canceled when the selected event type occurs.
After adding an auto update rule:
• Use the Update Fields tab (on page 508) to add, edit, or delete fields.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
507
Part 2: Services Management
Hold Management
Auto Update Rules view
• Use the Holds/Permissions tab (on page 508) to add, edit, or delete holds/permissions.
Update Fields tab
Configuration
Services
Auto Update Rules
Auto Update Rules view
Auto Update Rule form
Update Fields tab
The Update Fields tab displays the fields that are automatically updated for the target entity when the event type
associated with the selected auto update rule occurs or is recorded. For example, you can add the group field to
update the group code when an import container is discharged from a vessel.
You can add, edit, and delete auto update fields on this tab.
To add a field:
• Click
occurs.
to add the fields that you want to update for the defined target entities when the selected event type
When you click the add button the Auto Update Field form (on page 508) displays.
To edit or delete a field:
• Select an existing field and,
▪ Click
to edit the selected field.
The Auto Update Field form (on page 508) displays.
▪ Click
to delete the selected field.
Auto Update Field form
Configuration
Field form
Services
Auto Update Rules
Auto Update Rules view
Auto Update Rule form
Update Fields tab
Auto Update
The Auto Update Field form enables you to add and edit an auto update field and the value that the field must have
after the event type occurs and is recorded for a target entity.
To add or edit an auto update field:
1. From the Field drop-down list, select the field to be updated for the selected target entity type.
The list of fields displayed depends on the target entity type for the selected event type.
2. In the Field Updates area, N4 displays the name of the field selected in step 1. Use this field to specify the value
that the field must have after the event type occurs.
3. Click Save.
You can add multiple fields to be updated for the target entity when the selected event type occurs.
Holds/Permissions tab
Configuration
Services
Auto Update Rules
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Auto Update Rules view
Auto Update Rule form
Holds/Permissions tab
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
508
Part 2: Services Management
Hold Management
Auto Update Rules view
The Holds/Permissions tab displays the holds/permissions that are automatically added/released or granted/canceled
for the target entity when the event type associated with the selected auto update rule occurs or is recorded.
If you are using an auto update rule to add a hold to a large set of target entities instead using a permission, you must
be sure that:
• The event type will occur for all of the target entities that satisfy the filter criteria defined for the selected auto update
rule.
• The hold should still be active even if a filter attribute changes.
For example, if the selected auto update rule only adds a hold to units with a freight kind of FCL and a unit's freight
kind changes from FCL to Empty, any existing added holds will remain active. But if you use a permission that
applies only to units with a freight kind of FCL, the permission will no longer apply when the freight kind changes to
Empty.
You can add, edit, or delete holds/permissions on this tab.
You can only add holds/permissions that are associated with a Simple Hold or Simple Permission service
business rule.
To add a hold/permission:
• Click
to add the holds/permissions that you want added/released or granted/canceled for the defined target
entities when the selected event type occurs.
When you click the add button the Auto Update Hold/Perm form (on page 509) displays.
To edit or delete a hold/permission:
• Select an existing hold/permission and,
▪ Click
to edit the selected hold/permission.
The Auto Update Hold/Perm form (on page 509) displays.
▪ Click
to delete the selected hold/permission.
N4 ignores specific add/release hold or grant/cancel permission privileges when applying a hold/permission
as a result of an auto update rule. Therefore, even if the user does not have specific permissions to manually
add/release holds or grant/cancel permissions, they can still record the event type associated with the auto
update rule and N4 will apply the appropriate hold/permission, automatically.
Auto Update Hold/Perm form
Configuration Services
Update Hold/Perm form
Auto Update Rules
Auto Update Rules view
Auto Update Rule form
Holds/Permissions tab
Auto
The Auto Update Hold/Perm form enables you to add or edit a hold/permission for the selected auto update rule.
You cannot add a hold/permission if the selected auto update rule is for the UNIT_CREATE event. When this event
occurs, the data describing the container is not complete and N4 cannot process any filters defined.
To add or edit a hold/permission:
1. From the Hold/Permission drop-down list, select the hold/permission to be automatically added/released or
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
509
Part 2: Services Management
Hold Management
Hold Settings in XPS
granted/cancelled for the target entity when the event type associated with the auto update rule occurs or is
recorded.
The drop-down list displays all the holds/permissions applicable for the selected entity.
We recommend that you do not select a hold/permission with the Unique by Reference ID check box
selected, since multiple holds/permissions may exist for a target entity and the user recording a service event
cannot specify a unique reference ID to let N4 know which hold/permission to automatically update.
2. Optionally, deselect the Release check box to add the hold or cancel the permission selected in step 1.
By default the Release check box is selected to release the hold or grant the permission selected in step 1.
3. Optionally, in the Notes field enter any notes for the auto update flag.
4. Click Save.
You can add multiple holds/permissions to be add/released or granted/cancelled for the target entity when event type
associated with the selected auto update rule occurs or is recorded.
2.3.6 Hold Settings in XPS
2.3.6.1 OVRCMP
Type: Setting
Description: Determines whether the user is allowed to complete the planned move of a container whose stop signs
are overridden by enabling the planning override settings OVRSTP (on page 511) and OVRVST (on page 511). If
OVRCMP is set to either ALLOW or DENY, XPS disables the Complete move radio buttons in the Reset Move dialog
(Maintain Queues Actions Reset Container) for containers with vessel and rail holds. However, you can still
complete the move directly using CTRL+E. To change this setting, see Change XPS settings with the SPARCS
settings.txt file in the Navis N4: Setup, Maintenance, and System Diagnostics Guide.
Default: ALLOW
Values:
• ALLOW: Allows you to complete the planned move of a containers whose stop signs are overridden by enabling the
settings OVRSTP and OVRVST without any further validations.
• DENY: Does not allow you to complete the planned move of the container even if its stop signs are overridden by
the settings OVRSTP and OVRVST.
Module: EC
2.3.6.2 MANMRF
Type: Setting
Description: When the plan override settings OVRSTP (on page 511) and OVRVST (on page 511) are enabled,
determines whether a work instruction (WI) having a container with stop signs can be marked for manual fetch.
When this setting is set to “N” and settings OVRSTP and OVRVST are set to “Y,” XPS does not allow said WI to be
marked for manual fetch. Instead, XPS displays the error message “Cannot mark for Fetch, Container: XXXX as not
released for loading.”
To change this setting, see Change XPS settings with the SPARCS settings.txt file in the Navis N4: Setup,
Maintenance, and System Diagnostics Guide.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
510
Part 2: Services Management
Hold Management
Hold Settings in XPS
Default: Y
Module: EC
2.3.6.3 OVRVST
Type: Setting
Description: Determines whether the planner can override the vessel yellow stop sign that is placed on a container
when planning it to a vessel. Set this to “Y” if you want N4 to override the vessel yellow stop sign, that is, the yellow “V”
on the container. If you set this to "N", you cannot override a stopped container. To change this setting, see Change
XPS settings with the SPARCS settings.txt file in the Navis N4: Setup, Maintenance, and System Diagnostics Guide.
Default: N
Module: EC
2.3.6.4 OVRSTP
Type: Setting
Description: Determines whether the planner can override the red stop sign on a container when planning a move for
it. Set this to “Y” if you want N4 to override the red stop sign on the container. If you set this to N, you cannot override a
stopped container.
To change this setting, see Change XPS settings with the SPARCS settings.txt file in the Navis N4: Setup,
Maintenance, and System Diagnostics Guide.
Default: Y
Module: EC
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
511
2.4 Service Orders
In This Section
Maintaining Service Orders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
Vessel Visit Service Orders view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Train Visit Service Orders view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
512
Part 2: Services Management
Service Orders
Maintaining Service Orders
2.4.1 Maintaining Service Orders
Maintenance of a service order includes:
• Editing the service order or carrier visit service order
• Adding or editing service order items
• Adding services
• Adding units
• Recording service events
• Cancelling a service order
Most of these tasks do not depend on any of the others and so you can perform them in any order.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
513
Part 2: Services Management
Service Orders
Vessel Visit Service Orders view
2.4.2 Vessel Visit Service Orders view
Operations
Vessel
Vessel Visit Service Orders
Vessel Visit Service Orders view
Prerequisites
• To access this view, you need to assign the Vessel Visit Service Order - View privilege to your user role.
The Vessel Visit Service Orders view displays the service orders for vessel visits, that exist at the current scope level.
You can add, edit and delete service orders from this view.
All new service orders for carrier visits have a status of New. N4 automatically updates the status to In Progress when
one or more services have been completed. When all services associated with the service order are complete, N4
automatically updates the status to Completed. You can delete a service order for a carrier visit only if the status is
New and no items or services are associated with it. You can cancel a service order, unless it is Completed. However,
once Cancelled, it cannot be used again.
In addition, you can use the Actions menu to:
• Export SNX File (on page 1109): Export the selected service order(s) as an XML file using the snx.xsd format.
• Cancel Service Order: Cancel the selected service order(s).
• Record Service Event: Record a service event against the carrier visit for the selected service order.
Vessel Visit Service Orders Columns
Short Label
Long Label
In Filter?
Sorting?
Billing Party
Billing Party
X
X
Cancel Date
Cancel Date
X
X
Cancel Notes
Cancel Notes
X
X
Carrier Visit
Carrier Visit
Changed
Changed
X
X
Changer
Changer
X
X
Created
Created
X
X
Creator
Creator
X
X
End By Date
End By Date
X
X
Facility
Facility
X
X
Notes
Notes
X
X
Ord Line
Order Line
X
X
Order Status
Order Status
X
X
Service Order Nbr
Service Order Number
X
X
Start By Date
Start By Date
X
X
X
2.4.2.1 Vessel Visit Service Order form
Operations
Vessel
Carrier Visit Service Orders
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Carrier Visit Service Orders view
Carrier Visit Service Order form
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
514
Part 2: Services Management
Service Orders
Vessel Visit Service Orders view
The Vessel Visit Service Order form enables you to add and edit service orders for vessel visits.
To add or edit a service order:
1. In the Service Order Number field, enter an ID that uniquely identifies the service order in the system.
2. In the Carrier Visit lookup field, select the carrier visit for this service order.
3. From the Billing Party lookup field, select the organization paying for the service.
4. Enter any optional information for the service order.
5. Click Save.
You must first save the service order before you can add services in the Services tab.
The table lists the optional fields in the Service Order for Carrier Visit form:
Field Label
Description
Start By Date Enter the date when the work for the service order must begin.
End By Date
Enter the date by when the work for the service order must finish.
Order Line
Select the line operator the service order work is for.
If the Billing Party is a line operator, enter the same line operator
here.
Notes
Enter any miscellaneous notes for the service order.
Services tab
Operations
Vessel
Carrier Visit Service Orders
Carrier Visit Service Orders view
Carrier Visit Service Order form
Operations
tab
Vessel
Carrier Visit Service Orders
Carrier Visit Service Orders view
Carrier Visit Service Order Inspector
Services tab
Services
The Services tab lists the services requested for the service order. You can add new services, or edit and delete
existing services on this tab; however, you cannot add new services to a service order with a status of Completed.
Services form
Operations Vessel
Services form
Carrier Visit Service Orders
Carrier Visit Service Orders view
Carrier Visit Service Order form
Services tab
Operations Vessel
tab Services form
Carrier Visit Service Orders
Carrier Visit Service Orders view
Carrier Visit Service Order Inspector
Services
The Services form enables you to add or edit services for the selected service order.
To add or edit a service:
1. In the Service lookup list, select the requested service.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
515
Part 2: Services Management
Service Orders
Vessel Visit Service Orders view
2. Select the desired event from the Event Type drop-down field, which displays all event types marked as 'Orderable'
in the Event Types view (on page 460).
In N4 versions 3.6 and below, the Event Type drop-down field lists all events marked as billable.
3. Click Save.
4. Click Save.
Record Service Event form
Operations
Actions
Vessel Carrier Visit Service Orders Carrier Visit Service Orders view
Record Service Event Record Service Event form
Carrier Visit Service Order form
Services tab
The Record Service Event form enables you to record a service event for the selected carrier visit service order.
The Carrier Visit, Description, and Billable Event fields in this form are read-only. N4 uses these fields to
provide a short description of the event and indicate whether the event is billable to the customer or not.
The Field Updates area in this form displays any fields that require user input. The fields displayed in this area depend
on the effects defined for the selected event. For more information, see Effects tab (on page 463).
To record a service event:
1. Optionally, record the Quantity and Quantity Unit associated with the selected event type.
For example, if you have an event that records power supplied for reefers, you can enter a value in the Quantity
field and select the unit of time (days or hours) in the Quantity Unit field.
2. Click OK.
When successful, N4 displays the recorded service event for the selected equipment on the carrier visit service order's
History, Events tab and updates the service order item status to Completed.
2.4.2.2 Carrier Visit Service Order Inspector
Operations
Vessel
Carrier Visit Service Order
Carrier Visit Service Order view
Carrier Visit Service Order Inspector
The Carrier Visit Service Order Inspector displays the details of the selected service order and enables you to
perform various actions on it. The Carrier Visit Service Order Inspector provides a view of all aspects of the selected
service order from the perspective of the facility in the current scope. You can keep the Carrier Visit Service Order
Inspector open at all times as you work in other views and forms, and you can move and resize it as needed.
When you update the selected service order, N4 automatically refreshes the information displayed in the Carrier Visit
Service Order Inspector.
The basic information for an service order displays in the following areas:
• Service Order: The left area displays the service order number for the selected service order.
• Details: The right area displays the service order details, such as the order status, carrier visit, billing party, line
operator, start and end by dates, cancel date, and cancel notes.
The Details pane displays additional service order information below the
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
button.
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
516
Part 2: Services Management
Service Orders
Vessel Visit Service Orders view
To display the Details pane:
1. Click
.
2. From the list on the left, select the type of information to display.
To perform actions:
1. Click Actions to display the menu.
2. Select the required menu option.
Details pane in the Carrier Visit Service Order Inspector
Operations
Vessel
Carrier Visit Service Order
Carrier Visit Service Order view
Carrier Visit Service Order Inspector
The Details pane in the Carrier Visit Service Order Inspector displays additional carrier visit service order
information. The information is categorized and displayed on the following tabs:
• History, Events: Displays the events recorded for the carrier visit service order.
• Services (on page 515): Displays the requested events associated with the service order.
History, Events tab
You can access the Event History tab from various inspectors.
The History, Events tab displays the events recorded for the selected entity such as unit, container, chassis,
accessory, vessel visit, train visit, bill of lading, or an order (booking, EDO, or ELO). You can record service events for
the selected entity on this tab. For more information, see Event Types view (on page 460).
In addition, when you perform certain tasks in N4 or in XPS, such as discharge a container or edit the routing
information for a booking, N4 records the associated built-in events on the tab for the affected entity.
To view the details of an event, double-click the event or use the Action Show Details option. The Changes field
displays the values that changed per the event for a unit, booking, EDO, or ELO, such as the old and new unit position
for a unit discharge event.
When a billable event is extracted to the Chargeable Unit Events view (on page 546), N4 associates the Batch ID with
the event. You can display the Extract Batch column to view the Batch ID associated with the event. For more
information on displaying a column, see Hiding and displaying columns (on page ).
For break-bulk units that are associated with cargo lots, N4 also displays any cargo lot events in the History, Events
tab for the unit.
You can see the Hatch Clerk's ID in the XPS log, but it does not appear in N4 by default unless you use the Radio
Server. To make the Hatch Clerk ID visible in N4 without the Radio Server, you can implement a customized code
extension of the type ENTITY_LIFECYCLE_INTERCEPTION with the name UpdateMoveEventAppliedByInfo.
Record Service Event form
Operations
Events tab
Vessel
Actions
Carrier Visit Service Orders Carrier Visit Service Orders view
Record Service Event Record Service Event form
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Carrier Visit Service Order Inspector
History,
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
517
Part 2: Services Management
Service Orders
Train Visit Service Orders view
The Record Service Event form enables you to record a service event for the selected carrier visit service order.
The Description and Billable Event fields in this form are read-only. N4 uses these fields to provide a short
description of the event and indicate whether the event is billable to the customer or not.
Optionally, the Field Updates area in this form displays any fields that require user input. The fields displayed in this
area depend on the effects defined for the selected event. For more information, see Effects tab (on page 463).
To record a service event:
1. Select the Event Type ID for the event that you want to record.
The drop-down list displays only the service events that are required for the services listed under the Services tab
(on page 515).
2. Optionally, record the Quantity and Quantity Unit associated with the selected event type.
For example, if you have an event that records power supplied for reefers, you can enter a value in the Quantity
field and select the unit of time (days or hours) in the Quantity Unit field.
3. Click OK.
When successful, N4 displays the recorded service event for the selected equipment on the carrier visit service order's
History, Events tab and updates the service order item status to Completed.
2.4.3 Train Visit Service Orders view
Operations
Rail
Train Visit Service Orders
Train Visit Service Orders view
Prerequisites
• To access this view, you need to assign the Train Visit Service Order View privilege to your user role.
The Train Visit Service Orders view displays the service orders for train visits, that exist at the current scope level.
You can add, edit and delete service orders from this view.
All new service orders for carrier visits have a status of New. N4 automatically updates the status to In Progress when
one or more services have been completed. When all services associated with the service order are complete, N4
automatically updates the status to Completed. You can delete a service order for a carrier visit only if the status is
New and no items or services are associated with it. You can cancel a service order, unless it is Completed. However,
once Cancelled, it cannot be used again.
In addition, you can use the Actions menu to:
• Export SNX File (on page 1109): Export the selected service order(s) as an XML file using the snx.xsd format.
• Record Service Event: Record a service event against the carrier visit for the selected service order.
• Cancel Service Order: Cancel the selected service order(s).
2.4.3.1 Train Visit Service Order form
Operations
Rail
Train Visit Service Orders
Train Visit Service Orders view
Train Visit Service Order form
The Train Visit Service Order form enables you to add and edit service orders for train visits.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
518
Part 2: Services Management
Service Orders
Train Visit Service Orders view
To add or edit a service order:
1. In the Service Order Number field, enter an ID that uniquely identifies the service order in the system.
2. In the Carrier Visit lookup field, select the carrier visit for this service order.
3. From the Billing Party lookup field, select the organization paying for the service.
4. Enter any optional information for the service order.
5. Click Save.
You must first save the service order before you can add services in the Services tab.
The table lists the optional fields in the Service Order for Train Visit form:
Field Label
Description
Start By Date Enter the date when the work for the service order must begin.
End By Date
Enter the date by when the work for the rail order must finish.
Order Line
Select the line operator the service order work is for.
If the Billing Party is a line operator, enter the same line operator here.
Notes
Enter any miscellaneous notes for the rail order.
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
519
2.5 Related Terminal Services
In This Section
Related Terminal Services view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Related Terminal Services form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Published: Tuesday, April 21, 2020
Confidential -- Proprietary
Navis N4 3.8.6: EDI, Billing, and Services Management Administrator and User Guide
520
Part 2: Services Management
Related Terminal Services
Related Terminal Services view
2.5.1 Related Terminal Services view
Configuration
Services
Related Terminal Services
Related Terminal Services view
The Related Terminal Services view displays the related terminal services that exist at the current scope level.
Prerequisites
• The following privileges are required: RELATED_SERVICES_VIEW, RELATED_SERVICES_ADD,
RELATED_SERVICES_EDIT, RELATED_SERVICES_DELETE.
In addition, you can use the Actions Export SNX File (on page 1109) option to export the selected container notices
as an XML file using the snx.xsd format.
What is a related terminal service?
A related terminal service is an option that allows your terminal to relate a primary service and its associated event
type, with another service or event. You set up related terminal services so that every time you perform a service that
records an event on a serviceable entity (container, goods, vessel visit, etc.), N4 also records the related terminal
service or event. In addition, N4 automatically applies any general notice, service business rule, or auto update rule (on
page 505), on the related terminal service, every time it is recorded.
When you delete an event recorded on a serviceable entity N4 also deletes all related terminal services
recorded along with the event.
When can you use related terminal services?
Related terminal services are mostly used so that they can be billable. Typically, related terminal services are use