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 10 Next »

Landing and production reports can be generated by seafood processors' business systems and imported into eLandings, to reduce data entry effort. The eLandings system provides both web pages and fully automated web service methods to allow the import of reports. Report XML documents must be produced in accordance with the eLandings XML schema. The data elements required for landing reports are documented on Landing Report Data and those required for production reports are documented on Production Report Data.

The eLandings system provides two means of importing reports. The eLandings web application has a Report Import page that allows import of both landing and production reports. It can be reached by clicking on the "Import Report" menu link on the main Report Menu page. The eLandings system also provides web service methods that allow seafood processors' business systems to automatically import reports to eLandings. The web service methods are documented on Public+Web+Service+Documentation.

Attributes

When preparing an XML document for import, no attributes should be specified. Only data elements are read when the report is imported into eLandings. The attributes contain additional data that is associated with the element values in the eLandings database. The eLandings system populates the attributes with the associated data when it creates documents for users, but does not need to read attribute data when receiving reports.

Considerations for Using the Report Import Page

The Report Import page allows users to import landing and production reports, one at a time. Reports are imported in the unsubmitted status. Once the report has been successfully imported, users must review it and submit it. Imported landing reports must be initially submitted, and finally submitted, just like reports created directly in eLandings. Production reports do not have a distinction between initial submit and final submit, they just need to be submitted after they are imported. As a consequence, the XML document for reports does not have to specify the status element. If the status element is specified, it must have the unsubmitted status value.

The report id element should be omitted from the XML document. When the document is imported a new, unique, report ID will be generated and assigned to the report. When the report is displayed after importing the report ID can be read off of the web page. It can also be obtained by downloading the XML from eLandings, which can be done from the report display page that is displayed after a successful import.

The Report Import page has some flexibility in the use and assignment of fish ticket numbers on landing reports. The fish ticket numbers identify what parts of the harvest documented on the landing report are assigned to which CFEC permits. The fish ticket numbers can be handled in several ways.

  • If the landing report has only one CFEC permit, the fish ticket number can be omitted from the report. The eLandings system will generate a new fish ticket number for the report, and will populate it on the permit worksheet and line items.
  • If the landing report has more than one CFEC permit, but the line items are not allocated to the permits, then the fish ticket numbers can be omitted, and the eLandings system will fill them in on the permit worksheet. In this case, the user will need to use the Allocate Permits function on the eLandings web application to allocate the line items to permits.
  • Place holder fish ticket numbers can be assigned to the CFEC permits, and line items if desired. In this case, the eLandings system will replace each unique placeholder fish ticket number with a new, generated fish ticket number. The placeholder fish ticket numbers should start with a letter other than "I".
  • Importable fish ticket numbers can be obtained from the eLandings system prior to creating the report XML document. This allows the seafood processor's system to obtain the fish ticket number prior to the landing, and to use them as key data in their internal records. When importing the landing report, the eLandings system will recognize the fish ticket numbers as importable numbers, and will not replace them with newly generated ones. Importable fish ticket numbers always begin with the letter "I". Importable fish ticket numbers can be obtained using the Importable Numbers page. It is accessible from the Operation Information and User Maintenance page by clicking on the "Importable Fish Ticket Numbers" button.

Fish ticket numbers can be retrieved as importable numbers from Operation page, get importable numbers button.

When importing a landing or production report to eLandings, the XML document need not have every data item populated. Attributes should not be provided since they are populated by eLandings based on element data. For example, the species code element only needs its numeric code, such as "200". The name attribute should not be provided, eLandings knows that "200" is "Halibut". If attributes are entered they will be ignored. Therefore if you provide the species code as "200", and give the species_code name attribute as "Pollock" eLandings will identify the species as 200 Halibut. The species_code name will be ignored, and you will not get an error message that 200 does not equal Pollock.

The following identifies which elements are required, as well as ones that should not be populated.

Landing_report

The landing_report element is the top level element required in landing report import files. It contains the other data elements and is required.

Messages

The messages element should not be provided in import files.

Schema Version

The schema version data element should always be specified.

Landing_report_id

The landing_report_id is not required. If it is not present, a new landing report id will be generated. If the landing_report_id is specified, it must contain an importable landing report number received from eLandings.

Type of Landing Report

The type of landing report is required

Status

The status element should not be provided.

Transmission

The transmission element should not be provided.

Header

The header element is required.

  1. Vessel
    The vessel element is required.
  2. Crew_size
    The crew_size element is required
  3. Observers_onboard
    The observers_onboard element is required.
  4. Port_of_landing
    The port_of_landing element is required.
  5. Gear
    The gear element required.
  6. Proc_code_owner
    The proc_code_owner element is required.
    • Proc_code
      The proc_code element is required.
  7. Proc_code_processor
    The proc_code_processor element is not required, but should be provided if custom processing is taking place.
    • Proc_code
      The proc_code element is required.
  8. Date_fishing_began
    The date_fishing_began element is generally required, but may not be required for some fisheries
  9. Days_fished
    The days_fished element may be required for some fisheries.
  10. Date_of_landing
    The date_of_landing element is required.
  11. Partial_delivery
    The partial_delivery element is required.
  12. Last_delivery_for_trip
    The last_delivery_for_trip element is not required.
  13. Multiple_ifq_permits
    The multiple_ifq_permits element is not required.
  14. Manual_ifq_report
    The manual_ifq_report element should not be provided.
  15. Nearest_bay_or_headland
    The nearest_bay_or_headland element should be provided for salmon reports, but not for other types of reports
  16. Federal_processor_number
    The federal_processor_number is required for groundfish and IFQ landings. This element may be provided even when not required.
  17. Registered_buyer_number
    The registered_buyer_number is required for IFQ halibut and sablefish reports. This element may be provided even when not required.
  18. Registered_crab_receiver_number
    The registered_crab_receiver_number is required for IFQ crab. This element may be provided even when not required.
  19. Discard_report
    The discard_report element is required for groundfish landing reports.
  20. Tender_vessel
    The tender_vessel element should only be used for tender deliveries.
  21. Rsw_temp
    The rsw_temp element should only be specified if the tender_vessel element is specified and RSW was used.
  22. Buying_station_name
    The buying_station_name element is not required, but may be specified if a buying station takes the delivery.
  23. Agency_header_data
    The agency_header_data element should not be provided.
  24. Permit_worksheet
    At least one permit_worksheet element is required.
    1. Item_number
      The item_number element should not be provided
    2. Cfec_permit
      The cfec_permit element is required
      • Fishery
        The fishery element is required.
      • Permit_number
        The permit_number element is required
      • Year_seq
        The year_seq element is required
    3. Management_program
      The management_program element is required.
      • Program
        The program element is required.
      • Program_id
        The program_id element is required if the management program has participant numbers, such as CDQ and AFA.
    4. Percent
      The percent element is not required, but may be provided if you want to use eLandings to allocate harvest to permits.
    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. If the fish_ticket_number is an importable number obtained from eLandings it will not be replaced
    6. Fish_ticket_sequence
      The fish_ticket_sequence element should never be specified.
    7. Batch Year
      The batch_year element should never be specified.
    8. Batch Office Code
      The batch_office code element should never be specified.
    9. Batch_number
      The batch_number element should never be specified.
    10. Ifq_permit_worksheet
      The ifq_permit_worksheet element is not required, but may be specified.
      1. Item_number
        The item_number element should not be provided.
      2. Ifq_permit_number
        The ifq_permit_number element is required.
      3. Nmfs_person_id
        The nmfs_person_id element is required.
      4. Species
        The species element is required.
      5. Fishery_area
        The fishery_area element is not required, unless pounds is specified.
      6. Pounds
        The pounds element is not required, but may be specified to have eLandings allocate that number of pounds to the IFQ permit.
      7. Ipq_permit_number
        The ipq_permit_number is conditionally required for crab landings.
  25. Stat_area_worksheet
    The stat_area_worksheet element is not required.
    1. Item_number
      The item_number element should not be specified.
    2. Stat_area
      The stat_area element is required.
    3. Percent
      The percent element is required.
    4. Effort
      The effort element is required for IFQ crab. Otherwise it should not be specified.
    5. Count
      The count element should not be specified.

Line_item

At least one line_item element is required.

  1. Item_number
    The item_number element should not be specified.
  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 provided, the fish_ticket_number value must match one of the values specified on the permit worksheet.
  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.
  4. Species
    The species element is required.
  5. Condition_code
    The condition_code element is required.
  6. Weight
    The weight element is required.
  7. Weight_modifier
    The weight_modifier element is not required.
  8. Count
    The count element is required for IFQ crab and for salmon, but not for groundfish. It may be used for discards.
  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.
  11. Agency_line_data
    The agency_line_data element should not be specified.
  12. Product_item
    The product_item element may be provided for line items with sold dispositions. It is 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.
    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.
    4. Size_grade
      The size_grade element is not required.
    5. Weight
      The weight element is required.
    6. Price
      The price element is not required.
  13. Line_Item_stat_area
    The agency_line_data element should not be specified.
  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. In most cases the import files should not specify these dispositions, they should be edited in once the file is imported.

Ifq_report

The ifq_report element is not required.

  1. Item_number
    The item_number element should not be specified.
  2. Nmfs_person_id
    The nmfs_person_id element is required.
  3. Ifq_permit_number
    The ifq_permit_number element is required.
  4. Fish_ticket_number
    The fish_ticket_number element is required.
  5. Ipq_permit_number
    The ipq_permit_number element is conditionally required.
  6. Fishery
    The fishery element is not required.
  7. Species
    The species element is required.
  8. Ifq_item
    At least one ifq_item element is required.
    1. Item_number
      The item_number element should not be specified.
    2. Stat_area
      The stat_area element is required. .
    3. Iphc_regulatory_area
      The iphc_regulatory_area element is not required for IFQ crab or sablefish. It is required for IFQ halibut.
    4. Condition_code
      The condition_code element is required.
    5. Ice_and_slime
      The ice_and_slime element is not required. It should not be specified for IFQ crab.
    6. Price
      The price element is not required for IFQ crab. It should not be specified for IFQ halibut and sablefish.
    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.
    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.
    9. Deadloss_weight
      The deadloss_weight element is not required. Deadloss weight should not be provided for IFQ halibut and sablefish.

Coded_comment

The coded_comment element should not be specified.

Production_report

The production_report element is the top level element required in production report import files. It contains the other data elements and is required.

Messages

The messages element should not be provided in import files.

Schema Version

The schema version data element should always be specified.

Production_report_id

The production_report_id is not required. If it is not present, a new production report id will be generated. If the production_report_id is specified, it must contain an importable report number received from eLandings.

Type of Production Report

The type of production report is required. It can be "A" for at-sea production reports or "S" for shoreside production reports.

Status

The status element should not be provided.

Transmission

The transmission element should not be provided.

Production_report_header

The production_report_header element is required.

  1. Report_date
    The report_date element is required. Timezone information is not needed, and will be ignored.
  2. Federal_processor_number
    The federal_processor_number is required.
  3. No_deliveries
    The no_deliveries element is required. For shoreside production reports it should be set to true if there were no deliveries, false otherwise. For at-sea production reports it should always be set to false.
  4. No_production
    The no_production element is required. It should be set to true if there are no production items to report, otherwise it should be set to false.
  5. Vessel
    The vessel element is required for at-sea production reports. This is the ADF&G number of the processing vessel, whether it is a C/P or a mothership. The vessel element should not be specified on shoreside production reports.
  6. Gear
    The gear element required for at-sea production reports. This is the numeric gear code. The gear element should not be specified on shoreside production reports.
  7. Port_of_landing
    The port_of_landing element required for at-sea production reports. This is the at-sea operation type specified in the port code on fish tickets. The values are FCP, FLD, and IFP. The port_of_landing element should not be specified on shoreside production reports.
  8. Observers
    The observers element required for shoreside production reports. This is the number of observers in the plant. The observers element should not be specified on at-sea production reports.
  9. Proc_code
    The proc_code element required for shoreside production reports. This is the Intent to Operate, or F-code, of the plant. The proc_code element should not be specified on at-sea production reports.
  10. Fed_area
    The fed_area element required for at-sea production reports. This is the numeric federal area. The fed_area element should not be specified on shoreside production reports.
  11. Special_area
    The special_area is not required. It should only be specified on at-sea production reports if operating in one of the special areas. It should never be specified on shoreside production reports.
  12. Management_program
    The management_program element required for at-sea production reports. The management_program element should not be specified on shoreside production reports.
    1. Program
      The program element is required
    2. Program_id
      Some management programs, such as CDQ and AFA, issue IDs to participants. Other management programs such as Open Access(OA) and Limited Entry(LE) do not have IDs. It the management program specified in the program element issues IDs then the program_id element is required.
  13. Trip_event_code
    The trip_event_code is not required. It should only be specified on at-sea production reports if one of the reportable trip events occured. It should never be specified on shoreside production reports.

Stat_area_worksheet

The stat_area_worksheet element is required for at-sea production reports. The stat_area_worksheet element should not be specified on shoreside production reports.

  1. Item_number
    The item_number element should not be specified.
  2. Stat_area
    The stat_area element is required.
  3. Percent
    The percent element is required.
  4. Effort
    The effort element should not be specified.
  5. Count
    The count element should not be specified.

Production_item

At least one production_item element is required unless the no_production element is true.

  1. Item_number
    The item_number element should not be specified.
  2. Fmp_area
    The fmp_area element is required.
  3. Species
    The species element is required.
  4. Product_type
    The product_type element is required.
  5. Product_code
    The product_code element is required.
  6. Weight
    The weight element is required. For at-sea production reports the weight is specified in metric tons. For shoreside production reports the weight is specified in pounds
  7. Line Item Comment
    The line item comment is conditionally required. If the condition code for the production_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.
  8. Line_item_stat_area
    The line_item_stat_area element should not be specified.

Discard_item

The discard_item element should not be specified on shoreside production reports.
The discard_item element can be used for at-sea production reports if discards need to be documented.

  1. Item_number
    The item_number element should not be specified.
  2. Species
    The species element is required.
  3. Disposition_code
    The disposition_code element is required.
  4. Weight
    Either the weight element or the count item is required. Since discard items are only ued on at-sea production reports, the weight is specified in metric tons.
  5. Count
    Either the weight element or the count item is required. The count element specifies number of animals.
  6. Line_item_stat_area
    The line_item_stat_area element should not be specified.

Coded_comment

The coded_comment element should not be provided.

Mra_trip

The mra_trip element should not be provided.

  • No labels