Landing Report Data

Landing_report

The landing_report element is the top level element in landing report files.

The landing_report element has several attributes.

data_entry_user - the userid of the user who originally entered and submitted the landing report.
data_entry_user_org - the data entry user's organization. This can be the seafood processor, or an agency if the landing report was data entered by the agency.
data_entry_submit_date - the date and time the report was submitted.
last_change_user - the userid of the user who made the most recent edits to the report. This can be an agency user who edited agency data not visible to processors.
last_change_date - the date and time of the most recent edit.
no_change_after_date - the date and time after which processors cannot edit the report unless unlocked by an agency user.
catcher_processor - a flag that indicates at-sea processing activity. This attribute is used for agency purposes, and will typically be omitted.
operation - the id of the operation that the user selected to use for defaulting processor codes and permits. Changes to the landing report code and permit value may break the relationship, so the operation attribute will not always have a value.

The landing_report has the following elements.

Messages

The messages element provides error and information messages about reports that are submitted to the eLandings server. It will be omitted from reports that are successfully exported from eLandings. The messages element may contain any number of message elements.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	N/A	The message text can be of arbitrary length, and can include data values that caused the problem to be reported. Typically the text length will not exceed 265 characters.

The message element has four attributes

The msgid attribute provides a unique identifier for the message, which can be used to lookup further information on the eLandings website.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(10,0)	Msg IDs will typically be between 1000 and 99,999. Msg IDs can be looked up on the eLandings website

The severity_code attribute identifies the severity of the message

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.0

N/A

The severity code values and translations are:
S - System Error
E - Error
W - Warning
I - Information
The severity_desc attribute is the translation of the severity code.

The prefix attribute is a message prefix that relates the message to particular lines or items in the XML document.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	N/A	The prefix is not applicable to all messages. Where used it has values such as "Line x, Grading/pricing line y".

Schema Version

The schema version data element allows the software to know the version of the schema for which an XML file was generated. If the schema version element is not provided that indicates the version is 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.

Landing_report_id

The landing_report_id is the unique identifier for landing reports. The actual number is generated by the eLandings system.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(10,0)	Landing report IDs will be between 1 and 9,999,999,999

Type of Landing Report

The type of landing report distinguishes between the major fishery types. Different types of landing reports have different rules for some fields.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(1)	Valid Types of landing reports are: C - Crab G - Groundfish B - Salmon

The type of landing report element includes a name attribute, with the text value of the report type.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(50)	The names of landing report types are as above.

Status

The status element contains the submission status of the landing report.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(10,0)	Status values and meanings are: 0 - Not submitted 4 - Initial Report Submitted 8 - Final Report Submitted 16 - Report Voided

The status element includes a desc attribute, with the text value of the status code.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(25)	The names of status types are as above.

Transmission

The transmission element is used internally by the eLandings when reports are transmitted from the seaLandings Processor Workstation software to the server. It is omitted in files exported from eLandings.

Header

The header element contains the data that applies to the entire landing report.

Vessel
The vessel element is the vessel ADF&G number.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

integer

1.0

NUMBER(5,0)

Vessel is the ADF&G Number of the vessel. Vessel ADF&G numbers can be looked up on the CFEC website
- The vessel element includes a name attribute, which contains the name of the vessel
  
  Data Type
  
  Since Schema Version
  
  Oracle Database Data Definition
  
  Values
  
  text
  
  1.0
  
  VARCHAR2(50)
  
  Vessel names can be looked up on the CFEC website, as above.

Crew_size
The crew_size element is the number of crew onboard, including the skipper, but excluding any observers.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Crew size is the size of the crew including the skipper. Rules for crew size are documented by the eLandings business rules

Observers_onboard
The observers_onboard element is the number of observers onboard the vessel for the trip.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(2,0)	Observers onboard is the number of observers. Rules for observers onboard are documented by the eLandings business rules

Port_of_landing
The port_of_landing element is the ADF&G port code, as entered on fish tickets.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(3)	Port of landing is the eLandings port code. Valid values can be looked up on the eLandings website

The port_of_landing element includes two attributes.

the name attribute contains the text name of the port or at-sea operation type

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(50)	Port of landing name is the city or location associated with the port code. Values can be looked up on the eLandings website, as above.

the ifq_port_code contains the numeric IFQ system port code, as used on IFQ reports. The IFQ port code appears even on reports that do not include IFQ. It is merely an attribute of the alphabetic port code and its presence does not imply IFQ reporting.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	IFQ port code is the numeric code used on the IFQ system. It is associated with the eLandings port code, and can be looked up on the eLandings website. The IFQ port code appears on IFQ receipts.

Delivery_port_region
The port and region for IFQ crab deliveries.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.6	VARCHAR2(3)	The Delivery Port Region is the IFQ system port or region code used on some IFQ landings. Valid values can be looked up on the eLandings website

Gear
The gear element is the ADF&G gear code, as entered on fish tickets.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Gear is the eLandings gear code. Valid values can be looked up on the eLandings website

then gear element includes a name attribute, which contains the name of the gear type.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(25)	Gear name is the description of the gear associated with the gear code. Values can be looked up on the eLandings website, as above.

Proc_code_owner
The proc_code_owner element identifies the entity that purchases or otherwise controls the fish, and is equivalent to the proc code embossed on paper fish tickets.
- Proc_code
  The proc_code element is the ADF&G intent to operate processor code, also known as the F-code.
  
  Data Type
  
  Since Schema Version
  
  Oracle Database Data Definition
  
  Values
  
  text
  
  1.0
  
  VARCHAR2(6)
  
  Proc code owner is the processor code of the processor who is buying the catch.
  - The proc_code element includes a processor attribute, which contains the name of the processor, as listed on their intent to operate application.
    
    Data Type
    
    Since Schema Version
    
    Oracle Database Data Definition
    
    Values
    
    text
    
    1.0
    
    VARCHAR2(50)
    
    Proc code owner processor is the name of the processor who is buying the catch.

Proc_code_processor
The proc_code_processor element identifies the custom processor, if there was one. This element is present only if custom processing took place.

Proc_code
The proc_code element is the ADF&G intent to operate processor code, also known as the F-code.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(6)	Proc code processor is the processor code of the processor who is receiving and the catch, in cases of custom processing.

The proc_code element includes a processor attribute, which contains the name of the processor, as listed on their intent to operate application.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(50)	Proc code processor processor is the name of the processor who is receiving and the catch, in cases of custom processing.

Date_fishing_began
The date_fishing_began element is the date the gear went in the water.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

date

1.0

DATE

Date fishing began is the date that the gear first went in the water.

Days_fished
The days_fished element is the number of days the vessel was actually fishing. For salmon troll it is the number of days between the date fishing began and the date fishing ended, whether or not the boat was actually fishing on all of those dates. This element may not be present.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Days fished is the number of days between the date fishing began and the date of landing when gear was in the water and fishing was taking place. The business rules for days fished are on the eLandings website

Date_of_landing
The date_of_landing element is the date the offload completed. The date_of_landing actually a date and time. Time of landing is only used in salmon fisheries, but the element's definition requires the time component always be present. For non-salmon landings, or salmon landings where time of landing is not captured, the time component will be set to the eLandings default value, 12:00:01. When provided time for salmon landing reports, the resolution of time is in minutes. The seconds portion of time will always be 00. The 01 seconds of the default value is the indication that time should be ignored.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

dateTime

1.0

DATE

Date of landing is the date upon which the offload from the catcher vessel was completed.

Partial_delivery
The partial_delivery element is a flag indicating whether the landing report was for a partial delivery or not.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.0	CHAR(1)	Partial Delivery indicates whether or not the delivery was for all fish caught on the trip. Value will be TRUE or FALSE.

Last_delivery_for_trip
The last_delivery_for_trip element is a flag indicating that the landing is the last for the trip.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.0	CHAR(1)	Last Delivery For Trip indicates whether or not the vessel completed offloading all fish onboard with the current delivery. Value will be TRUE or FALSE.

Multiple_ifq_permits
The multiple_ifq_permits element provides historic compatibility with fish tickets.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.0	CHAR(1)	Multiple IFQ Permits indicates whether or not the skipper and crew had more than one IFQ permit under which they did the fishing. Value will be TRUE or FALSE.

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 will be included in the landing report XML file.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.0	CHAR(1)	Manual IFQ Report indicates whether or not an IFQ report for the landing was made manually by phone to the NMFS Data Technicians. Value will be TRUE or FALSE.

Nearest_bay_or_headland
The nearest_bay_or_headland element contains a text description of the area fished. It is not used for IFQ crab or groundfish, but is used for salmon.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(50)	The nearest bay or headland is a text description of the geographic location where the fishing took place. The business rules for nearest bay or headland are on the eLandings website

Federal_processor_number
The federal_processor_number is the federal_processor_permit number for the processor who submitted the report. It is typically omitted from salmon reports. The federal_processor_number element includes three attributes:

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(6,0)	Federal Processor Number is the Federal Processing Permit or Federal Fisheries Permit of the receiving processor.

name - the name of the processing company, plant, or at-sea processing vessel
at_sea_proc - a boolean flag indicating the permit is a federal fisheries permit for an at-sea processor. This attribute is omitted from landing reports exported from eLandings.
license_year - the most recent year for which the processor was licensed. This attribute is omitted from landing reports exported from eLandings.

Registered_buyer_number
The registered_buyer_number the buyer identification for IFQ halibut and sablefish. It is typically omitted from salmon reports. This element includes two attributes.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

integer

1.0

NUMBER(6,0)

Registered Buyer Number is the groundfish IFQ registered buyer number of the receiving processor.
- name - the name of the processing company, plant, or at-sea processing vessel
- license_year - the most recent year for which the buyer was licensed. This attribute is omitted from landing reports exported from eLandings.

Registered_crab_receiver_number
The registered_crab_receiver_number identifies the receiver for IFQ crab. It is the RCR number issued by NMFS. This element will be omitted for groundfish and salmon landings. This element includes two attributes.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(6,0)	Registered Crab Receiver Number is the crab IFQ registered receiver number of the receiving processor.

name - the name of the processing company, plant, or at-sea processing vessel
license_year - the most recent year for which the buyer was licensed. This attribute is omitted from landing reports exported from eLandings.

Discard_report
The discard_report element indicated that the processor either did or did not receive the discard report blue sheets from the fisherman. It is required for groundfish, but will be omitted for salmon and crab reports.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(2)	Discard Report indicates the whether discard report blue sheets were received by the processor, or the reason they were not received. Values are: RC - Received NC - Not Received NP - Not Required, vessel not federally permitted NL - Not Required, vessel less than 60 feet

The discard_report element includes a desc attribute, with the text value of the discard report code.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(50)	The description associated with the discard report code, values as above.

Tender_vessel
The tender_vessel element contains the ADF&G number of the tender that took the delivery that generated the landing report. It is omitted for non-tender deliveries.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.1	NUMBER(5,0)	Tender Vessel is the ADF&G Number of the tender. Vessel ADF&G numbers can be looked up on the CFEC website

The tender_vessel element includes a name attribute, which contains the name of the vessel.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.1

VARCHAR2(50)

The name of the tender. Names can be looked up on the CFEC website, as above.

chill_type
The chill_type element is used to indicate the refrigeration method used aboard the catcher vessel for salmon reports. It is omitted for non-salmon landings.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.4

VARCHAR2(3)

The fish hold chilling system type. Valid chill types are documented on the eLandings website

The chill_type element includes a desc attribute, with the text value of the chill type code.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.4

VARCHAR2(60)

The description of the chilling system type identified by the chill type.

Rsw_temp
The rsw_temp element is used to record the temperature of the fish or the chill system aboard the catcher vessel. The term rsw temp is a misnomer, the actual chill type is specified in the chill_type element and does not have to be RSW. The rsw_temp element can repeat up to 3 times, to allow for storage of sample data on unsubmitted reports. However, when the landing report is submitted the temperatures are averaged, and only one temperature is stored and returned on landing reports exported from eLandings. Rsw_temp is omitted if the report does not include chill_type.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
decimal	1.4	NUMBER(3,1)	The temperature of the fish, as maintained by the chilling system, whether Refrigerated SeaWater or another type. Business rules for the temperature are on the eLandings website

Dock_delivery
The dock_delivery element is a boolean flag that indicates if a tender delivery took place at a tender tied up at the processing plant dock. It is omitted for landings that are not dock deliveries.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.4	CHAR(1)	Dock Delivery indicates whether or not delivery was made to a tender vessel tied up at the processing plant dock. Value will be TRUE or FALSE.

Buying_station_name
The buying_station_name element contains the operation name if the operation that submitted the report is a buying station operation, and can be so identified from the permit numbers and processor codes on the landing report. In some cases the operation cannot be determined, so this element may not be present even if the originating operation was a buying station. If the originating operation was not a buying station this element will be omitted.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.0

VARCHAR2(60)

The operation name of a buying station operation. It can be up to 60 characters long.
Agency_header_data
The agency_header_data element is used internally by the eLandings system. It will not be seen in export files.

Permit_worksheet
At least one permit_worksheet element will be present in landing report files exported from eLandings. Each permit worksheet element allows a CFEC permit to be specified, so multiple worksheet items indicate permit stacking.

Item_number
The item_number element is just the sequential permit item number for the report. However, item numbers may have a break in their sequence if a report is submitted, and then a permit item is deleted.

Cfec_permit
The cfec_permit element is the entire CFEC permit information needed to identify the permit.

Fishery
The fishery element is the fishery code on the CFEC permit card.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.0

VARCHAR2(6)

The CFEC permit fishery for the permit. CFEC permits can be looked up on the CFEC website

Permit_number
The permit_number element is is the unique permit number on the CFEC card. It is a five digit number followed by one alphabetic check character.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(6)	The permit number portion of the CFEC permit, including check character, for a total length of 6 characters.

Year_seq
The year_seq element is 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.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(5)	The two digit year and the two digit sequence within the year of the permit card. The year sequence includes a check character, for a total length of 5 characters.

The permit has two attributes. The holder is the name of the permit holder.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(60)	The name of the permit holder, which can be up to 60 characters long

The serial number is the CFEC unique identifier for the permit holder.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(9,0)	The CFEC file number, or serial number, that uniquely identifies the permit holder.

Mag_stripe_read
The mag_stripe_read element identifies identifies whether the CFEC permit date was read into the eLandings system by swiping the magnetic stripe on the CFEC permit card.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.4	CHAR(1)	Mag Stripe Read indicates whether or not the CFEC card was read by a magnetic stripe reader. Value will be TRUE or FALSE.

Management_program
The management_program element identifies the management program under which the fishing took place.

Program
The program element is the management program abbreviation such as IFQ, CDQ, AFA, or OA.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(5)	The abbreviation of the management program under which the fishing took place. The valid values can be looked up on the eLandings website

Program_id
The program_id element is participant identifier. It will be present if the management program has participant IDs. CDQ numbers for CDQ and Co-op numbers for AFA, are examples of program ids. If the management program has no participant numbers, such as ADAK, then this element will be omited.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	The management program participant ID, for management programs that require participant IDs. The valid values can be looked up on the eLandings website

Percent
The percent element is is used by the eLandings system when allocating line items to stacked permits. The percents on the permit worksheet elements will add up to 100. Percent may be specified as zero.

Fish_ticket_number
The fish_ticket_number element contains the fish ticket number for the permit.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(10)	Fish Ticket Number is the ticket number that associates particular catch lines with particular permits on the landing report. The business rules for the fish ticket number format are on the eLandings website	.

Fish_ticket_sequence
The fish_ticket_sequence element is the internal agency batch sequence for the fish ticket. It will be omitted for XML files seen by processors and third party systems.
Batch Year
The batch_year element is the internal agency batch year for the fish ticket. It will be omitted for XML files seen by processors and third party systems.
Batch Office Code
The batch_office code element is the internal agency office code of the office that data enters the the fish ticket receipt data. It will be omitted for XML files seen by processors and third party systems.
Batch_number
The batch_number element is the internal agency batch identifier for the fish ticket. It will be omitted for XML files seen by processors and third party systems.
Ifq_permit_worksheet
The ifq_permit_worksheet element is used for IFQ permit information. Multiple ifq_permit_worksheet elements may be provided for each CFEC permit, allowing multiple IFQ permits to be stacked on each CFEC permit.
1. Item_number
  The item_number element is just the sequential item number for the ifq permit. However, item numbers may have a break in their sequence if a report is submitted, and then an ifq permit item is deleted.
2. Ifq_permit_number
  The ifq_permit_number element is the IFQ system permit identfier.
3. Nmfs_person_id
  The nmfs_person_id element is the 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 will be the same for all ifq_permit_worksheet elements associated with a single CFEC permit.
4. Species
  The species element is the ADF&G species code associated with the permit.
  
  Data Type
  
  Since Schema Version
  
  Oracle Database Data Definition
  
  Values
  
  integer
  
  1.0
  
  NUMBER(3,0)
  
  Species is the numeric species code. Valid values can be looked up on the eLandings website
5. Fishery_area
  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.
6. Pounds
  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.
7. Ipq_permit_number
  The ipq_permit_number is conditionally required for crab landings. It will not be present for groundfish landings. If the IFQ permit is a class A permit, then an IPQ number will be present. The IPQ permit will be associated with the RCR number specified in the header.

Stat_area_worksheet
The stat_area_worksheet element is not always present. If it is not provided then each line item will have a stat_area specified.
More that one stat_area_worksheet elements may be specified.

Item_number
he item_number element is just the sequential item number for the stat area worksheet item. However, item numbers may have a break in their sequence if a report is submitted, and then a stat area worksheet item is deleted.

Stat_area
The stat_area element always present This is the ADF&G statistical area. For groundfish and crab it will be the 6 digit groundfish statistical area. For salmon it will be the 5 digit salmon statistical area.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(6,0)	Stat area is the statistical area where the catch took place. Valid values can be looked up on the eLandings website

Percent
The percent element will always be present. The total of percents for all stat_area_worksheet elements will equal 100.
Effort
The effort element will be present for IFQ crab. It is the number of pot lifts in the associated statistical area. For groundfish, this element is omitted.
Count
The count element is not used on landing reports, and will always be omitted.

Dual_permit
The dual_permit element is a boolean flag that when true indicates that two or more CFEC permit holders were present on the vessel when the fishing occurred. This flag is typically used for Salmon. This flag may not be applicable in all fisheries and is subject to regulation. The presence of multiple permits on the fish ticket increases fishing limits. When dual permit is used, only one CFEC permit is recorded on the fish ticket.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	1.4	CHAR(1)	Dual permit indicates whether two or more permit holders were aboard the catcher vessel, allowing additional gear to be deployed. Value will be TRUE or FALSE.

Tender_trip_number
The tender trip number is an optional element. This element was added for use in the Tender Trip Management page in the eLandings web site. The Tender Trip Management page was created to allow processors to manage salmon landings delivered by tender and summaries these landings within an Excel workbook. Processors can use the Tender Trip Management web page to assign a tender trip number to a list of landing reports. The Tender Trip Management page allows processors to export all the landings of a given tender trip number to a worksheet in an Excel workbook. In this way many trips can be appended to a workbook as individual worksheets. The tender trip number and the Tender Trip Management web page together serve as a stopgap measure for processors who managing their fish tickets in excel workbooks, or are moving from Excel to a more full featured third-party management toolset.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

2.3

VARCHAR2(10)

A processor assigned tender batch number. It can be up to ten characters in length.
Total_tare
The fishing period element is an optional field. This element is used in Bristol Bay Salmon fisheries with mixed salmon landings. Due to the rapid execution of these fisheries, in some cases Bristol Bay area managers allow processors to report initial fish tickets containing unsorted or mixed salmon. As a result these tickets have a single line item and single grading and pricing item of mixed salmon.
Tare weight is the weight of the container holding the item during the weighing process. In weighing fish, we would subtract the tare weight from the total weight to get the actual weight of the fish.
It is not uncommon for vessels in Bristol Bay to use a standard bags, brailer, or tote to while weighing the fish. As a result the tare weight of the bag, brailer or tote can easily be calculated ahead of time and reused for all fish weightings.
Some tenders find it faster to weight all of the fish to get a total weight including tare. The tenders count the number of uniform totes and multiply this by the know weight of a these standard totes to get the total tare. The tender can then subtract the ¿total tare¿ from the ¿total weight including tare¿ to arrive at the ¿total weight of the fish¿.
The total_tare field in the landing report xml is used as a place holder value in the tLandings system. Upon submission to the eLandings database, tLandings Processor Tender Interface (PTI) runs the calculation to calculate the ¿total weight of the fish¿ on the ticket and discards the ¿total_tare¿ value. Once the total_tare has been applied it is not reversible to its original state. Total_tare is not stored in the eLandings database.
Fishing_period
The fishing period element is an optional field. This element is primarily used in Salmon fisheries.
A fishing period is a two digit number used by some ADFG fisheries area managers to identify a commercial fishery opener. Harvest may or may not have occurred during the opener, dependent upon weather and processor/buyer availability.
In some fisheries, such as herring, there may be multiple periods within a day. Periods are sequential and increase incrementally through the last opening of the season, but harvest records may not be associated with some openers. The first annual opening of the season begins with # 01.
Out_of_state
The out of state element is a Boolean flag used for internal use only. It is provided to the International Pacific Halibut Commission (IPHC) at their request. The IPHC uses this field to indicate that the IPCH data entered the landing report data in outside the state of Alaska. All other users should ignore this field.
Tender_batch
The tender batch element is optional and can hold a six character alpha-numeric value. This element is primarily used in Salmon fisheries. Processors using the tLandings Processor Tender Interface (PTI) and insert (or submit) a list or batch of salmon fish tickets, delivered by a tender, to the eLandings database. At the time of insertion (or submission), the processor user can create an arbitrary name to be associated with all of the landing reports included in this insertion. Later, the user can query the eLandings database for tickets based on the user defined tender batch number to make further mass edits. Specifically, processors use this field to prepare a list of tickets to apply mixed salmon updates to.
Tally_invoice
The tally invoice element is optional and can hold a six character alpha-numeric value. This element is primarily used in Salmon fisheries. Processors may request that tenders data enter the pre-printed tally invoice number assigned to tally sheets and dock slips which was used by the tender to record the landing weights. This element was provided at the request of processors to help processors audit landings by connecting the paper tally sheet on deck or at the dock to an electronic ticket.

Floating
The floating element is an optional Boolean flag that when true indicates that fish were floating freely in the haul. Fish can be crushed, bruised or improperly refrigerated when they are packed so tightly into the hold that they cannot float freely. This element was provided at the request of processors to help them track fish quality.This element is primarily used in Salmon fisheries.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	2.3	CHAR(1)	Floating indicates whether or not salmon were floating in a tank when unloaded to a tender. Value will be TRUE or FALSE.

Slide
The slide element is an optional Boolean flag that when true indicates that a fish slide was used to load fish into the hold. A fish slide is used to protect fish meat from bruising. This element was provided at the request of processors to help them track fish quality. This element is primarily used in Salmon fisheries.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
boolean	2.3	CHAR(1)	Slide indicates whether or not salmon were unloaded to a tender using a slide. Value will be TRUE or FALSE.

Line_item

At least one line_item element is required.

The line item element has one attribute, the round weight for the item.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
decimal	1.1	NUMBER(13,4)	Round weight is the weight for the catch, converted to round, or green weight according to the condition code. Values will be between 0 and 999,999,999.9999

Item_number
The item_number element is just the sequential item number for the report. However, item numbers may have a break in their sequence if a report is submitted, and then a line item is deleted.

Fish_ticket_number
The fish_ticket_number element contains the fish ticket for the line. It will match one of the fish ticket numbers specified on the permit worksheet.
It indicates the relationship between the CFEC permit and the catch, which is documented on the printed fish ticket.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(10)	Fish Ticket Number is the ticket number that associates particular catch lines with particular permits on the landing report. The business rules for the fish ticket number format are on the eLandings website	.

Stat_area
The stat_area element indicates the statistical area for the catch documented on the line item. The stat_are element is not required. If it is not present then the statistical areas for the catch documented on the line item are specified by the stat area worksheet. The percentages on the stat area worksheet indicate the allocation of the catch weight to statistical areas.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(6,0)	Stat area is the statistical area where the catch took place. Valid values can be looked up on the eLandings website

The stat_area element has four attributes.

#** fed_area - The Federal Reporting Area where the statistical area lies.
- fed_area_2 - If the statistical area crosses a federal reporting area boundary, the fed_area_2 attribute will be present, containing the second Federal Reporting Area. Otherwise, it will be omitted.
- iphc_area - The IPHC Regulatory Area where the statistical area lies.
- iphc_area_2 - If the statistical area crosses an IPHC area boundary, the iphc_area_2 attribute will be present, containing the second IPHC Regulatory Area. Otherwise, it will be omitted.

Species
The species element is always present. It is the ADF&G numeric species code, and it indicates the species of the catch documented on the line item.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Species is the numeric species code. Valid values can be looked up on the eLandings website

The species element includes one attribute, the species name.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(60)	Species name is the name associated with the species code. Values can be looked up on the eLandings website, as above

Condition_code
The condition_code element is always present. It is the numeric condition code indicating the physical state of the catch in terms of processing already done to it. The condition code is used to determine the product recovery rate to apply to the line item weight to derive the round weigh of the catch documented on the line item.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Condition code is the condition of the fish regarding any processing that has already taken place. Valid values can be looked up on the eLandings website

The condition code has a name attribute.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(60)	Condition code name is the description associated with the condition code. Values can be looked up on the eLandings website, as above.

Weight
The weight element is always present for sold items, and is usually present, except for discard items where only a count is documented. This element is the scale weight in pounds for the line item, unless the weight_modifier element indicates it is estimated weight. The weight may include up to 4 decimal places.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

decimal

1.0

NUMBER(13,4)

Weight is the scale weight of the catch item. It will be between 0 and 999,999,999.9999

Weight_modifier
The weight_modifier element is not always present. It is primarily used on groundfish IFQ landing reports to document whether Ice and Slime is included in the weight. The Ice and Slime value can only be used for halibut and sablefish. The estimated value is used for hailed weight fish tickets, and should not be seen for line items on submitted reports.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(10)	The weight modifier indicates considerations that apply to the weight of the catch item. Valid values are: I/S - ice and slime are include, for the purposes of IFQ reporting EST - Weight is estimated, rather than true scale weight.

Count
The count element is always present for IFQ crab sold items and salmon, is generally not populated for groundfish. The count element is the number of animals accounted for on that line item. For discard lines on groundfish reports count will be present if weight is omitted.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
decimal	1.0	NUMBER(13,4)	Count is the number of fish or animals documented by the catch item. It will be between 1 and 100,000,000.

Effort
The effort element is used for IFQ crab. This is the number of pot lifts. Effort will not be present for groundfish or salmon reports. Effort on crab landing reports may not be present if the line item does not have a statistical area noted. In that case the effort is documented on the statistical area worksheet.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
decimal	1.0	NUMBER(5,0)	Effort is the effort, in units appropriate to the gear, that produced the catch item. Values will be between 1 and 10,000.

Disposition_code
The disposition_code element will always be present. It identifies the final usage or action of the line item, such as sold for human consumption or discarded at sea. ||Data Type||Since Schema Version||Oracle Database Data Definition||Values||

integer

1.0

NUMBER(3,0)

Disposition code is the numeric code indicating the disposition of the catch item. Valid values can be looked up on the eLandings website

The disposition code has a name attribute.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(60)	Disposition Code Name is the description associated with the disposition code. Values can be looked up on the eLandings website, as above.

Agency_line_data
The agency_line_data element will be omitted from reports that are made visible to processors and third party systems.

Product_item
The product_item element may be present for line items that have sold dispositions, and in certain other cases. 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 will be present. In that case, if the disposition of the line item is not a sold disposition then the product_item will not have a price.

Item_number
The item_number element is just the sequential item number for the product items under the line item. However, item numbers may have a break in their sequence if a report is submitted, and then a product item is deleted.

Product_code
The product_code element will always be present. 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. In general, salmon product items have the same product code as their line item, but it could be different if the processor wishes to price by a particular condition that is different than the delivery condition. For IFQ crab the product code must always be the same as the line item condition code.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(3,0)	Product code is the condition code of the sold product. Valid values can be looked up on the eLandings website

The product code element has one attribute, the name.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(60)	The product code name is the description associated with the product code. Values can be looked up on the eLandings website, as above.

Product_type
The product_type element is required. It indicates where the sold item is a primary product or an ancillary product.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	CHAR(1)	Product type identifies whether the item is the main product produced from the fish, or is additional product. Valid values are: P - Primary A - Ancillary

Size_grade
The size_grade element will not always be present. This is an optional field that allows processors to list sizing and grading information on the product items. It is freeform text. Processors are free to price product items without providing size/grade information.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
text	1.0	VARCHAR2(16)	The size and grade is the processor's short description of the size and or grading. It can be up to 16 characters long.

Tare
The tare element is not populated on landing reports extracted from eLandings. Tare is the weight of the brailer or tote. This data element is used by the tLandings subsystem, but is not filled in on landing reports.
Weight
The weight element will always be present. This is the weight of the sold item. The total of the weights of all the product items for a line item will not be more that the weight of the line item, but could be less if the product codes are not the same as the product code on the line item.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

decimal

1.0

NUMBER(13,4)

The sold weight will be between 0 and 999,999,999.9999

Price
The price element is required. The price can have up to 3 decimal places. In some cases the price will be zero.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
decimal	1.0	NUMBER(6,4)	Price is the price per pound, and will between -100.00 and 100.00. Negative prices are allowed for some situations where processors charge fees for handling of certain items.

Line_Item_stat_area
The line_item_stat_area element will not be present.

Line Item Comment
The line item comment present in specific situations. If the condition code for the line item is 97, the comment code for the line item comment will also be 97 and the comment text will contain a description of the condition of the fish. Disposition codes of 62 for overages and 64 for tagged fish also indicate that a comment should be expected. See the elandings online documentation for codes and valid combinations.

Comment_code
The comment_code element is the code for the comment.

Data Type	Since Schema Version	Oracle Database Data Definition	Values
integer	1.0	NUMBER(2,0)	The comment codes are dependent on condition and disposition codes on the line item. The business rules for comments are on the eLandings website

Comment_test
The text information for the comment, if any was entered.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.0

VARCHAR2(500)

The comment text is required for some comment codes, as detailed in the business rules above.

Ifq_report

The ifq_report element may be present for landing reports for IFQ species. The ifq_report element will be present only if the IFQ report was submitted through the eLandings system. IFQ reports that were made to the NMFS data clerks will not appear in the landing report XML file.

The IFQ Report elements contain data that is derived from other elements in the header data, permit worksheets, and line items. Data element definitions will be the same as for those elements, although in some cases simplified. For example, weights on the ifq reports are integer rather than decimal data, but contain the same information.

The ifq_report element has ten attributes. The attributes will be populated if the IFQ report was submitted. If the report was not submitted, the attributes for this element, and many of the attributes for other elements will not be populated. Submitted reports will have a return_code of "000" or "001"

- return_msg - the text of the message associated with the return code
- return_code - the return code for the submission of the the IFQ report
- card_holder - the name of the IFQ cardholder, as identified by the NMFS person ID on the report.
- permit_holder - the name of the IFQ permit holder. This may be the same as the card holder, or may be different in the case of hired skippers.
- tran_date_time - the date and time the IFQ report was submitted.
- tran_number - the transaction confirmation number of the IFQ report
- net_ifq_weight - the weight debited from the IFQ permit
- net_ipq_weight - the weight debited from the IPQ permit, if one was entered.
- class_code - the class code for the IFQ report.
- sector_code - the sector code for the IFQ report.

Item_number
The item_number element indicate the report in sequence.
Nmfs_person_id
The nmfs_person_id element identifies the individual who did the fishing. The nmfs_person_id has one attribute, the person name
Ifq_permit_number
The ifq_permit_number element identifies the IFQ permit that was debited for the report. The ifq_permit_number includes two attributes.
- name - the name of the permit holder
- permit_class - the permit class for crab IFQ. This element is omitted for Halibut and Sablefish IFQ.
Fish_ticket_number
The fish_ticket_number element associates the IFQ report with a specific fish ticket, and hence a CFEC permit.
Ipq_permit_number
The ipq_permit_number element indicates the IPQ permit that will be debited. It will only be present on crab reports, and then only if the IFQ permit is a class A permit. For Halibut and Sablefish IFQ reports it will always be omitted.
Fishery
The fishery element is never present for IFQ crab or sablefish reports. For IFQ halibut it specifies a fishery type if the halibut was harvested as bycatch in another fishery. In most cases it will be omitted since this is a rare condition. The values are:

Value

Description

L

Dinglebar troll lingcod fishery

S

Salmon troll fishery
Species
The species element will always be present. It contains the species code.
The species element includes one attribute, the species name.
Ifq_item
At least one ifq_item element will always be present, but more than one ifq_item may occur. The ifq_item element has one attribute, the ifq_fishery which is the name of the fishery and/or area.
1. Item_number
  The item_number element indicates the item in sequence.
2. Stat_area
  The stat_area element will always be present.
  The stat_area element has four attributes.
  - fed_area - The Federal Reporting Area where the statistical area lies.
  - fed_area_2 - If the statistical area crosses a federal reporting area boundary, the fed_area_2 attribute will be present, containing the second Federal Reporting Area. Otherwise, it will be omitted.
  - iphc_area - The IPHC Regulatory Area where the statistical area lies. The iphc_area element will be omitted from crab IFQ items.
  - iphc_area_2 - If the statistical area crosses an IPHC area boundary, the iphc_area_2 attribute will be present, containing the second IPHC Regulatory Area. Otherwise, it will be omitted.
3. Iphc_regulatory_area
  The iphc_regulatory_area element will not be present for IFQ crab or sablefish. It will always be present for IFQ halibut. It indicates the IPHC area for which quota was debited.
4. Condition_code
  The condition_code element will always be present.
  - The condition_code element has one attribute, the name describing the condition identified by the code.
5. Ice_and_slime
  The ice_and_slime element is used for IFQ halibut and sablefish IFQ items.
6. Price
  The price element is used only with IFQ crab. It will be omitted from IFQ halibut and sablefish reports.
7. Sold_weight
  The sold_weight element indicates the weight sold on the IFQ report.At least one of sold weight, retained weight, or deadloss weight will be present on IFQ items. If the item has no sold weight this element will be omitted
8. Retained_weight
  The retained_weight element indicates the weight retained by the fisherman for future sale or personal use. If the item has no retained weight this element will be omitted.
9. Deadloss_weight
  The deadloss_weight element indicates the deadloss for crab deliveries. It will never be present for halibut and sablefish IFQ reports. It a crab IFQ item has no deadloss this element will be omitted.

Coded_comment

The top level coded_comment element in landing reports is for agency use only. It will not be present in landing report XML files exported from eLandings.