Page Comparison

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.

...

• Proc_code
  The proc_code element is required.

...

• Proc_code
  The proc_code 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

...

• 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.

...

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

...

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.

...

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.

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

Considerations for Using Web Service Methods

The eLandings public web services provide a means for seafood processor and third party systems to interface directly with the eLandings system. Landing and production reports can be imported and submitted directly, without requiring user action on the eLandings web application. Reports should be constructed according the the XML schema documentation. Both report IDs and fish ticket numbers must be specified. The report IDs and fish ticket numbers must be reserved on eLandings before they can be used. The getReportNumbers() page documents using the web service method to reserve and retrieve report and fish ticket numbers.