Page Comparison

When using the email submission feature, a user data file must be included in the email zip file attachment. The user data file format is defined in the XML schemaThe processor_user_info XML document is returned when authenticating to the eLandings web services. It has the following elements.

Messages

The messages element provides error and information messages about requests that are submitted to the eLandings server. It will be omitted from user data XML that is returned from a successful authentication call to 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.

Processor_user

The processor_user element contains data about the user that has been authenticated.

1. userid

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(32)	Userid identifies users of the system. Rules for userids are documented by the eLandings business rules

2. password

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(16)	Password provides users with an authentication token to use when identifying themselves to the system. Rules for passwords are documented by the eLandings business rules. In addition, the password cannot be the same as the userid.

3. user_name

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(32)	User name is the name the user provided during registration.]

4. company

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(50)	Company is the name the user provided during registration.]

5. parent_company

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(32)	Parent company is the name the user provided during registration, but is not required.]

6. phone

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(32)	Phone is the phone number the user provided during registration. Rules for phone numbers are documented by the eLandings business rules

7. fax

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(32)	Fax is the fax phone number the user provided during registration. Rules for fax phone numbers are documented by the eLandings business rules

8. email

   Data Type	Since Schema Version	Oracle Database Data Definition	Values
   text	1.0	VARCHAR2(120)	Email is the email address the user provided during registration.

9. proc_code
   The proc_code element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
10. federal_processor_number
    The federal_processor_number element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
11. registered_crab_receiver
    The registered_crab_receiver element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
12. default_operation_id
13. security_question
    The security_question element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
14. secret_answer
    The secret_answer element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
15. disabled

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    boolean	1.0	CHAR(1)	Disabled indicates whether or not the user is able to login. Value will be TRUE or FALSE.

16. limited

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    boolean	1.0	CHAR(1)	Limited indicates whether the user has access to all reports for their operation, or only those that they have created. Value will be TRUE or FALSE.

17. city

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    text	1.0	VARCHAR2(50)	City is the city name the user provided during registration.

18. state

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    text	1.0	CHAR(2)	State is the state abbreviation the user provided during registration.

19. num_decimals_for_weight

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of decimals for weight is the number of decimal places that will be displayed for weight values when the user views them on eLandings. Weights with less than the specified number of decimal places will be displayed with zeros. Weights with more than the specified number of decimal places will be displayed with the actual significant digits.

20. num_decimals_for_price

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of decimals for price is the number of decimal places that will be displayed for pricet values when the user views them on eLandings. Prices with less than the specified number of decimal places will be displayed with zeros. Prices with more than the specified number of decimal places will be displayed with the actual significant digits.

21. num_cfec_permit_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of CFEC permit lines is the number of lines that will be displayed for data entry of CFEC permits on the eLandings web application.

22. num_ifq_permit_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of IFQ permit lines is the number of lines that will be displayed for data entry of IFQ permits on the eLandings web application.

23. num_stat_area_ws_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of Statistical Area worksheet lines is the number of lines that will be displayed for data entry of statistical areas on the eLandings web application.

24. num_itemized_catch_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of itemized catch lines is the number of lines that will be displayed for data entry of itemized catch on the eLandings web application.

25. num_grading_pricing_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of grading pricing lines is the number of lines that will be displayed for data entry of size, grade, and price information on the eLandings web application.

26. num_prod_report_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of prod report lines is the number of lines that will be displayed for data entry of production information on the eLandings web application.

27. num_discard_lines

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(2,0)	Number of discard lines is the number of lines that will be displayed for data entry of production report discard items on the eLandings web application.

28. authorized_operation
    1. operation
       1. type_of_operation

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	VARCHAR2(16)	The type of operation identifies the operation characteristics. Values are: AS - At-sea Processor BE - Buyer-Exporter BS - Buying Station CP - Custom Processing Owner CS - Catcher Seller PL - Plant/Reciever TN - Tender

       2. operation_name

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	VARCHAR2(50)	Operation name is the name of the operation as provided when registered.

       3. description
          The description element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
       4. proc_code

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	VARCHAR2(6)	Proc code owner is the processor code of the processor who is buying the catch.

       5. federal_processor_number

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          integer	1.0	NUMBER(6,0)	Federal Processor Number is the Federal Processing Permit or Federal Fisheries Permit of the receiving processor.

       6. registered_buyer_number

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          integer	1.0	NUMBER(6,0)	Registered Buyer Number is the groundfish IFQ registered buyer number of the receiving processor.

       7. registered_crab_receiver
          1. registered_crab_receiver_number

             Data Type	Since Schema Version	Oracle Database Data Definition	Values
             integer	1.0	NUMBER(6,0)	Registered Crab Receiver Number is the crab IFQ registered receiver number of the receiving processor.

          2. ipq_permit
             1. ipq_permit_number

                Data Type	Since Schema Version	Oracle Database Data Definition	Values
                integer	1.0	NUMBER(6,0)	IPQ Permit Number is the Individual Processing Quota permit number associated with the registered crab receiver number.

             2. species

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

       8. port_of_landing

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	CHAR(3)	Port of landing is the eLandings port code. Valid values can be looked up on the eLandings website

       9. vessel

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          integer	1.0	NUMBER(5,0)	Vessel is the ADF&G Number of the vessel for tender and at-sea operations. Vessel ADF&G numbers can be looked up on the CFEC website

       10. license_number

           Data Type	Since Schema Version	Oracle Database Data Definition	Values
           integer	1.0	NUMBER(6,0)	License Number is the vehicle license plate number associated with a buying station operation.

       11. primary_userid

           Data Type	Since Schema Version	Oracle Database Data Definition	Values
           text	1.0	VARCHAR2(32)	Primary userid identifies the lead administrative user for the operation. Rules for userids are documented by the eLandings business rules

       12. parent_operation_codes
           1. type_of_operation

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              text	1.0	VARCHAR2(16)	The type of operation identifies the operation characteristics. Values are: AS - At-sea Processor BE - Buyer-Exporter BS - Buying Station CP - Custom Processing Owner CS - Catcher Seller PL - Plant/Reciever TN - Tender

           2. proc_code

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              text	1.0	VARCHAR2(6)	Proc code is the processor code of the parent operation, where the processing will take place.

           3. federal_processor_number

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              integer	1.0	NUMBER(6,0)	Federal Processor Number is the Federal Processing Permit or Federal Fisheries Permit of the parent operation.

           4. registered_buyer_number

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              integer	1.0	NUMBER(6,0)	Registered Buyer Number is the groundfish IFQ registered buyer number of the parent operation.

           5. registered_crab_receiver

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              integer	1.0	NUMBER(6,0)	Registered Crab Receiver Number is the crab IFQ registered receiver number of the parent operation.

       13. disabled

           Data Type	Since Schema Version	Oracle Database Data Definition	Values
           boolean	1.0	CHAR(1)	Disabled indicates whether or not the operation can create and submit new reports. Value will be TRUE or FALSE.

       14. size_grade_template
           1. species

              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

           2. condition_code

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

           3. show_price

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              boolean	1.0	CHAR(1)	Show price indicates whether or not the price on the template should be shown on landing reports. Value will be TRUE or FALSE.

           4. disabled

              Data Type	Since Schema Version	Oracle Database Data Definition	Values
              boolean	1.0	CHAR(1)	Disabled indicates whether or not the template should be displayed for new reports. Value will be TRUE or FALSE.

           5. product_item_template
              1. product_code

                 Data Type	Since Schema Version	Oracle Database Data Definition	Values
                 integer	1.0	NUMBER(3,0)	Product code is the condition code of the sold product. Valid values can be looked up on the eLandings website

              2. product_type

                 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

              3. size_grade

                 Data Type	Since Schema Version	Oracle Database Data Definition	Values
                 text	1.0	VARCHAR2(16)	The size and grade is the processor's short description of the size and or grading. It can be up to 16 characters long.

              4. price

                 Data Type	Since Schema Version	Oracle Database Data Definition	Values
                 decimal	1.0	NUMBER(6,4)	Price is the price per pound, and will between -100.00 and 100.00. Negative prices are allowed for some situations where processors charge fees for handling of certain items.

              5. user_defined_alias

                 Data Type	Since Schema Version	Oracle Database Data Definition	Values
                 text	1.0	VARCHAR2(10)	The user defined alias is a name that the user can optionally assign to a size and grade template.

    2. limited

       Data Type	Since Schema Version	Oracle Database Data Definition	Values
       boolean	1.0	CHAR(1)	Limited indicates whether or not the user should be able to access all reports for the operation, or only reports that they created. Value will be TRUE or FALSE.

    3. admin

       Data Type	Since Schema Version	Oracle Database Data Definition	Values
       boolean	1.0	CHAR(1)	Admin indicates whether or not the user is an administrator for the operation. Value will be TRUE or FALSE.

    4. disabled

       Data Type	Since Schema Version	Oracle Database Data Definition	Values
       boolean	1.0	CHAR(1)	Disabled indicates whether or not the user's privileges for the operation are disabled. Value will be TRUE or FALSE.

29. printed_document
    1. document_name

       Data Type	Since Schema Version	Oracle Database Data Definition	Values
       text	1.0	VARCHAR2(60)	The name of the fish ticket document format definition.

    2. printed_copy
       1. color

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	VARCHAR2(16)	The background color of the fish ticket copy.

       2. label

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          text	1.0	VARCHAR2(32)	The label of the fish ticket copy.

       3. background

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          boolean	1.0	CHAR(1)	Background indicates whether or not the background of the PDF should be rendered in the color for the copy. Value will be TRUE or FALSE.

       4. block

          Data Type	Since Schema Version	Oracle Database Data Definition	Values
          boolean	1.0	CHAR(1)	Block indicates whether or not the area of the Fish Ticket PDF where the CFEC permit card is imprinted should be rendered in the color for the copy. Value will be TRUE or FALSE.

30. final_report_visibility
    The final_report_visibility element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
31. schema_change_notify

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    boolean	1.1	CHAR(1)	Schema Change Notify indicates whether or not the user should receive email when the schema version on eLandings is changed. Value will be TRUE or FALSE.

32. schema_version

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    decimal	1.1	NUMBER(5,2)	Schema version is the version of XML documents that the user wants to received when clicking on web links for XML in the eLandings web application.

33. failed_login_attempts

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    integer	1.0	NUMBER(6,0)	Failed login attempts is the number of authentication failures the user has received trying to login, since the last successful login.

34. last_login_date

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    dateTime	1.0	DATE	The date and time the user last tried to login.

35. last_successful_login_date

    Data Type	Since Schema Version	Oracle Database Data Definition	Values
    dateTime	1.0	DATE	The date and time the user last successfully logged in.