The eLandings XML schema

Landing Report Elements

The landing_report element is the top level element required in landing report import files. The landing_report has the following elements.
2.2.1 Messages
The messages element should not be specified in import files.
2.2.2 Schema Version
The schema version data element allows the software to know what version of the schema the XML was generated for, if it is not the most current version. If the schema version element is not provided it defaults to version 1.0, the original groundfish release production schema. The contents of the schema version element corresponds to the version attribute in the <xs:schema> element of the schema, the top level element of the schema definition. Note that this is NOT the version attribute in the <xml> element that contains the schema definition. That attribute defines the version of XML, as specified by the W3C consortium.
2.2.3 Landing_report_id
The landing_report_id is generated by the eLandings system. A placeholder value can be provided, but it will be replaced by a new landing report during the import processing. Generally, landing report id should not be provided.
2.2.4 Type of Landing Report
The type of landing report distinguishes between Crab, with a type of "C", and groundfish, with a type of "G". The type of landing report is required.
2.2.5 Status
The status element should not be specified in the import file.
2.2.6 Transmission
The transmission element is used by the eLandings Processor Workstation software, and should not be specified in the import file. The transmission element was enhanced in schema version 1.1.
2.2.7 Header
The header element is required
2.2.7.1 Vessel
The vessel element is the vessel ADF&G number, and is required.
2.2.7.2 Crew_size
The crew_size element is required. It is the number of crew onboard, including the skipper, but excluding any observers.
2.2.7.3 Observers_onboard
The observers_onboard element is required. It is the number of observers onboard the vessel for the trip.
2.2.7.4 Port_of_landing
The port_of_landing element is required. It is the ADF&G port code, as entered on fish tickets.
2.2.7.5 Gear
The gear element is required. It is the ADF&G gear code, as entered on fish tickets.
2.2.7.6 Proc_code_owner
The proc_code_owner element is required. This element identifies the entity that purchases or otherwise controls the fish, and is equivalent to the proc code embossed on paper fish tickets.
2.2.7.6.1 Proc_code
The proc_code element is required. It is the ADF&G intent to operate processor code, also known as the F-code.
2.2.7.7 Proc_code_processor
The proc_code_processor element identifies the custom processor, if there is one. This element is not required, and should be used only if custom processing is taking place.
2.2.7.7.1 Proc_code
The proc_code element is required. It is the ADF&G intent to operate processor code, also known as the F-code.
2.2.7.8 Date_fishing_began
The date_fishing_began element is the date the gear went in the water. This element is required. It cannot be after date_of_landing
2.2.7.9 Days_fished
The days_fished element is not required for IFQ crab landings. It will be required for some fisheries.
2.2.7.10 Date_of_landing
The date_of_landing element is required.
2.2.7.11 Partial_delivery
The partial_delivery element is required. It is a flag indicating if the landing report is for a partial delivery or not.
2.2.7.12 Last_delivery_for_trip
The last_delivery_for_trip element is required. It is a flag indicating if the landing is the last for the trip, or if other deliveries, and hence landing reports can be expected.
2.2.7.13 Multiple_ifq_permits
The multiple_ifq_permits element should not be specified in the import file.
2.2.7.14 Manual_ifq_report
The manual_ifq_report element indicates that the IFQ reporting for this landing was done by contacting the NMFS Enforcement data clerks by telephone and making the IFQ reports manually to them. If the manual_ifq_report element is set to true then no IFQ reports should be included in the landing report import file. The manual_ifq_report element was added in schema version 1.1.
2.2.7.15 Nearest_bay_or_headland
The nearest_bay_or_headland element is not required for IFQ crab or groundfish.
2.2.7.16 Federal_processor_number
The federal_processor_number is required for groundfish landings. It is the federal_processor_permit number for the processor submitting the report.
2.2.7.17 Registered_buyer_number
The registered_buyer_number is not required for IFQ crab. It will be required for IFQ halibut and sablefish. This element may be provided even when not required.
2.2.7.18 Registered_crab_receiver_number
The registered_crab_receiver_number is required for IFQ crab. It is the RCR number issued by NMFS. This element will not be required for groundfish and non-IFQ shellfish landings, but may be provided.
2.2.7.19 Discard_report
The discard_report element is not required for IFQ crab. It will be required for groundfish. The values for discard_report will be:
Value Description
RC Received
NC Not received
NP Not required, vessel not federally permitted
NL Not required, vessel less than 60 feet
Additional values may be added for state managed fishery landings.
2.2.7.20 Tender_vessel
The tender_vessel element indicates the ADF&G number of the tender that took the delivery that generated the landing report. It should only be used for tender deliveries. The tender_vessel element was added in schema version 1.1.
2.2.7.21 Rsw_temp
The rsw_temp element is used to record the refrigerated sea water temperature for tender vessels that use an RSW system rather than ice. It should only be specified if the tender_vessel element is specified and RSW was used. The rsw_temp element was added in schema version 1.1.
2.2.7.22 Buying_station_name
The buying_station_name element is not required for IFQ crab. It may be used for groundfish. The buying station operation records must be setup on the eLandings system prior to use in landing reports.
2.2.7.23 Agency_header_data
The agency_header_data element should not be specified in the import file.
2.2.7.24 Permit_worksheet
At least one permit_worksheet element is required. Each permit worksheet element allows a CFEC permit to be specified, so multiple worksheets allow permit stacking.
2.2.7.24.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.7.24.2 Cfec_permit
The cfec_permit element is required.
2.2.7.24.2.1 Fishery
The fishery element is required. This element is the fishery code on the CFEC permit card.
2.2.7.24.2.2 Permit_number
The permit_number element is required. This element is the unique permit number on the CFEC card. It is a five digit number followed by one alphabetic check character.
2.2.7.24.2.3 Year_seq
The year_seq element is required. This element is the year and card sequence from the CFEC card. It is a two digit year, a two digit sequence number, and one alphabetic check character.
2.2.7.24.3 Management_program
The management_program element is required on all eLandings landing reports.
2.2.7.24.3.1.1 Program
The program element is required. It is the management program abbreviation such as CDQ, AFA, or ADAK. For IFQ crab, halibut, or sablefish, the management program is IFQ. For groundfish with no other management program the value should be OA, for open access.
2.2.7.24.3.1.2 Program_id
The program_id element is conditionally required. If the management program has participant IDs, such as CDQ numbers for CDQ or Co-op numbers for AFA, then it is required. If the management program has no participant numbers, such as ADAK, then this element is not required.
2.2.7.24.4 Percent
The percent element is not required. It is used by the eLandings system when allocating line items to stacked permits. If the import file specifies a fish ticket number for each line item, then percent will not be used, and can be omitted. However, if the import file does not already allocate the line items to the CFEC permits then the percent field will be needed to determine the proper allocation.
If percent is specified, then the total of all the percents on the permit worksheet elements must add up to 100. Percent may be specified as zero, to prevent automatic allocation of line items to specific permits.
2.2.7.24.5 Fish_ticket_number
The fish_ticket_number element is not required. When the file is imported the eLandings system will generate a new fish ticket number for each CFEC permit. If a fish ticket number is specified in the file it will be replaced. However, if a place holder fish ticket number is specified in the import file, and is used on line items, then the import process will replace the number consistently. This allows the allocations of line items to CFEC permits in the import file to be preserved even though new fish ticket numbers are generated.
2.2.7.24.6 Fish_ticket_sequence
The fish_ticket_sequence element should not be specified in the import file.
2.2.7.24.7 Batch Year
The batch_year element should not be specified in the import file.
2.2.7.24.8 Batch Office Code
The batch_office code element should not be specified in the import file.
2.2.7.24.9 Batch_number
The batch_number element should not be specified in the import file
2.2.7.24.10 Ifq_permit_worksheet
The ifq_permit_worksheet element is not required, but may be specified. Multiple ifq_permit_worksheet elements may be provided for each CFEC permit, allowing multiple IFQ permits to be stacked on each CFEC permit.
2.2.7.24.10.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.7.24.10.2 Ifq_permit_number
The ifq_permit_number element is required.
2.2.7.24.10.3 Nmfs_person_id
The nmfs_person_id element is required. This is a unique ID issued by NMFS to each person authorized to fish for IFQ species, whether a permit holder or a hired skipper. The nmfs_person_id must be the same for all ifq_permit_worksheet elements associated with a single CFEC permit.
2.2.7.24.10.4 Species
The species element is required. This is the ADF&G species code associated with the permit.
2.2.7.24.10.5 Fishery_area
The fishery_area element may be specified. The fishery_area element is used by the eLandings system when allocating line items to permits. The fishery area elements specifies the area or fishery where the permit has quota, and is used to allocate itemized catch from that area or fishery to the permit. This element is typically used in conjunction with the pounds element to "max out" a permit.
2.2.7.24.10.6 Pounds
The pounds element may be specified. The pounds element is used by the eLandings system when allocating line items to permits. The pounds element specifies an amount of IFQ quota pounds to allocate to that permit. This is typically used to "max out" a permit that is close to the end of its quota. To use this feature several conditions must be observed. At least one other IFQ permit for the same species must be specified in the file without the pounds element. The reason for this condition is that the allocation routine must have somewhere to place landed catch that is not used to satisfy requested pounds for permits.
2.2.7.24.10.7 Ipq_permit_number
The ipq_permit_number is conditionally required for crab landings. It is not allowed for groundfish landings. If the IFQ permit is a class A permit, then an IPQ number is required. The IPQ permit must be valid for use with the RCR number specified in the header.
2.2.7.25 Stat_area_worksheet
The stat_area_worksheet element is not required. However, if it is not provided then each line item must have a stat_area specified.
More that one stat_area_worksheet elements may be specified.
2.2.7.25.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.7.25.2 Stat_area
The stat_area element is required. This is the ADF&G groundfish statistical area.
2.2.7.25.3 Percent
The percent element is required. The total of percents for all stat_area_worksheet elements must equal 100.
2.2.7.25.4 Effort
The effort element is required for IFQ crab. It is the number of pot lifts in the associated statistical area. For groundfish, this element will not be allowed.
2.2.8 Line_item
At least one line_item element is required.
2.2.8.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.8.2 Fish_ticket_number
The fish_ticket_number element is not required. If it is specified the entire weight for the line item is allocated to that fish ticket. If not specified, the eLandings system will allocate the line item among the CFEC permits specified on the permit worksheet.
If provided, the fish_ticket_number value must match one of the values specified on the permit worksheet. The import process will replace the provided values with new fish ticket numbers, generated by the system, but will preserve the relationship of line items and permits.
2.2.8.3 Stat_area
The stat_area element is required if the stat area worksheet is not specified. If the stat area worksheet is provided then the stat_area element on the line item may still be specified. In that case it overrides the stat area worksheet for the weight reported on that line.
2.2.8.4 Species
The species element is required. It is the ADF&G numeric species code.
2.2.8.5 Condition_code
The condition_code element is required. It is a subset of the current fish ticket delivery codes. The valid condition code values will be available on the web application.
2.2.8.6 Weight
The weight element is required. This element is the scale weight in pounds for the line item. The weight may include up to 4 decimal places, and should be less than 100 million.
2.2.8.7 Weight_modifier
The weight_modifier element is not required. It should not be used for IFQ crab, but can be used for groundfish. However, the Ice and Slime value can only be used for halibut and sablefish. The values will be:
Value Description
I/S Weight includes ice and slime
Est Estimated weight

2.2.8.8 Count
The count element is required for IFQ crab, but will not be required for groundfish. The count element is the number of animals for crab landings, and the number of fish for discard lines on groundfish reports where weight is not available and number of fish is required by reporting requirements.
2.2.8.9 Effort
The effort element is conditionally required. If the stat area for the line item is not specified and the stat area worksheet is used then the effort element is not required. If the line item stat area is specified then effort is required for IFQ crab. This is the number of pot lifts. Effort is not allowed for groundfish.
2.2.8.10 Disposition_code
The disposition_code element is required. Disposition code is a subset of the current ADF&G delivery codes, and additions. The valid disposition code values will be available on the web application.
2.2.8.11 Agency_line_data
The agency_line_data element should not be specified in the import file.
2.2.8.12 Product_item
The product_item element not allowed for line items that have non-sold dispositions. Multiple product_item elements may be specified per line item, for cases where the line item amount has multiple sizes and grades. For line items with a condition code that can be either a primary or ancillary product, at least one product_item is required. In that case, if the disposition of the line item is not a sold disposition then the product_item may not have a price.
2.2.8.12.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.8.12.2 Product_code
The product_code element is required. Product code is a misnomer; this data element is actually the sold condition code. For IFQ crab it will be the same as the line item condition code. For groundfish it may be different, for example when the fisherman delivers whole sablefish, but is paid on the weight of dressed fish.
For IFQ crab the product code must always be the same as the line item condition code.
2.2.8.12.3 Product_type
The product_type element is required. It indicates where the sold item is a primary product or an ancillary product. The values are
Value Description
P Primary product
A Ancillary product
R Reprocessed product
For IFQ crab the value will always be 'P'. Reprocessed is used only for fishmeal, and generally should not be used unless instructed to do so by management agency personnel.
2.2.8.12.4 Size_grade
The size_grade element is not required. This is an optional field that allows processors to list sizing and grading information on the product items. It is freeform text, with a maximum length of 16 characters.
2.2.8.12.5 Weight
The weight element is required. This is the weight of the sold item. The total of the weights of all the product items for a line item cannot be more that the weight of the line item.
2.2.8.12.6 Price
The price element is required. The price can have up to 3 decimal places.
2.2.8.13 Line_Item_stat_area
The agency_line_data element should not be specified in the import file.
2.2.8.14 Line Item Comment
The line item comment is conditionally required. If the condition code for the line item is 97, the comment code for the line item comment should also be 97 and the comment text should contain a description of the condition of the fish. Disposition codes of 62 for overages and 64 for tagged fish also require comments. See the elandings online documentation for codes and valid combinations. In most cases the import files should not specify these dispositions, they should be edited in once the file is imported.
2.2.9 Ifq_report
The ifq_report element is not required. The eLandings system has features that generate IFQ reports from line item data. The report generation process is fairly complex, and the user is allowed to edit the generated IFQ reports before they are submitted. However, all IFQ reports, however generated and edited, must pass validation checks that insure consistency between the fish tickets and the IFQ reports.
Although not recommended, the ifq_report elements may be specified in the import file if a processor desires to generate them outside of the eLandings system.
2.2.9.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.9.2 Nmfs_person_id
The nmfs_person_id element is required. It must match the NMFS person id on the permit worksheet element for the fish ticket specified on the IFQ report.
2.2.9.3 Ifq_permit_number
The ifq_permit_number element is required. It must match one of the IFQ permit numbers provided on the IFQ permit worksheet associated with the permit worksheet element for the fish ticket specified on the IFQ report.
2.2.9.4 Fish_ticket_number
The fish_ticket_number element is required. It associates the IFQ report with a specific fish ticket, and hence a CFEC permit.
2.2.9.5 Ipq_permit_number
The ipq_permit_number element is conditionally required. If the IFQ permit is a class A permit for IFQ crab then the IPQ permit is required. The IPQ permit must match that provided on the IFQ permit worksheet for the NMFS person ID and IFQ permit specified on the IFQ report.
2.2.9.6 Fishery
The fishery element is not required for IFQ crab. For IFQ halibut it specifies a fishery type if the halibut was harvested as bycatch in another fishery. The allowable values are:
Value Description
L Dinglebar troll lingcod fishery
S Salmon fishery

2.2.9.7 Species
The species element is required. It must match the species specified for the IFQ Permit on the IFQ permit worksheet.
2.2.9.8 Ifq_item
At least one ifq_item element is required.
2.2.9.8.1 Item_number
The item_number element should not be specified in the import file. It is used to manage updates to reports after they have been submitted, and will be automatically generated at the time the report is initially submitted.
2.2.9.8.2 Stat_area
The stat_area element is required. It must match a stat area on the stat area worksheet, or on a line item. For halibut and sablefish, it must match the stat area specified on other items for the same IFQ report.
2.2.9.8.3 Iphc_regulatory_area
The iphc_regulatory_area element is not required for IFQ crab or sablefish. It is required for IFQ halibut. It must match the stat area specified on other items for the same IFQ report.
2.2.9.8.4 Condition_code
The condition_code element is required. It must match the condition code on a line item.
2.2.9.8.5 Ice_and_slime
The ice_and_slime element is not required. It may not be specified for IFQ crab. It will be optional for IFQ halibut and sablefish. The values of this element are true and false.
2.2.9.8.6 Price
The price element is required for IFQ crab. It will not be specified for IFQ halibut and sablefish. Price should be the weighted average price of the prices input on product items.
2.2.9.8.7 Sold_weight
The sold_weight element is not required. However, at least one of sold weight, retained weight, or deadloss weight must be specified. It is an integer weight value, no decimal places included.
2.2.9.8.8 Retained_weight
The retained_weight element is not required. However, at least one of sold weight, retained weight, or deadloss weight must be specified. It is an integer weight value, no decimal places included
2.2.9.8.9 Deadloss_weight
The deadloss_weight element is not required. However, at least one of sold weight, retained weight, or deadloss weight must be specified. Deadloss weight cannot be provided for IFQ halibut and sablefish. It is an integer weight value, no decimal places included
2.2.10 Coded_comment
The coded_comment element should not be specified in the import file. provides definitions for all XML documents used in the eLandings system. These include documents used by agency personnel, and documents used by the software internally. Only a subset of the XML document definitions are needed to interface an external system with eLandings.

The eLandings XML schema definition is contained in a number of files. The schema is partitioned so that systems that need only particular element definitions do not have to deal with elements that are not needed for their operations. The W3C XML schema allows schema definition files to include other files. The eLandings XML schema makes use of include statements.

The eLandings XML schema definition files are:

• datatypes.xsd - the data elements that are definitions of atomic data types. That is, the elements that are made from raw data types, and cannot be broken down further. Examples are the landing report id data element, and the weight data element. They contain data, but not structure. Atomic data elements may have attributes. For example, the condition code data element is a simple number containing the code, such as 1. The condition code data element has a attribute for _name-, which contains the name of the condition.
• dateelements.xsd - commonly used data elements that hold groups of individual elements, and that are used in multiple types of reports. For example, the cfec_permit data element, that is made up of the fishery, permit number, and year sequence. The data_elements may have both required and optional elements. While the XML schema defines elements as optional, the eLandings business rules determine when elements are required for particular reports.
• landingreport.xsd - the landing report data element definitions.
• productionreport.xsd - the production report data element definitions.
• logbook.xsd - the electronic logbook data element definitions.
• codes.xsd - the code table definitions for encoded data such as species codes, statistical area codes, condition codes, etc.

The eLandings system includes other XSD files that provide data element definitions that are used internally. Interfacing systems do not need these data elements.

The current and previous versions of the schema files are available online from the eLandings system support website.

XML Definitions for Interfacing Systems

The XML elements that are needed for system interfaces are:

The landing_report XML definition defines landing report data files that are extracted from eLandings and imported to another system. It is also used for files that are prepared by an external system and submitted to eLandings. Elements of the landing_report document and their usage are defined on the Landing Report Data page.

The landing_report_info XML definition defines the data returned when searching for landing reports. It contains the landing report IDs, which can then be used to retrieve the landing report documents.

The production_report XML definition defines production report data files that are extracted from eLandings and imported to another system. It also applies to files that are prepared by an external system and submitted to eLandings. Elements of the production_report document and their usage are defined on the Production Report Data page.

The production_report_info XML definition defines the data returned when searching for production reports. It contains the production report IDs, which can then be used to retrieve the production report documents. It is also used when getting information about electronic logbooks.

The number_info XML definition defines files that contain importable landing report, production report, and fish ticket numbers. These numbers must be obtained from the eLandings system before a report can be prepared for input to eLandings from an external system. Elements of the number_info document and their usage are defined on the Numbers Data page.

The processor_user_info XML definition defines files that contain the user authentication information needed when submitting landing or production reports to eLandings by email. Elements of the processor_user_info document and their usage are defined on the User Data page.

The logbook_report XML definition defines electronic logbook data files.

The daily_reporting XML definition defines Daily Reports, Trip Reports and Logobok Profile Reports