Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Production_report

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

...

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 to be imported into eLandings. It will be omitted from reports that are successfully exported from eLandingssuccessfully exported from eLandings. The messages element may contain any number of message elements.

Data Type

Since Schema Version

Oracle Database Data Definition

Values

text

1.0

N/A

The message text can be of arbitrary length, and can include data values that caused the problem to be reported. Typically the text length will not exceed 265 characters.

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.

...

  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.

...

  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. If The only current use is if the product code for the production item is 97, the comment code for the line item comment will must 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.Comment_test
      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.

...

  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.

...