Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

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.

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.

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.

Type of Landing Report

The type of landing report distinguishes between Crab, with a type of "C", groundfish, with a type of "G", and Salmon, with a type of "B".

Status

The status element contains the submission status of the landing report. Values are:

Status

Meaning

0

Not submitted

4

Initial report submitted

8

Final report submitted

16

Report voided

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

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.

  1. Vessel
    The vessel element is the vessel ADF&G number.
    • The vessel element includes a name attribute, which contains the name of the vessel
  2. Crew_size
    The crew_size element is the number of crew onboard, including the skipper, but excluding any observers.
  3. Observers_onboard
    The observers_onboard element is the number of observers onboard the vessel for the trip.
  4. Port_of_landing
    The port_of_landing element is the ADF&G port code, as entered on fish tickets.
    The port_of_landing element includes two attributes.
    • the name attribute contains the text name of the port or at-sea operation type
    • 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.
  5. Delivery_port_region
    The port and region for IFQ crab deliveries.
  6. Gear
    The gear element is the ADF&G gear code, as entered on fish tickets.
    • then gear element includes a name attribute, which contains the name of the gear type.
  7. 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.
    • The proc_code element includes a processor attribute, which contains the name of the processor, as listed on their intent to operate permit.
  8. Proc_code_processor
    The proc_code_processor element identifies the custom processor, if there is one. This element is used only if custom processing is taking place.
    • Proc_code
      The proc_code element is the ADF&G intent to operate processor code, also known as the F-code.
  9. Date_fishing_began
    The date_fishing_began element is the date the gear went in the water. It cannot be after date_of_landing
  10. Days_fished
    The days_fished element is the number of days the vessel was actually fishing. It is not required for IFQ crab landings or for groundfish. It will be required for some fisheries.
  11. Date_of_landing
    The date_of_landing element is the date the offload completes. the date_of_landing is actually the date and time of landing. Time of landing is only used in salmon fisheries, but the element's definition requires the time component. For non-salmon landings, or salmon landings where time of landing is not captured, the time component should be set to the eLandings default value, 12:00:01. This tells the eLandings system that time should not be displayed for the landing report. When providing time for salmon landing reports, the resolution of time is in minutes. The seconds portion of time should always be 00. The 01 seconds of the default value is the indication that time should be ignored.
  12. Partial_delivery
    The partial_delivery element is a flag indicating if the landing report is for a partial delivery or not. In cases where a catcher vessel makes partial deliveries the partial delivery flag should be set to true for all of the landing reports for that trip. The last_delivery_for_trip flag would be set to false for all the deliveries except the last one.
  13. Last_delivery_for_trip
    The last_delivery_for_trip element is a flag indicating if the landing is the last for the trip, or if other deliveries, and hence landing reports can be expected. The partial_delivery flag and last delivery for trip flag are related. For rationalized crab deliveries at least one of these two flags must be set to true. For landings where no partial delivery is made the last_delivery_for_trip flag should be set to true.
  14. Multiple_ifq_permits
    The multiple_ifq_permits element provides historic compatibility with fish tickets.
  15. 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.
  16. Nearest_bay_or_headland
    The nearest_bay_or_headland element provides a text description of the area fished. It is not used for IFQ crab or groundfish, but is used for salmon.
  17. Federal_processor_number
    The federal_processor_number is the federal_processor_permit number for the processor submitting the report.
  18. Registered_buyer_number
    The registered_buyer_number is required for IFQ halibut and sablefish. This element may be provided even when not required.
  19. 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.
  20. Discard_report
    The discard_report element is not required for IFQ crab or salmon. It is required for groundfish. The values for discard_report are:

    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.
  21. 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.
  22. chill_type
    The chill_type element is used to indicate the refrigeration method used aboard the catcher vessel. The values for chill_type are:

    Value

    Description

    CSW

    Circulating seawater

    FAS

    Frozen at sea

    ICE

    Ice

    LIV

    Fish were delivered or pumped live

    RSW

    Refrigerated seawater

    SLH

    Slush ice

  23. 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.
  24. 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.
  25. Agency_header_data
    The agency_header_data element is used internally by the eLandings system. It should not be specified in submission files, and will not be seen in extract files.
  26. 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.
    1. Item_number
      The item_number element is used to uniquely identify a permit and its itemized catch, and to manage updates to reports after they have been submitted. It is automatically generated at the time the report is initially submitted, and should not be specified on unsubmitted reports.
    2. 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.
      • 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.
      • 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.
    3. 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.
    4. 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 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. For salmon, the management program is LE, for Limited Entry.
      • Program_id
        The program_id element is participant identifier, 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 is not required.
    5. Percent
      The percent element is is used by the eLandings system when allocating line items to stacked permits. If the XML file specifies a fish ticket number for each line item, then no allocation is needed and percent will not be used. However, if the file does not already allocate the line items to the CFEC permits then the percent field can be used 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.
    6. 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.
    7. Fish_ticket_sequence
      The fish_ticket_sequence element is the internal batch sequence for the fish ticket. It will not generally be seen on XML files, and should never be specified.
    8. Batch Year
      The batch_year element is the internal batch year for the fish ticket. It will not generally be seen on XML files, and should never be specified.
    9. Batch Office Code
      The batch_office code element is the internal office code of the office that data enters the the fish ticket receipt data. It will not generally be seen on XML files, and should never be specified.
    10. Batch_number
      The batch_number element is the internal batch identifier for the fish ticket. It will not generally be seen on XML files, and should never be specified.
    11. 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 used to uniquely identify an IFQ permit worksheet item, and to manage updates to reports after they have been submitted. It is automatically generated at the time the report is initially submitted, and should not be specified on unsubmitted reports.
      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 must 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.
      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. 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.
      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.
  27. 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.
    1. Item_number
      The item_number element is used to uniquely identify a stat area line, and to manage updates to reports after they have been submitted. It is automatically generated at the time the report is initially submitted, and should not be specified on unsubmitted reports.
    2. Stat_area
      The stat_area element is required. This is the ADF&G groundfish statistical area.
    3. Percent
      The percent element is required. The total of percents for all stat_area_worksheet elements must equal 100.
    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 is not allowed.
    5. Count
      The count element is not used on landing reports.
  28. Dual_permit
    The
  29. Tender_trip_number
    The
  30. Total_tare
    The
  31. Fishing_period
    The
  32. Out_of_state
    The
  33. Tender_batch
    The
  34. Tally_invoice
    The
  35. Floating
    The
  36. Slide
    The

Line_item

At least one line_item element is required.

  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. 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.
  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.
  4. Species
    The species element is required. It is the ADF&G numeric species code.
  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.
  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.
  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

  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.
  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.
  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.
  11. Agency_line_data
    The agency_line_data element should not be specified in the import file.
  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.
    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. 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.
    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.
    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.
    5. Tare
      The tare element is the weight of the brailer or tote. This data element is not filled in on landing reports.
    6. 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.
    7. Price
      The price element is required. The price can have up to 3 decimal places.
  13. Line_Item_stat_area
    The agency_line_data element should not be specified in the import file.
  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.
    1. Comment_code
      The code for the comment.
    2. Comment_test
      The text if needed.

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.

  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. 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.
  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.
  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.
  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.
  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 troll fishery

  7. Species
    The species element is required. It must match the species specified for the IFQ Permit on the IFQ permit worksheet.
  8. Ifq_item
    At least one ifq_item element is required.
    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. 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.
    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.
    4. Condition_code
      The condition_code element is required. It must match the condition code on a line item.
    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.
    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.
    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.
    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
    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

Coded_comment

The coded_comment element should not be specified in the import file.

  • No labels