Production Report Data

Production_report

The production_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. The messages element may contain any number of message elements.

The message element has four attributes

• The msgid attribute provides a unique identifier for the message, which can be used to lookup further information on the eLandings website.

  Data Type	Since Schema Version	Oracle Database Data Definition	Values
  integer	1.0	NUMBER(10,0)	Msg IDs will typically be between 1000 and 99,999. Msg IDs can be looked up on the eLandings website

• The severity_code attribute identifies the severity of the message

  Data Type	Since Schema Version	Oracle Database Data Definition	Values
  text	1.0	N/A	The severity code values and translations are: S - System Error E - Error W - Warning I - Information

• The severity_desc attribute is the translation of the severity code.
• The prefix attribute is a message prefix that relates the message to particular lines or items in the XML document.

  Data Type	Since Schema Version	Oracle Database Data Definition	Values
  text	1.0	N/A	The prefix is not applicable to all messages. Where used it has values such as "Line x, Grading/pricing line y".

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.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   date	1.0	DATE	Date of the report, referring to the date when the production took place.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(6,0)	Federal Processor Number is the Federal Processing Permit for Shoreside Production Reports and At-Sea Production Reports for motherships, and the Federal Fisheries Permit for catcher/processors.

   The federal_processor_number element includes three attributes:
   • name - the name of the processing company, plant, or at-sea processing vessel

     Data Type	Since Schema Version	Oracle Database Data Definition	Values
     text	1.0	VARCHAR2(50)	Federal Processor Number Name is the name of the processor.

   • at_sea_proc - a boolean flag indicating the permit is a federal fisheries permit for an at-sea processor. This attribute is omitted from production reports exported from eLandings.
   • license_year - the most recent year for which the processor was licensed. This attribute is omitted from production 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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   boolean	1.0	CHAR(1)	No Deliveries indicates whether or not the operation received deliveries from catcher vessels on the date of the report. No Deliveries only applies to Shoreside production reports. Value will be TRUE or FALSE.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   boolean	1.0	CHAR(1)	No Production indicates whether or not the operation did production on the date of the report. No Production indicates that the lack of production items is because there was no data to report. Value will be TRUE or FALSE.

5. Vessel
   The vessel element is the vessel ADF&G number, for at-sea operations. It will not be present for shoreside reports.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(5,0)	Vessel is the ADF&G Number of the at-sea processing vessel. Vessel ADF&G numbers can be looked up on the CFEC website. Vessel applies to At-Sea production reports only.

   • The vessel element includes a name attribute, which contains the name of the vessel

     Data Type	Since Schema Version	Oracle Database Data Definition	Values
     text	1.0	VARCHAR2(50)	Vessel names can be looked up on the CFEC website, as above.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   1.0	integer	NUMBER(3,0)	Gear is the eLandings gear code. Valid values can be looked up on the eLandings website. Gear applies to At-Sea production reports only.

   • The gear element includes a name attribute, which contains the name of the gear type.

     Data Type	Since Schema Version	Oracle Database Data Definition	Values
     text	1.0	VARCHAR2(25)	Gear name is the description of the gear associated with the gear code. Values can be looked up on the eLandings website, as above.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(3,0)	Crew size is the size of the crew including the skipper, for at-sea processors. Crew Size applies to At-Sea production reports only. Rules for crew size are documented by the eLandings business rules

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	CHAR(3)	Port of landing is the eLandings port code for Shoreside production reports, or the at-sea operation type for At-Sea production reports. Valid values can be looked up on the eLandings website

   The port_of_landing element includes two attributes.
   • the name attribute contains the text name of the port or at-sea operation type

     Data Type	Since Schema Version	Oracle Database Data Definition	Values
     text	1.0	VARCHAR2(50)	Port of landing name is the city or location associated with the port code. Values can be looked up on the eLandings website, as above.

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

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(2,0)	Observers is the number of observers in the processing plant. Observers applies to Shoreside production reports only. Rules for observers onboard are documented by the eLandings business rules

10. Proc_code
    The proc_code element identifies the entity that purchases or otherwise controls the fish, and is equivalent to the proc code emprinted on paper fish tickets. It will only be present for shoreside production reports.

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    text	1.0	VARCHAR2(6)	Proc code is the ADF&G processor code of the processing plant for Shoreside production reports. It is not used on At-Sea 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.

      Data Type	Since Schema Version	Oracle Database Data Definition	Values
      text	1.0	VARCHAR2(50)	Proc code processor is the name of the processor.

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.

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(6,0)	Fed area is the Federal reporting area where the catch took place. Valid values can be looked up on the eLandings website

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.

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    text	1.0	VARCHAR2(5)	Valid special areas are: AISWW - Aleutian Islands State Waters West of 120W COBLZ - Opilio Crab Bycatch Limitation Zone RKCSA - Red King Crab Savings Area

13. 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.
    1. • Program
         The program element is the management program abbreviation such as IFQ, CDQ, AFA, or OA.

         Data Type	Since Schema Version	Oracle Database Data Definition	Values
         text	1.0	VARCHAR2(5)	The abbreviation of the management program under which the fishing took place. The valid values can be looked up on the eLandings website

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

         Data Type	Since Schema Version	Oracle Database Data Definition	Values
         integer	1.0	NUMBER(3,0)	The management program participant ID, for management programs that require participant IDs. The valid values can be looked up on the eLandings website

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

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.3	NUMBER(2,0)	Trip event code values are: 1 - New Week 2 - Gear Change 3 - Offloaded Product 4 - Directed Fishing Closure 5 - Enter SSL Protection Area 6 - Leave SSL Protection Area

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(6,0)	Stat area is the statistical area where the catch took place. Valid values can be looked up on the eLandings website

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.

  Data Type	Since Schema Version	Oracle Database Data Definition	Values
  decimal	1.1	NUMBER(13,4)	Round weight is the weight for the production or discard item, converted to round, or green weight according to the condition code. Values will be between 0 and 999,999,999.9999

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	VARCHAR2(5)	Federal Management Plan area. FMP Area only applies to Shoreside production reports. Values are: BSAI - Bering Sea and Aleutian Islands GOA - Gulf of Alaska

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(3,0)	Species is the numeric species code. Valid values can be looked up on the eLandings website

   The species element includes one attribute, the species name.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(60)	Species name is the name associated with the species code. Values can be looked up on the eLandings website, as above

4. Product_type
   The product_type element is required. It indicates where the sold item is a primary product or an ancillary product.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	CHAR(1)	Product type identifies whether the item is the main product produced from the fish, or is additional product. Valid values are: P - Primary A - Ancillary R - Reprocessed

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(3,0)	Product code is the condition of the fish regarding processing that has taken place. Valid values can be looked up on the eLandings website, as condition codes

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   decimal	1.0	NUMBER(13,4)	Weight is the scale weight of the production or discard item. It will be between 0 and 999,999,999.9999

7. Line Item Comment
   The line item comment present in specific situations. The only current use is if the product code for the production item is 97, the comment code for the line item comment must also be 97 and the comment text will contain a description of the condition of the fish.
   1. Comment_code
      The comment_code element is the code for the comment.

      Data Type	Since Schema Version	Oracle Database Data Definition	Values
      integer	1.0	NUMBER(2,0)	The only valid comment code is 97 - description of other condition

      The text information for the comment, if any was entered.

      Data Type	Since Schema Version	Oracle Database Data Definition	Values
      text	1.0	VARCHAR2(500)	The comment text is required for comment 97. It can be any text.

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(3,0)	Species is the numeric species code. Valid values can be looked up on the eLandings website

   The species element includes one attribute, the species name.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(60)	Species name is the name associated with the species code. Values can be looked up on the eLandings website, as above

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   integer	1.0	NUMBER(3,0)	Disposition code is the numeric code indicating the disposition of the discard item. Valid values can be looked up on the eLandings website

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   decimal	1.0	NUMBER(13,4)	Weight is the scale weight of the production or discard item. It will be between 0 and 999,999,999.9999

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.

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   decimal	1.0	NUMBER(13,4)	Count is the number of fish or animals documented by the discard item. It will be between 1 and 100,000,000.

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.