The following section lists the mapping codes available to CARICOM and the user access rights.
Document Type Mapping Fields
Table A-1 CARICOM Document Type
| Code | Description | Document Types |
|---|---|---|
|
A |
Alien Registration Card |
U.S. Alien Registration Card |
|
B |
Birth Certificate |
Birth Certificate |
|
CCERT |
Crew Member Certificate |
Government Issued Picture ID(US) |
|
CP |
CARIPASS CARD |
(**only for CARICOM) |
|
CRBA |
Consular Report of Birth Abroad |
Consular Report of Birth Abroad |
|
D |
Driver License |
Government Issued Picture ID(US) |
|
DIPID |
Diplomatic Identification |
Government Issued Picture ID(US) |
|
EDL_BC |
Enhanced Driver's License (BC) |
EDL (BC) |
|
EDL_MB |
Enhanced Driver's License (MB) |
EDL (MB) |
|
EDL_MI |
Enhanced Driver's License (MI) |
EDL (MI) |
|
EDL_NY |
Enhanced Driver's License (NY) |
EDL (NY) |
|
EDL_ON |
Enhanced Driver's License (ON) |
EDL (ON) |
|
EDL_QC |
Enhanced Driver's License (QC) |
EDL (QC) |
|
EDL_VT |
Enhanced Driver's License (VT) |
EDL (VT) |
|
EDL_WA |
Enhanced Driver's License (WA) |
EDL (WA) |
|
F |
Refugee Permit |
Government Issued Picture ID(US) |
|
FAST |
FAST ID Type |
FAST |
|
FD |
Facilitation Document (Deportee) or (Consular) |
Facilitation Document (Deportee) or (Consular) |
|
FMD |
Foreign Mariner Document |
Foreign Mariner Document |
|
GLOENT |
Global Entry |
Global Entry |
|
GP |
Group Passport |
Government Issued Picture ID(US) |
|
I |
Ins Pass Document |
Government Issued Picture ID(US) |
|
L |
License |
Pilot License |
|
M |
Military Id |
Military ID |
|
MMC |
U.S. Merchant Mariner Credential |
U.S. Merchant Mariner Credential |
|
MMD |
Merchant Mariner Document |
U.S. Merchant Mariner Document |
|
N |
National Picture ID |
Government Issued Picture ID(US) |
|
NEXUS |
Nexus |
Nexus |
|
NTV_US |
Native American |
Native American |
|
O |
Certificate of Naturalization |
Certificate of Naturalization |
|
OD |
Official Government Document |
Official Government Document |
|
P |
Passport |
Passport Number |
|
PPC |
Passport Card |
Passport Card |
|
R |
Residence Permit |
Residence Permit |
|
RID |
Regional ID |
Government Issued Picture ID(US) |
|
SENTRI |
SENTRI |
SENTRI |
|
SFR |
Seafarer's Identification Document |
Seafarer's Identification Document |
|
TP_RFG |
TP - Refugee Travel Document |
TP - Refugee Travel Document |
|
TRANS |
Transportation Worker Identification Credential |
Transportation Worker Identification Credential |
|
TRBC |
Tribal Card (IC) |
Tribal Card (IC) |
|
TRBC2 |
Tribal Card (II) |
Tribal Card (II) |
|
TR_REE |
TR - Permit to Re-enter |
TR - Permit to Re-enter |
|
TT |
Travel Title |
Government Issued Picture ID (US) |
|
US_GID |
Government Issued Picture ID (US) |
Government Issued Picture ID (US) |
|
US_PRC |
U.S. Permanent Resident Card |
U.S. Permanent Resident Card |
|
CA_GID |
Canada Government Issued Picture ID |
Government Issued Picture ID (CANADA) |
|
C |
U.S. Government Issued Picture ID |
Government Issued Picture ID (US) |
|
V |
U.S. Government Issued Picture ID |
Government Issued Picture ID (US) |
User Access Rights
Table A-2 User Access Rights
| Security Reference Number | Description |
|---|---|
|
3256 |
Ship Information Setup |
|
3257 |
Harbour/Port Setup |
|
3258 |
Crew Position Setup |
|
3259 |
Submission Setup |
This section describes the available parameters for the CARICOM module. They are accessible in Administration module, System Setup, Parameter.
Table A-3 PAR Group CARICOM
| PAR Name | PAR Value | Description |
|---|---|---|
|
CARICOM Web Service SOAPAction |
[website] |
Web Service SOAP Action for the CARICOM System |
|
CARICOM Web Service SOAPHeader |
[website] |
Web Service SOAP Header for the CARICOM System |
|
CARICOM Web Service URL |
[website] |
Web Service URL for the CARICOM System |
|
Default to FNU on blank UXP_A_FSTN or FIRST_NAME |
1 |
1 – Enable. If the guest first name is null, it defaults the First Name field as “FNU” 0 – Disable. If disabled, the First Name field cannot be null |
|
File Name of CARICOM PORT Setup File |
CARICOMPORTS.xlsx |
Support Excel file extension for XLS instead of XLSX. |
|
File Output Folder |
[path] |
Allows output file to be saved to a user-defined folder. For example, C:\temp\xxxx\Caricom |
|
Include VOYAGE_NUMBER During Submission |
VOYAGE_NUMBER: 1=Time Stamp, 2=SCR_ITN_ID, Blank=NULL |
|
|
Mandatory Birthdate Field |
1 |
1 – Enable the birthdate field as mandatory 0 – Disable birthdate field for guests/crew handling |
|
Mandatory Fields For <ARRIVE> |
<element> |
Specify the mandatory XML fields for <ARRIVE> element that CARICOM program will check during file creation. Use Comma Delimited Values. For example, ARRIVE_DT,ARRIVE_TIME,PORT_NAME,CITY,STATE,FACILITY,PLACE |
|
Mandatory Fields For <CARGO> |
<element> |
Specify the mandatory XML fields for <CARGO> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, GENERAL_DESC,CDC_ON_BOARD |
|
Mandatory Fields For <COMP_CERT> |
<element> |
Specify the mandatory XML fields for <COMP_CERT> element that CARICOM program will check during file creation. Use Comma Delimited Values. For example, ISSUED_DT,EXPIRATION_DT,AGENCY |
|
Mandatory Fields For <CONTACT> |
<element> |
Specify the mandatory XML fields for <CONTACT> element that CARICOM program will check for during file creation. Use Comma Delimited Values. For example, NAME,PHONE |
|
Mandatory Fields For <CREW> |
<element> |
Specify the mandatory XML fields for <CREW> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, POSITION,LAST_NAME,FIRST_NAME,BIRTH_DT,GENDER,NATIONALITY,NATIONALITY_CODE,COUNTRY_RESIDENCE,COUNTRY_RESIDENCE_CODE,ID_TYPE,ID_NUM,ID_COUNTRY,ID_COUNTRY_CODE,EMBARK_COUNTRY,EMBARK_COUNTRY_CODE,EMBARK_STATE,EMBARK_PORT_NAME,EMBARK_PORT_CODE,EMBARK_DATE |
|
Mandatory Fields For <DEPART> |
<element> |
Specify the mandatory XML fields for <DEPART> element that CARICOM program will check during file creation. Use Comma Delimited Values. For example, DEPART_DT,DEPART_TIME,PORT_NAME,CITY,STATE,PLACE |
|
Mandatory Fields For <ISSC> |
<element> |
Specify the mandatory XML fields for <ISSC> element that CARICOM program will check during file creation. Use Comma Delimited Values. For example, ISSUED_DT,VSP_IMPLEMENTATION,ISSC_TYPE,INTERIM_ISSC,FLAG_ADMINISTRATION,FLAG_ADMINISTRATION_CODE,CSO_NAME,CSO_PHONE |
|
Mandatory Fields For <LAST_PORT> |
<element> |
Specify the mandatory XML fields for <LAST_PORT> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, ARRIVE_DT,DEPARTURE_DT,LAST_PORT_COUNTRY,LAST_PORT_COUNTRY_CODE,LAST_PORT_STATE,LAST_PORT_NAME,LAST_PORT_CODE,LAST_PORT_PLACE |
|
Mandatory Fields For <NEXT_PORT> |
<element> |
Specify the mandatory XML fields for <NEXT_PORT> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, ARRIVE_DT,ARRIVE_TIME,NEXT_PORT_COUNTRY,NEXT_PORT_COUNTRY_CODE,NEXT_PORT_STATE,NEXT_PORT_NAME,NEXT_PORT_CODE,NEXT_PORT_PLACE |
|
Mandatory Fields For <NONCREW> |
<element> |
Specify the mandatory XML fields for <NONCREW> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, LAST_NAME,FIRST_NAME,BIRTH_DT,GENDER,NATIONALITY,NATIONALITY_CODE,COUNTRY_RESIDENCE,COUNTRY_RESIDENCE_CODE,ID_TYPE,ID_NUM,ID_COUNTRY,ID_COUNTRY_CODE,ID_EXPIRATION_DT,US_ADDRESS_STREET,US_ADDRESS_CITY,US_ADDRESS_ZIP |
|
Mandatory Fields For <NONCREW> 1 |
<element> |
Specify the mandatory XML fields for <NONCREW> element that CARICOM program checks during file creation. Use Comma Delimited Values. (Continued) For example, EMBARK_COUNTRY,EMBARK_COUNTRY_CODE,EMBARK_STATE,EMBARK_PORT_NAME,EMBARK_PORT_CODE,EMBARK_DATE |
|
Mandatory Fields For <NOTICE_DETAILS> |
<element> |
Specify the mandatory XML fields for <NOTICE_DETAILS> element that CARICOM program checks during file creation. Use Comma Delimited Values For example, CREATED_DATE_TIME,NOTICE_ID,NOTICE_TRANSACTION_TYPE,NOTICE_TYPE,VERSION |
|
Mandatory Fields For <PREVIOUS_FOREIGN_PORT_LIST> |
<element> |
Specify the mandatory XML fields for <PREVIOUS_FOREIGN_PORT_LIST> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, ARRIVAL_DT,DEPARTURE_DT,PREVIOUS_COUNTRY,PREVIOUS_COUNTRY_CODE,PREVIOUS_PORT_NAME,PREVIOUS_PORT_CODE,PREVIOUS_PLACE |
|
Mandatory Fields For <REPORTING_PARTY> |
<element> |
Specify the mandatory XML fields for <REPORTING_PARTY> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, NAME,EMAIL,COMPANY |
|
Mandatory Fields For <SFTYMGMT_CERT> |
<element> |
Specify the mandatory XML fields for <SFTYMGMT_CERT> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, ISSUED_DT,EXPIRATION_DT,AGENCY |
|
Mandatory Fields For <VESSEL> |
<element> |
Specify the mandatory XML fields for <VESSEL> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, NAME,CALL_SIGN,ID_NUM,ID_TYPE,FLAG,FLAG_CODE,OWNER,OPERATOR,CLASS_SOCIETY,CHARTERER,OCE,OCE_DESC |
|
Mandatory Fields For <VESSEL_LOC> |
<element> |
Specify the mandatory XML fields for <VESSEL_LOC> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, LOCATION_DESC,LAT_HR,LAT_MIN,LAT_SEC,N_S,LONG_HR,LONG_MIN,LONG_SEC,E_W |
|
Mandatory Fields For <VOYAGE> |
<element> |
Specify the mandatory XML fields for <VOYAGE> element that CARICOM program checks during file creation. Use Comma Delimited Values. For example, VOYAGE_TYPE |
|
Mandatory First Name Field |
1 |
1 – Mandatory for First Name field for guests/crew handling 0 – Not mandatory |
|
Mandatory Gender Field |
1 |
1 - First Name Mandatory for expected crew or passengers 0 – Not mandatory for First Name Only crew/passenger records that contain this information is included in CARICOM Manifest submission when expected crew/passenger is chosen during file creation. |
|
Mandatory ID Field |
1 |
1 - Passport (or other form of identification) is mandatory for expected crew or passengers. 0 – Not mandatory for passport Only crew/passenger records that contain this information is included in CARICOM Manifest submission when expected crew/passenger is chosen during file creation. |
|
Mandatory Last Name Field |
1 |
1 - Last Name is mandatory for expected crew or passengers 0 – Not mandatory for last name Only crew/passenger records that contain this information is included in CARICOM Manifest submission when expected crew/passenger is chosen during file creation |
|
Mandatory Nationality Field |
1 |
1 - Nationality is mandatory for expected crew or passengers 0 – Not mandatory for nationality Only crew/passenger records that contain this information is included in CARICOM Manifest submission when expected crew/passenger is chosen during file creation. |
|
Manifest Submission Tracker |
If specified, it creates a Tracker File with matching XML file name, or else it defaults to save the file to |
|
|
Source Column For Record Locator |
<value> |
Specifies the Database column used for <PASSENGER_RECORD_LOCATOR> For example, RES_ACC |