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

Production_item

The production_item element is used on both at-sea and shoreside reports, but may not be present if the value of the no_production flag is true.

  • The production_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 production item is deleted.
  2. Fmp_area
    The fmp_area element contains the Federal Management Plan area for the line. For at-sea reports the Federal area reported in the header must be in the FMP area reported for each production item.
  3. 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.
  4. 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

  5. Product_code
    The product_code element is always present. It is the numeric condition code indicating the physical state of the catch in terms of what processing was done to it. The condition code is used to determine the product recovery rate to apply to the production item weight to derive the round weigh of the catch documented on the production item.
  6. Weight
    The weight element is This element is the scale weight for the production item. The weight may include up to 4 decimal places, and will be less than 100 million. For at-sea production reports, the weight is reported in metric tons. For shoreside production reports, the weight is reported in pounds.
  7. Line Item Comment
    The line item comment present in specific situations. If the product code for the production 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. See the elandings online documentation for codes and valid combinations.
    1. Comment_code
      The comment_code element is the code for the comment.
    2. Comment_test
      The text information for the comment, if any was entered.
  8. Line_Item_stat_area
    The line_item_stat_area element is used internally by the eLandings system, and will not be present in exported or imported files.

Discard_item

The discard_item element is used on at-sea production reports to document discards. It will not be present on shoreside reports.

  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. Species
    The species element is always present. It is the ADF&G numeric species code, and it indicates the species of the discard documented on the discard item.
    The species element includes one attribute, the species name.
  3. Disposition_code
    The disposition_code element will always be present. It identifies the discard disposition of the discard item, such as discarded at sea or donated to a food bank. The valid disposition code values are available on the eLandings web application.
  4. Weight
    The weight element is may be present for discard items, but may be omitted on discard items where only a count is documented. This element is the scale weight in pounds for the discard item. The weight may include up to 4 decimal places, and will be less than 100 million.
  5. Count
    The count element is the number of animals accounted for on that line item. For discard lines count will always be present if weight is omitted.
  6. Line_Item_stat_area
    The line_item_stat_area element is used internally by eLandings, and will not be present in exported production reports.

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.

Mra_trip

The mra_trip element contains summary data on species and weights on production reports for the same vessel. The summary data is useful for determining when maximum retainable amount limits have been reached. This element will only be present on at-sea reports exported from eLandings. It should not be specified for import files.

  1. Mra_trip
    The mra_trip element contains the summaries for the current trip. The mra_trip element has 4 attributes.
    • start_date - the start date of the trip.
    • end_date - the end date of the trip.
    • trip_event_code - the code indicating the event that caused the start of a new trip.
    • trip_event_desc - the description of the event that caused the start of a new trip.
    1. Mra_species
      The mra_species element specifies the species. An mra_trip element may have many mra_species.
      The mra_species element has 6 attributes
      • species_code - the numeric species code, as was entered in the production items.
      • species_name - the species name
      • product_code - the numeric product code, as was entered in the production items
      • product_name - the product code description
      • total_weight - the total of the weights as entered, for the trip, for the species
      • total_round_weight - the total weight converted to round weight.
      1. Mra_prod_report
        The mra_prod_report element summaries the individual production reports for the trip. An mra_species may have many mra_prod_reports.
        The mra_prod_report element has 7 attributes.
        • report_id - the production report id
        • report_date - the report date of the production report
        • round_weight - the round weight of the species for the production report
        • trip_event_code - the trip event code reported on the production report. If no trip event was reported this attribute will be omitted.
        • trip_event_desc - the trip event description for the trip event reported on the production report. If no trip event was reported this attribute will be omitted.
        • management_program - the management program reported on the production report.
        • management_program_id - the management program participant id reported on the production report, if one was reported.
        1. Weight
          The weight element contains the total weight of the species for the production report documented by the mra_prod_report.
  • No labels