COMMON CODES
The term common code refers to a group of frequently codes such as reference files. The common codes search option provides a single location where most codes can be easily searched.
When searching for a particular code, it may be useful to reduce the search to a particular reference group. Alternatively, if you are unsure of the reference group, leave the reference group as its default of ALL.
The common codes are made up of reference groups. For example, within air cargo operations, codes found in this section include payment methods, agency codes and port types among many others. Each of these and other reference groups contain a number of reference files.
SEARCHING FOR A COMMON CODE
The Common Code Search screen enables users with the appropriate access to search for common codes used in the Integrated Cargo System (ICS).
To search for a common code:
Step 1. From the main menu, click on Reference and then click on Common Codes.
The Common Code Search screen displays.
The Common Code Search screen enables users to search for common codes used in the ICS.
Tip: the default search criterion in the Reference Group field is All, and the default search criterion in the Reference File field is Customs Controlled Port Codes.
Step 2. In the Reference Group field, click on the drop down button and select one of the following options:
* ALL
* CARGO AIR (payment method, quantity unit)
* CARGO SEA (container type, pay method code)
* CLIENT (client role group)
* CRA (assessment lift reason, task action)
* EXPORTS (chemical element group, export outbound advice texts)
* MISCELLANEOUS (country, currency country code, currency, IATA port code, goods origin code, outturn result, pack type, port functions, application timeout).
Note: the selection made for this field will determine the options available in the Reference File field. Some reference groups may not have all associated reference files, only those associated with that part of the ICS. To view a list of all reference files, use the ALL option in the Reference Group field.
Step 3. In the Reference File field, click on the drop down button to select an option to base your search on.
Step 4. (Optional) In the Code field, enter the code you want to view in more detail. This field can be left blank if you are searching for a particular code by name, or want to see a list of all codes for a particular reference group or reference file.
Tip: you can also enter part of a code to search for by using the wildcard (*) character. For example, entering A* will list all codes of the Group and File selected starting with A.
Note: the minimum characters required to perform a wildcard search is one.
Step 5. (Optional) In the Name field, enter the name of the code you want to view. This field can be left blank to view all valid codes for the reference file specified.
Tip: you can also enter part of a name to search on by using the wildcard (*) character. For example, entering A* will list all names of the Group and File selected starting with A.
Step 6. (Optional) Select the Latest, Previous or All option.
If Latest is selected, the active (or current) record that matches the search criteria is selected.
If Previous is selected, then all records that match the search criteria and have a Date of Effect - End that is earlier than the Date of Effect - Start of the latest version are selected.
If All is selected, then all records that match the search criteria including any records with Dates of Effect - Start in the future, are selected.
Step 7. (Optional) In the Date of Effect - Start field, enter the dates that the code is to be enabled.
Step 8. (Optional) In the Date of Effect - End field, enter the date that the code is to expire from the system.
Note: if an end date is entered then you must also enter a start date. Also, you should be aware that even if a record has a start date on or after the entered start date or if the record has an end date after the entered end date it will not be listed.
Note: to clear the search criteria entered, click on the Clear button.
Step 9. Click on the Search button.
If one record is found, the view screen displays for the code type.
If more than one record is found, the list screen displays the matching codes.
The following table contains the screens that may display when multiple results are found.
Listing Common Codes
If more than one record was returned from the search, depending on the search performed, one of a number of list screens will display.
For example, the Country Codes List screen could display.
The relevant common code list screen enables users to display all codes and limited related information for the search parameters entered in the Common Code Search screen - in this case country codes.
The following table lists the options available on any of the common code list screens.
Step 10. Click on a hyperlink in the Reference Code column.
Viewing Common Codes
If one record was found, or you selected hyperlink in the Reference Code column, depending on the search performed, one of a number of view screens will display.
For example, the Country Codes View screen could display.
The common code view screens enable users to display the full details of a common code.
All fields are read only.
The following table lists the options available on any of the common code view screen.
