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

Production_report

The producxtion_report element is the top level element in production report files.

The production_report element has several attributes. They should not be specified when importing production reports to eLandings, but will be present for reports that are exported.

  • data_entry_user - the userid of the user who originally entered and submitted the production report.
  • data_entry_user_org - the data entry user's organization. This can be the seafood processor, or an agency if the production 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.

The production_report has the following elements.

Messages

The messages element provides error and information messages about reports that are submitted to the eLandings server. It should not be specified on reports that are to be imported into eLandings. 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.

Production_report_id

The production_report_id is the unique identifier for production reports. The actual number is generated by the eLandings system.

Type of Production Report

The type of production report distinguishes between At-sea, with a type of "A", and Shoreside, with a type of "S".

Status

The status element contains the submission status of the production report. Reports that are to be imported into eLandings should set the status to zero. Values are:

Status

Meaning

0

Not submitted

8

Final report submitted

16

Report voided

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

Transmission

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

Production_report_header

The production_report_header element contains the data that applies to the entire production report.

  1. Report_date
    The report_date element is the date of the production being reported.
  2. 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:
    • 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.
  3. No_deliveries
    The no_deliveries element is a flag indicating that no deliveries from catcher vessels were received on the date.
  4. No_production
    The no_production element is a flag indicating that no processing was done on the date. If the no_production element is set to "true" then the report will not have production_item elements.
  5. Vessel
    The vessel element is the vessel ADF&G number, for at-sea operations. It will not be present for shoreside reports.
    • The vessel element includes a name attribute, which contains the name of the vessel
  6. Gear
    The gear element is the ADF&G gear code, as entered on fish tickets. It will be present on at-sea reports, but will not be on shoreside reports.
    • then gear element includes a name attribute, which contains the name of the gear type.
  7. Crew_size
    The crew_size element is the number of crew onboard, including the skipper, but excluding any observers. It will only be present for at-sea production reports.
  8. Port_of_landing
    The port_of_landing element is the ADF&G port code, as entered on fish tickets. It will be present for at-sea production reports, and it will contain the port code value for the at-sea operation type, such as Catcher/Processor or floating inshore processor.
    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.
  9. Observers
    The observers element is the number of observers in the plant or onboard the vessel.
  10. Proc_code
    The proc_code element identifies the entity that purchases or otherwise controls the fish, and is equivalent to the proc code embossed on paper fish tickets. It will only be present for shoreside production reports.
    • The proc_code element includes a processor attribute, which contains the name of the processor, as listed on their intent to operate application.
  11. Fed_area
    The fed_area element contains the Federal reporting area number where the fish were harvested. It will only be present for at-sea production reports.
  12. Special_area
    The special_area element contains the special area code where the fish were harvested, if the harvest was within one of the special areas. It will only be present for at-sea production reports, and will only be present if the harvest took place within a special area.
    1. Management_program
      The management_program element identifies the management program under which the fishing took place. It will be present only for at-sea reports.
      • Program
        The program element is the management program abbreviation such as IFQ, CDQ, AFA, or OA.
      • 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 omitted.
  13. Trip_event_code
    The trip_event_code element indicates events that can occur on at-sea processor trips, which affect maximum retainable amounts. It will be present only for at-sea reports, and only if one of the events occurred on the date of the report.

Stat_area_worksheet

The stat_area_worksheet element will be present for at-sea reports, but not for shoreside reports.
More that one stat_area_worksheet elements may be specified.

  1. 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.
  2. Stat_area
    The stat_area element always present This is the ADF&G 6 digit groundfish statistical area.
  3. Percent
    The percent element will always be present. The total of percents for all stat_area_worksheet elements will equal 100.
  4. Effort
    The effort element is not used for production reports, and will always be omitted.
  5. Count
    The count element is not used on production reports, and will always be omitted.

Coded_comment

The coded_comment element is used for agency purposes. It will not appear in reports exported from eLandings, and should not be specified for reports that are to be imported to eLandings.

    • 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 application.
  2. 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.
  3. Date_fishing_began
    The date_fishing_began element is the date the gear went in the water.
  4. Days_fished
    The days_fished element is the number of days the vessel was actually fishing. This element may not be present.
  5. 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.
  6. Partial_delivery
    The partial_delivery element is a flag indicating whether the landing report was for a partial delivery or not.
  7. Last_delivery_for_trip
    The last_delivery_for_trip element is a flag indicating that the landing is the last for the trip.
  8. Multiple_ifq_permits
    The multiple_ifq_permits element provides historic compatibility with fish tickets.
  9. 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.
  10. 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.
  11. 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.
    • 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.
  12. 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.
    • 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.
  13. 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. 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

    The discard_report element includes a desc attribute, with the text value of the discard report code.
  14. 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.
    • The tender_vessel element includes a name attribute, which contains the name of the vessel.
  15. 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. 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

    The chill_type element includes a desc attribute, with the text value of the chill type code.
  16. 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.
  17. 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.
  18. 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.
  19. Agency_header_data
    The agency_header_data element is used internally by the eLandings system. It will not be seen in export files.
  20. 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.
    1. 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.
    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.
    1. 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.
    2. Fish_ticket_number
      The fish_ticket_number element contains the fish ticket number for the permit.
    3. 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.
    4. 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.
    5. 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.
    6. 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.
    7. 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.
      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.
  1. Dual_permit
    The dual_permit element is a boolean flag that indicates, two or more CFEC permit holder was present on the vessel when the fishing occurred. This flag may not be applicable in all fisheries and is subject to regulation. Legal use of this box is only available is specific areas. Check with your local ADF&G staff before using this box. This flag is typically used for Salmon. 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.
  2. Tender_trip_number
    The
  3. Total_tare
    The
  4. Fishing_period
    The
  5. Out_of_state
    The
  6. Tender_batch
    The
  7. Tally_invoice
    The
  8. Floating
    The
  9. Slide
    The

Line_item

At least one line_item element is required.

    • The line item element has one attribute, the round weight for the item.
  1. 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.
  2. 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.
  3. 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.
    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.
  4. 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.
    The species element includes one attribute, the species name.
  5. 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.
  6. 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, and will be less than 100 million.
  7. 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 The values will be:

    Value

    Description

    I/S

    Weight includes ice and slime

    Est

    Estimated weight

  8. 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.
  9. 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.
  10. 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. The valid disposition code values are available on the web application.
  11. Agency_line_data
    The agency_line_data element will be omitted from reports that are made visible to processors and third party systems.
  12. 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.
    1. 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.
    2. 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.
    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

    4. 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.
    5. 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.
    6. 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.
    7. Price
      The price element is required. The price can have up to 3 decimal places. In some cases the price will be zero.
  13. Line_Item_stat_area
    The line_item_stat_area element will not be present.
  • No labels