FUEL-FACS+ Host Interface Specification FBS Version 5.1 K-860296-REF-8-R02 Notice All procedures, data, information, drawings, specifications or other material, whether accompanying this document or separately supplied in furtherance of this document, contain confidential and proprietary information which (i) is the property of CSI, (ii) is disclosed by CSI only in confidence, and (iii) except as CSI may otherwise permit in writing, is to be used, disclosed or copied only to the extent necessary for the evaluation and use thereof by the recipient. The foregoing shall not apply to any such material to the extent that the contents (i) are now or subsequently become available to the public without payment, (ii) were previously known to the recipient, or (iii) subsequently become otherwise known to the recipient without restriction. This document is based on information available at the time of its publication. While efforts have been made to be accurate, the information contained herein does not purport to cover all details or variations in hardware and software, nor to provide for every possible contingency in connection with installation, operation and maintenance. The information contained in this document is subject to change, without notice, at any time and should not be used as a specification for any CSI product nor for any particular CSI project. CSI makes no representation or warranty, either expressed or implied, with respect to, and assumes no responsibility for, the accuracy, completeness, or sufficiency of the information contained herein. No warranties of merchantability or fitness for a particular purpose shall apply. This document takes precedence over and supersedes in their entirety all previous versions or revisions. VXL, UCOS, FUEL-FACS, FUEL-FACS+, and CompresXpress are registered marks. The CSI logo, the UCOS logo, the FUEL-FACS+ logo, the FUEL-FACS+ net logo, the CompresXpress logo, and the eRCMXpress logo are trademarks. eRCM is a trademark of ACI Services, Inc. UCOS U.S. Pat. 5,812,394. All other product and company names/logos mentioned in this document are trademarks and/or registered trademarks of their respective holders. Copyright © 2016. All Rights Reserved. FMC Technologies, 8040 Nieman Road, Lenexa, KS 66214-1523 USA Telephone: 913-214-4300 Facsimile: 913-599-5013 http://www.fmctechnologies.com/AutomationControl.aspx csi-mktg@fmcti.com CSI Document No. K-860296-REF-8-R02 CSI Form No. K-9906-DOT-1-MKTG-23031999-MJK FUEL-FACS+ Host Interface Specification, FBS Version 5.1 ii Contents 1 Overview ...................................................................... 11 1.1 Purpose .................................................................................................................. 11 1.2 Revision History .................................................................................................... 11 2 Outgoing Transactions............................................... 12 2.1 Outgoing Transaction Format .............................................................................. 12 2.1.1 Outgoing Host Types ......................................................................................................................... 12 2.1.2 Outgoing Transaction Number ........................................................................................................... 12 2.1.3 Outgoing Transaction ID .................................................................................................................... 13 2.1.4 Outgoing Record ID ........................................................................................................................... 13 2.1.5 Outgoing Data Stream ....................................................................................................................... 13 2.2 Outgoing Transaction Sequences ....................................................................... 14 2.3 Order Transaction Sequence (01) ........................................................................ 15 2.3.1 Order Header Record (01) ................................................................................................................. 16 2.3.2 Order Compartment Header Record (11) .......................................................................................... 19 2.3.3 Order Compartment Detail Record (02)............................................................................................. 19 2.3.4 Order Recipe Record (03).................................................................................................................. 22 2.3.5 Order Allocation Header Record (07) ................................................................................................ 24 2.3.6 Order Allocation Detail Record (08) ................................................................................................... 24 2.3.7 Order Dispatch Header Record (09) .................................................................................................. 24 2.3.8 Order Dispatch Detail Record (10) .................................................................................................... 24 2.4 Order Exchange Transaction Sequence (01) ...................................................... 26 2.4.1 Exchange Header Record (05) .......................................................................................................... 27 2.4.2 Exchange Product Record (06) ......................................................................................................... 27 iii FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Contents 2.5 Bulk Movement Transaction Sequence (03) ....................................................... 29 2.5.1 Bulk Movement Header Record (01) ................................................................................................. 30 2.5.1.1 Bulk Movement Types .................................................................................................................... 31 2.5.2 Bulk Movement Planned Header Record (04) ................................................................................... 31 2.5.3 Bulk Movement Planned Detail Record (07)...................................................................................... 32 2.5.4 Bulk Movement Product Header Record (05) .................................................................................... 33 2.5.5 Bulk Movement Product Detail Record (02) ...................................................................................... 34 2.5.6 Bulk Movement Batch Detail Header Record (06) ............................................................................. 35 2.5.7 Batch Detail Record (03).................................................................................................................... 36 2.6 Memo Inventory Transaction Sequence (04) ...................................................... 37 2.6.1 Memo Inventory Header Record (01) ................................................................................................ 37 2.6.2 Memo Inventory Tank Record (02) .................................................................................................... 37 2.7 End-of-Day Marker Transaction Sequence (05) ................................................... 39 2.7.1 EOD Marker Header Record (01) ...................................................................................................... 40 2.7.2 EOD Book Inventory Header Record (02) ......................................................................................... 40 2.7.3 EOD Supplier Record (03) ................................................................................................................. 41 2.7.4 EOD Product Record (04) .................................................................................................................. 41 2.7.5 EOD Product Tank Record (11) ......................................................................................................... 42 2.7.6 EOD Tank Gain/Loss Header Record (05) ........................................................................................ 42 2.7.7 EOD Tank Gain/Loss Record (06) ..................................................................................................... 43 2.7.8 EOD Meter Totalizer Header Record (07) ......................................................................................... 43 2.7.9 EOD Meter Record (08) ..................................................................................................................... 44 2.7.10 EOD Injector Totalizer Header Record (09) .................................................................................... 44 2.7.11 EOD Injector Record (10) ................................................................................................................ 44 2.8 End-of-Month Marker Transaction Sequence (06) .............................................. 45 2.8.1 EOM Marker Header Record (01)...................................................................................................... 46 2.8.2 EOM Book Inventory Header Record (02) ......................................................................................... 46 2.8.3 EOM Supplier Record (03)................................................................................................................. 46 2.8.4 EOM Product Record (04) ................................................................................................................. 47 2.8.5 EOM Product Tank Record (11) ........................................................................................................ 47 2.8.6 EOM Tank Gain/Loss Header Record (05) ....................................................................................... 48 2.8.7 EOM Tank Gain/Loss Record (06) .................................................................................................... 48 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 iv 2.9 Trip Transaction Sequence (01) ........................................................................... 49 2.9.1 Trip Header Record (04) .................................................................................................................... 51 3 Incoming Transactions .............................................. 53 3.1 Incoming Transaction Format .............................................................................. 53 3.1.1 Incoming Host Types ......................................................................................................................... 53 3.1.2 Incoming Transaction Number ........................................................................................................... 53 3.1.3 Incoming Transaction ID .................................................................................................................... 54 3.1.4 Incoming Record ID ........................................................................................................................... 54 3.1.5 Incoming Data Stream ....................................................................................................................... 54 3.2 Database Download Transaction Sequence (01) ................................................ 55 3.2.1 Database Download Header Record (01) ......................................................................................... 57 3.2.2 Bulk Account Record (14) .................................................................................................................. 57 3.2.3 Business Group Record (88) ............................................................................................................. 58 3.2.4 Calendar Record (29) ........................................................................................................................ 58 3.2.5 Carrier Record (07) ............................................................................................................................ 58 3.2.6 Carrier Customer Record (20) ........................................................................................................... 60 3.2.7 Carrier Destination Record (86) ......................................................................................................... 60 3.2.8 Carrier Supplier Record (13) .............................................................................................................. 61 3.2.9 Compartment Record (09) ................................................................................................................. 61 3.2.10 Contract Record (25) ....................................................................................................................... 61 3.2.11 Contract Exchange Record (26) ...................................................................................................... 62 3.2.12 Customer Record (19) ..................................................................................................................... 62 3.2.13 Customer Business Group Record (90) .......................................................................................... 64 3.2.14 Customer Credit Record (24) ........................................................................................................... 64 3.2.15 Customer Product Record (21) ........................................................................................................ 64 3.2.16 Destination Record (22) ................................................................................................................... 65 3.2.17 Destination Business Group Record (91) ........................................................................................ 66 3.2.18 Destination Product Record (87) ..................................................................................................... 66 3.2.19 Driver Record (11) ........................................................................................................................... 66 3.2.20 Exchange Agreement Record (18) .................................................................................................. 68 3.2.21 Exchange Terminal Product Record (27) ........................................................................................ 68 3.2.22 Hazard Warning Record (15) ........................................................................................................... 68 3.2.23 Injector Record (32) ......................................................................................................................... 69 v FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Contents 3.2.24 Meter Record (33) ............................................................................................................................ 70 3.2.25 Preset Record (34)........................................................................................................................... 71 3.2.26 Product Comment Record (16) ........................................................................................................ 73 3.2.27 Product Group Record (03) ............................................................................................................. 73 3.2.28 Supplier Record (12) ........................................................................................................................ 74 3.2.29 Supplier Inventory Record (35) ........................................................................................................ 75 3.2.30 Supplier Product Record (17) .......................................................................................................... 76 3.2.31 Supplier Product Recipe Record (36) .............................................................................................. 77 3.2.32 Tank Record (37) ............................................................................................................................. 77 3.2.33 Tank Strapping Record (38) ............................................................................................................ 80 3.2.34 Terminal Hazard Warning Record (05) ............................................................................................ 80 3.2.35 Terminal Owner Record (02) ........................................................................................................... 80 3.2.36 Terminal Product Record (04) ......................................................................................................... 83 3.2.37 Terminal Product Comment Record (06) ......................................................................................... 84 3.2.38 Tractor Record (23).......................................................................................................................... 84 3.2.39 Trailer Record (08) ........................................................................................................................... 85 3.2.40 Trailer Limits Record (10) ................................................................................................................ 87 3.2.41 Translate Bulk Account Record (40) ................................................................................................ 87 3.2.42 Translate Carrier Record (41) .......................................................................................................... 87 3.2.43 Translate Customer Record (42) ..................................................................................................... 88 3.2.44 Translate Destination Record (43) ................................................................................................... 88 3.2.45 Translate Driver Record (44) ........................................................................................................... 88 3.2.46 Translate Product Group Record (45) ............................................................................................. 89 3.2.47 Translate Supplier Record (46) ........................................................................................................ 89 3.2.48 Translate Supplier Product Record (47) .......................................................................................... 89 3.2.49 Translate Terminal Product Record (48) ......................................................................................... 89 3.2.50 Translate Tractor Record (50) ......................................................................................................... 90 3.2.51 Translate Trailer Record (49) ........................................................................................................... 90 3.2.52 Translation Group Record (51) ........................................................................................................ 90 3.2.53 User Interface Record (39) .............................................................................................................. 91 3.3 Dispatch Order Transaction Sequence (02) ........................................................ 92 3.3.1 Dispatch Order Header Record (01) .................................................................................................. 93 3.3.2 Dispatch Order Product Header Record (04) .................................................................................... 95 3.3.3 Dispatch Order Product Record (02) ................................................................................................. 96 3.3.4 Dispatch Order Exchange Header Record (05) ................................................................................. 97 3.3.5 Dispatch Order Exchange Record (06).............................................................................................. 97 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 vi 3.4 Allocation Transaction Sequence ........................................................................ 98 3.4.1 Allocation Header Types .................................................................................................................... 99 3.4.1.1 Exchanger Allocation Transaction .................................................................................................. 99 3.4.1.2 Customer Allocation Transaction .................................................................................................... 99 3.4.1.3 Destination Allocation Transaction ............................................................................................... 100 3.4.1.4 Business Group Allocation Transaction ........................................................................................ 101 3.4.2 Allocation Detail Header Record (04) .............................................................................................. 102 3.4.3 Allocation Detail Record (02) ........................................................................................................... 102 3.4.4 Allocation Detail Override Header Record (05) ............................................................................... 102 3.4.5 Allocation Detail Override Record (03) ............................................................................................ 102 3.5 Dispatch Trip Transaction Sequence (02) ......................................................... 103 3.5.1 Dispatch Trip Header Record (03) ................................................................................................... 104 3.6 Planned Bulk Movement Transaction Sequence (09) ...................................... 105 3.6.1 Planned Bulk Movement Header Record (01) ................................................................................. 106 3.6.1.1 Bulk Movement Types .................................................................................................................. 107 3.6.2 Planned Bulk Movement Planned Header Record (04)................................................................... 107 3.6.3 Planned Bulk Movement Planned Detail Record (07) ..................................................................... 108 4 Host File Import/Export Procedures ....................... 110 4.1 Host Transports................................................................................................... 110 4.2 ASCII Files ........................................................................................................... 110 4.2.1 ASCII Import Procedure ................................................................................................................... 110 4.2.2 ASCII File Export Procedure ............................................................................................................ 110 4.3 Transaction Per File ............................................................................................ 111 4.4 HostDB ................................................................................................................. 111 vii FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Contents Tables Table 1-1 Revision History ........................................................................................................... 11 Table 2-1 Outgoing Transaction Format ...................................................................................... 12 Table 2-2 Valid Outgoing Host Types .......................................................................................... 12 Table 2-3 Outgoing Transaction IDs ............................................................................................ 13 Table 2-4 Outgoing Data Stream .................................................................................................. 13 Table 2-5 Outgoing Transaction Sequences ................................................................................. 14 Table 2-6 Order Transaction Sequence ........................................................................................ 15 Table 2-7 Order Header Record.................................................................................................... 16 Table 2-8 Order Compartment Detail Record .............................................................................. 19 Table 2-9 Order Recipe Record .................................................................................................... 22 Table 2-10 Allocation Detail Record ............................................................................................ 24 Table 2-11 Order Dispatch Detail Record .................................................................................... 25 Table 2-12 Order Exchange Transaction Sequence ...................................................................... 26 Table 2-13 Exchange Header Record ........................................................................................... 27 Table 2-14 Exchange Product Record .......................................................................................... 27 Table 2-15 Bulk Movement Transaction Sequence ...................................................................... 29 Table 2-16 Bulk Movement Header Record ................................................................................. 30 Table 2-17 Bulk Movement Types ............................................................................................... 31 Table 2-18 Bulk Movement Planned Detail Record ..................................................................... 32 Table 2-19 Bulk Movement Product Record ................................................................................ 34 Table 2-20 Batch Detail Record .................................................................................................. 36 Table 2-21 Memo Inventory Transaction Sequence .................................................................... 37 Table 2-22 Memo Inventory Header Record ............................................................................... 37 Table 2-23 Memo Inventory Tank Record .................................................................................. 37 Table 2-24 EOD Marker Transaction Sequence .......................................................................... 39 Table 2-25 EOD Marker Header Record ..................................................................................... 40 Table 2-26 EOD Supplier Record ................................................................................................ 41 Table 2-27 EOD Product Record ................................................................................................. 41 Table 2-28 EOD Product Tank Record........................................................................................ 42 Table 2-29 EOD Tank Gain / Loss Record.................................................................................. 43 Table 2-30 EOD Meter Record .................................................................................................... 44 Table 2-31 EOD Injector Record ................................................................................................. 44 Table 2-32 EOM Marker Transaction Sequence ......................................................................... 45 Table 2-33 EOM Marker Header Record .................................................................................... 46 Table 2-34 EOM Supplier Record ............................................................................................... 46 Table 2-35 EOM Product Record ................................................................................................ 47 Table 2-36 EOM Product Tank Record ....................................................................................... 47 Table 2-37 EOM Tank Gain / Loss Record ................................................................................. 48 Table 2-38 Trip Transaction Sequence ........................................................................................ 49 Table 2-39 Trip Header Record ................................................................................................... 51 Table 3-1 Incoming Transaction Format ...................................................................................... 53 Table 3-2 Valid Incoming Host Types ......................................................................................... 53 Table 3-3 Incoming Transaction IDs ............................................................................................ 54 Table 3-4 Incoming Data Stream .................................................................................................. 55 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 viii Table 3-5 Database Download Transaction Sequence ................................................................. 55 Table 3-6 Bulk Account Record ................................................................................................... 57 Table 3-7 Business Group Record ................................................................................................ 58 Table 3-8 Calendar Record ........................................................................................................... 58 Table 3-9 Carrier Record .............................................................................................................. 58 Table 3-10 Carrier Customer Record............................................................................................ 60 Table 3-11 Carrier Destination Record ......................................................................................... 60 Table 3-12 Carrier Supplier Record.............................................................................................. 61 Table 3-13 Compartment Record.................................................................................................. 61 Table 3-14 Contract Record .......................................................................................................... 61 Table 3-15 Contract Exchange Record ......................................................................................... 62 Table 3-16 Customer Record ........................................................................................................ 62 Table 3-17 Customer Business Group Record ............................................................................. 64 Table 3-18 Customer Credit Record ............................................................................................. 64 Table 3-19 Customer Product Record .......................................................................................... 64 Table 3-20 Destination Record ..................................................................................................... 65 Table 3-21 Destination Business Group Record........................................................................... 66 Table 3-22 Destination Product Record........................................................................................ 66 Table 3-23 Driver Record ............................................................................................................. 66 Table 3-24 Exchange Agreement Record ..................................................................................... 68 Table 3-25 Exchange Terminal Product Record........................................................................... 68 Table 3-26 Hazard Warning Record ............................................................................................. 68 Table 3-27 Injector Record ........................................................................................................... 69 Table 3-28 Meter Record .............................................................................................................. 70 Table 3-29 Preset Record .............................................................................................................. 71 Table 3-30 Product Comment Record .......................................................................................... 73 Table 3-31 Product Group Record ................................................................................................ 73 Table 3-32 Supplier Record .......................................................................................................... 74 Table 3-33 Supplier Inventory Record ......................................................................................... 75 Table 3-34 Supplier Product Record ............................................................................................ 76 Table 3-35 Supplier Product Recipe Record ................................................................................ 77 Table 3-36 Tank Record ............................................................................................................... 77 Table 3-37 Tank Strapping Record ............................................................................................... 80 Table 3-38 Terminal Hazard Warning Record ............................................................................. 80 Table 3-39 Terminal Owner Record ............................................................................................. 80 Table 3-40 Terminal Product Record ........................................................................................... 83 Table 3-41 Terminal Product Comment Record ........................................................................... 84 Table 3-42 Tractor Record ............................................................................................................ 84 Table 3-43 Trailer Record............................................................................................................. 85 Table 3-44 Trailer Limits Record ................................................................................................. 87 Table 3-45 Translate Bulk Account Record ................................................................................. 87 Table 3-46 Translate Carrier Record ............................................................................................ 87 Table 3-47 Translate Customer Record ........................................................................................ 88 Table 3-48 Translate Destination Record ..................................................................................... 88 Table 3-49 Translate Driver Record ............................................................................................. 88 Table 3-50 Translate Product Group Record ................................................................................ 89 ix FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Contents Table 3-51 Translate Supplier Record .......................................................................................... 89 Table 3-52 Translate Supplier Product Record............................................................................. 89 Table 3-53 Translate Terminal Product Record ........................................................................... 89 Table 3-54 Translate Tractor Record ............................................................................................ 90 Table 3-55 Translate Trailer Record ............................................................................................. 90 Table 3-56 Translation Group Record .......................................................................................... 90 Table 3-57 User Interface Record ................................................................................................. 91 Table 3-58 Dispatch Order Transaction Sequence ....................................................................... 92 Table 3-59 Dispatch Order Header Record .................................................................................. 93 Table 3-60 Dispatch Order Product Record ................................................................................. 96 Table 3-61 Dispatch Order Exchange Record .............................................................................. 98 Table 3-62 Allocation Transaction Sequence .............................................................................. 98 Table 3-63 Exchanger Allocation Transaction ............................................................................. 99 Table 3-64 Exchanger Allocation Header Record ........................................................................ 99 Table 3-65 Customer Allocation Transaction Sequence ............................................................ 100 Table 3-66 Customer Allocation Header Record ....................................................................... 100 Table 3-67 Destination Allocation Transaction Sequence ......................................................... 100 Table 3-68 Destination Allocation Header Record..................................................................... 100 Table 3-69 Business Group Allocation Transaction Sequence .................................................. 101 Table 3-70 Business Group Allocation Header Record.............................................................. 101 Table 3-71 Allocation Detail Record .......................................................................................... 102 Table 3-72 Allocation Detail Override Record........................................................................... 102 Table 3-73 Dispatch Trip Transaction Sequence ........................................................................ 103 Table 3-74 Dispatch Trip Header Record ................................................................................... 104 Table 3-75 Planned Bulk Movement Transaction Sequence ...................................................... 106 Table 3-76 Planned Bulk Movement Header Record ................................................................. 106 Table 3-77 Bulk Movement Types ............................................................................................. 107 Table 3-78 Planned Bulk Movement Planned Detail Record ..................................................... 108 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 x 1 Overview 1.1 Purpose This document describes the interface between the FUEL-FACS+ Facility Business System (FBS) and a host system, such as an Enterprise Resource Planning (ERP) system. 1.2 Revision History The revision history of this document is presented in Table 1-1 below. Table 1-1 Revision History Issue Date Revision 11-Feb-2016 Initial release. 30-Mar-2016 Added missing Type entries in outgoing Order Header Record section (2.3.1) and Order Compartment Detail Record section (2.3.3). 4-May-2016 Miscellaneous edits. 27-May-2016 Published as R01. 18-Jul-2016 Added new fields to Memo Inventory Header Record section (2.6.1) and Memo Inventory Tank Record section (2.6.2). 20-Jul-2016 Added transaction IDs to all section headings. Published as R02. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 11 2 Outgoing Transactions 2.1 Outgoing Transaction Format The FUEL-FACS+ standard format for data transmitted to a host computer is detailed in the following table: Table 2-1 Outgoing Transaction Format Field Picture Description Transaction Number 999999 Identifies each instance of a transaction sent Operation X (A)dd, (M)odify, or (D)elete Transaction ID 99 Identifies the transaction type Record ID 99 Defines the type of individual record within a transaction Subrecords to Follow 99 Defines the number of associated records that will follow Data Stream Variable The actual data for the transaction 2.1.1 Outgoing Host Types The types and contents of transactions that are sent by the FUEL-FACS+ system to a host depend on the type of host configured in the FUEL-FACS+ system. The following table defines the valid outgoing host types: Table 2-2 Valid Outgoing Host Types Host Terminal Owner Supplier Customer 2.1.2 Outgoing Transaction Number The transaction number is a number that is incremented for each new database transaction sent to a host. This allows the host system to validate that no transactions are missing. Each host is configured in FUEL-FACS+, where you can specify the minimum and maximum transaction numbers. Once the maximum transaction number is reached, the system is automatically reset to the minimum transaction number. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 12 Outgoing Transactions 2.1.3 Outgoing Transaction ID The types of transactions currently supported by FUEL-FACS+, and the types of hosts these transactions are sent to, are detailed in the following table: Table 2-3 Outgoing Transaction IDs Transaction Transaction ID Terminal Owner Host Supplier Host Customer Host 01 Order Yes – all Yes – only those that apply to that supplier Yes – only those that apply to that customer 03 Bulk Receipt, Disposal, Transfer Yes – all Yes – only those that apply to that supplier No 04 Memo Inventory (periodic tank inventory) Yes – all No No 05 End-of-Day Marker Yes Yes – only those that apply to that supplier Yes – header record only 06 End-of-Month Marker Yes Yes – only those that apply to that supplier Yes – header record only 2.1.4 Outgoing Record ID Each transaction comprises one or more records. The types of records for each of the above transactions are defined in the corresponding section of this document. 2.1.5 Outgoing Data Stream The actual data sent in each of the above transactions includes a variable number of variablelength data fields, each preceded by a unique field label. The purpose of the field label is to allow upward compatibility as new fields are added in new releases of the FUEL-FACS+ system. The host system reading the transactions searches the data field for only those fields required and ignores any fields that are either not required or added in a new release of FUEL-FACS+. The data fields for each transaction are defined in the following sections of this document. Each section describes the transaction and details each record sent for the transaction in a table format. The columns of the tables are as follows: Table 2-4 Outgoing Data Stream Column Description Field Name The name of the data field Label The label preceding the actual value Type The type of data the field contains; the four types of data currently supported are (N)umeric, (F)loating numeric, (T)ext1, and (D)ate2 1 Text strings may contain any printable character. If an equal sign (=) is required, this will be prefixed by another equal sign. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 13 Outgoing Transactions Column Description Description/Value A general description of the data field Domain The domain is defined in the FUEL-FACS+ Database Specification document, in which a list of values can be found for each field; domains are also known as “user-defined types” Ter For a terminal owner host, this column contains either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. Sup For a supplier host, this column contains either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. Cus For a customer host, this column contains either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. 2.2 Outgoing Transaction Sequences The sequence of transactions sent to a host by the FUEL-FACS+ system is generally chronological, as they occur. As illustrated below, before an End-of-Day Marker transaction is sent to a host, Order, Exchange, Bulk Movement, and Memo Inventory transactions are sent in the chronological order in which they occur. Once an end-of-day event has completed, an End-of-Day Marker transaction is sent. On the last day of the month, after end-of-day processing has been performed, a carryover or end-of-month folio is opened. Once the carryover folio is closed, the end-of-month event has occurred and an End-of-Month Marker transaction is sent to the host. Note that before the end-of-month event occurs, Order, Exchange, Bulk Movement, and Memo Inventory transactions are sent for the next folio and Order, Exchange, and Bulk Movement transactions are sent for the carryover folio. Table 2-5 Outgoing Transaction Sequences Event Folio Related Transactions Order Normal Terminal Activity Current Exchange Bulk Movement (Receipt, Disposal, Transfer) Memo Inventory End-of-Day Current End-of-Day Marker Order Normal Terminal Activity Current or Carryover Exchange Bulk Movement (Receipt, Disposal, Transfer) Memo Inventory End-of-Month Carryover End-of-Month Marker 2 The format for date/time fields is YYYYMMDD<space>HH:mm:SS, where YYYY is the year, MM is the month, DD is the day, HH is the hour, mm is the minute, and SS is the second. 14 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.3 Order Transaction Sequence (01) When an order is billed, backed out, or rebilled, an Order transaction sequence is sent to the host. The following table identifies the records that make up the sequence: Table 2-6 Order Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 01 Order 01 Order header Three – one Order Compartment header record, one Order Allocation header record, and one Order Dispatch header record 11 Order Compartment header # of Order Compartment detail records to follow 02 Order Compartment detail # of Order Recipe records to follow 03 Order Recipe Zero 07 Order Allocation header # of Order Allocation detail records to follow 08 Order Allocation detail Zero 09 Order Dispatch header # of Order Dispatch detail records to follow 10 Order Dispatch detail Zero The Order transaction sequence consists of one Order header record followed by an Order Compartment header record, an Order Allocation header record, and an Order Dispatch header record. One or more Order Compartment detail records follow the Order Compartment header record. One or more Order Recipe records follow each Order Compartment detail record. Zero or more Order Allocation detail records may follow the Order Allocation header record. Zero or more Order Dispatch detail records follow the Order Dispatch header record. The flow of the Order transaction sequence is as follows: Order Header Order Compartment Header Order Compartment 1 Order Recipe 1 . . . Order Recipe N . . . Order Compartment N Order Recipe 1 . . . Order Recipe N Order Allocation Header Order Allocation Detail 1 . FUEL-FACS+ Host Interface Specification, FBS Version 5.1 15 Outgoing Transactions . . Order Allocation Detail N Order Dispatch Header Order Dispatch Detail 1 . . . Order Dispatch Detail N 2.3.1 Order Header Record (01) The order and format of the stream of data sent for an Order header record are detailed in the following table: Table 2-7 Order Header Record Field Name Label Type Description / Value Domain Operation =AA N Operation being performed for the order (bill, MOVEMENT backout, etc.) OPERATION Carrier Number =AB N Carrier number the driver hauls for CARRIER NUMBER Yes Yes Yes Trailer Number =AC N Trailer number the product was loaded into; if TRAILER NUMBER the order has multiple trailers, the first trailer loaded according to the loading sequence Yes Yes Yes Loaded Driver Number =AD N Driver number of the driver who loaded the product into the truck DRIVER NUMBER Yes Yes Yes Delivered Driver =AE Number N Driver number of the driver who delivered the DRIVER NUMBER product to the customer, if different from the driver loading the product Opt Opt Opt Supplier Number =AF N Supplier number of the supplier selling the product Yes Yes Yes Throughputter Number =AG N SUPPLIER NUMBER Throughputter number of the owner of the inventory, if different from the supplier selling the product. In a multi-throughputter environment, this single field may not have meaning. For backward compatibility, this field is populated by one of the inventory suppliers for the order. In a multithroughputter order, this value does not indicate the only throughputter for the order. Opt Opt No Customer Number =AH N Customer number for the customer being delivered product CUSTOMER NUMBER Yes Yes Yes Destination Number =AI N Destination number of the destination to receive the product DESTINATION NUMBER Yes Yes Yes SUPPLIER NUMBER Ter Sup Cus Yes Yes Yes Type =AJ N Order type ORDER TYPE Yes Yes Yes Creator =AK N How the order was created CREATOR TYPE Yes Yes No Manually Entered =AL N Whether the BOL was generated from the data entry forms BOOLEAN DISABLED Yes Yes No Billing Type =AM N Whether the order was billed by net or gross BILLING TYPE Invoice Required =AN N Whether an invoice is to be downloaded from BOOLEAN DISABLED Yes Yes Yes the host for local printing Delivery Fee F Delivery fee associated with the order 16 =AO SQL FLOAT Yes Yes Yes Yes Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Movement Number =AP N Unique BOL number for the terminal BOL NUMBER Yes Yes Yes BOL Number =AQ N Unique BOL number for the host BOL NUMBER Revision Number =AR N Count of how many times the order has been SQL LONG revised Yes Yes Yes Folio Number =AS N3 Number identifying which folio the order was loaded in Yes Yes Yes Purchase Order =AT Number T Purchase order number entered for the order PURCHASE ORDER NUMBER Opt Opt Opt Requisition Number =AU T Requisition number entered for the order PURCHASE ORDER NUMBER Opt Opt Opt Order Entry Time =AV D Date and time the order was entered SQL DATE TIME Yes Yes Yes Start Load Time =AW D Date and time loading of the order was started SQL DATE TIME Yes Yes Yes End Load time =AX D Date and time loading of the order was stopped SQL DATE TIME Yes Yes Yes Delivery Confirmed =AY N Flag to denote whether the order was delivered as loaded or whether product was left on the truck BOOLEAN DISABLED Yes Yes Yes Trip Movement Number =AZ N Unique BOL number for the terminal which denotes the trip of which this order is a part MOVEMENT NUMBER User Field 1 =BA N/F/ Data for Orders user field 1 D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =BB N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =BC N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =BD N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =BE N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =BF N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =BG N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =BH N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) FOLIO NUMBER Yes Yes Yes Opt Opt Opt 3 The format of the folio number is YYYYMMDDD, where YYYY is the year, MM is the month, and DDD is the end-of-day number. The end of day number starts at one at the beginning of the month, and increases by one each time an end of day is performed. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 17 Outgoing Transactions Field Name Label Type Description / Value Domain User Field 9 =BI Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) N/F/ D/T Ter Sup Cus Trailer Number 2 =BJ N If the order has multiple trailers, the second trailer loaded according to the loading sequence TRAILER NUMBER Yes Yes Yes Trailer Number 3 =BK N If the order has multiple trailers, the third trailer loaded according to the loading sequence TRAILER NUMBER Yes Yes Yes Overweight Trailer =BL N Indicates the trailer is over weight limits BOOLEAN DISABLED Yes Yes Yes Manually Completed =BM BOL Comment 1 =BN BOOLEAN DISABLED Yes Yes Yes T BOL_LINE Opt Opt Opt BOL Comment 2 =BO T BOL_LINE Opt Opt Opt Tractor Number =BP N TRACTOR NUMBER Opt Opt Opt Host Reference ID =BR T EXTERNAL REF ID Opt Opt Opt Trailer Number 4 =BS N If the order has multiple trailers, the fourth trailer loaded according to the loading sequence TRAILER NUMBER Opt Opt Opt Trailer Number 5 =BT N If the order has multiple trailers, the fifth trailer loaded according to the loading sequence TRAILER NUMBER Opt Opt Opt Trailer Number 6 =BU N If the order has multiple trailers, the sixth trailer loaded according to the loading sequence TRAILER NUMBER Opt Opt Opt Trailer Number 7 =BV N If the order has multiple trailers, the seventh trailer loaded according to the loading sequence TRAILER NUMBER Opt Opt Opt Trailer Number 8 =BW N If the order has multiple trailers, the eighth trailer loaded according to the loading sequence TRAILER NUMBER Opt Opt Opt User Field 10 =BX N/F/ Data for Orders user field 10 D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =BY N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =BZ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =CA N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =CB N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =CC N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 18 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 16 =CD N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =CE N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =CF N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =CG N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =CH N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) PETROEX Consignee Number =CI T PETROEX3 CONSIGNEE NUMBER Opt Opt Opt Terminal Code =RE T TERMINAL CODE Opt Opt Opt 2.3.2 Order Compartment Header Record (11) The Order Compartment header record is used to indicate the number of Order Compartment detail records that follow and does not actually contain any data fields. 2.3.3 Order Compartment Detail Record (02) The order and format of the stream of data sent for an Order Compartment detail record are detailed in the following table: Table 2-8 Order Compartment Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus Compartment Number =AA N Compartment number identifying the compartment COMPARTMENT NUMBER Yes Yes Yes Product Number =AB N Unique number identifying the supplier’s product PRODUCT NUMBER Yes Yes Yes Ordered Quantity =AC N Quantity of the supplier’s product ordered SQL LONG Yes Yes Yes Gross Quantity =AD N If metered, the gross quantity of the supplier’s product delivered; if weighed, the weight of the supplier’s product delivered SQL LONG Opt Opt Opt Net Quantity =AE N If metered, the net quantity of the supplier’s product delivered; if weighed, the weight of the supplier’s product delivered SQL LONG Opt Opt Opt Tare Weight =AF N If weighed, the weight of the truck, prior to loading with product SQL LONG Opt Opt Opt Density =AG F If metered, the density of the supplier’s product delivered SQL FLOAT Opt Opt Opt Specific Gravity =AH F If metered, the specific gravity of the supplier’s product delivered SQL FLOAT Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 19 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Coefficient of Expansion =AI F If metered, the coefficient of expansion of the SQL FLOAT supplier’s product delivered Opt Opt Opt Temperature =AJ F If metered, the weighted average temperature of the supplier’s product delivered SQL FLOAT Opt Opt Opt Octane =AK F If metered, the octane of the supplier’s product delivered SQL FLOAT Opt Opt Opt RVP =AL F If metered, the Reid vapor pressure of the supplier’s product delivered SQL FLOAT Opt Opt Opt Oxygen =AM F If metered, the oxygen percentage of the supplier’s product delivered SQL FLOAT Opt Opt Opt In Blend Tolerance =AN N Whether the compartment’s product is within BOOLEAN ENABLED Opt Opt Opt the blend tolerance Seal Number =AO N Seal number entered for the order compartment SQL LONG Opt Opt Opt Price =AP F Price of the product SQL FLOAT Yes Yes No Duty Status =AQ N Duty to be applied to the compartment product DUTY STATUS Yes Yes Yes Contract Number =AR T(15) Contract number under which the product was loaded CONTRACT NUMBER Opt Opt Opt Customer Net Quantity =AS N Same as net quantity SQL LONG Opt Opt Opt Loaded Additive =AT N Amount of additive loaded into the compartment SQL LONG Opt Opt Opt User Field 1 =AU N/F/ Order Compartment (Order Loaded) User D/T Field 1 Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AV N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AW N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AX N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AY N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AZ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =BA N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =BB N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =BC N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) N PETROEX BLEND INDICATOR PETROEX Blend =BD Indicator 20 Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain PETROEX Product Code =BE T(3) PETROEX PRODUCT Opt Opt Opt CODE Additive WCF =BF F Value used to calculate volume to/from mass SQL_FLOAT for additives Invalid Product Density =BG N Indicates that one or more of the recipe components used in calculating the compartment product density was zero (invalid) BOOLEAN DISABLED Yes Yes Yes Compartment Trailer Number =BH N Trailer number associated with the compartment TRAILER NUMBER Adjustment Type =BI N Only present for a backout operation ADJUSTMENT TYPE Opt Opt Opt Delivered =BJ Supplier Number N Only present for a backout operation SUPPLIER NUMBER Opt Opt Opt Delivered =BK Product Number N Only present for a backout operation PRODUCT NUMBER Opt Opt Opt =BL N Only present for a backout operation BOL NUMBER Opt Opt Opt Pump Back =BM Supplier Number N Only present for a backout operation SUPPLIER NUMBER Opt Opt Opt Pump Back =BN Product Number N Only present for a backout operation PRODUCT NUMBER Opt Opt Opt Pump Back Tank =BO Code T Only present for a backout operation TANK CODE Opt Opt Opt Other Customer =BP Movement Number N Only present for a backout operation BOL NUMBER Opt Opt Opt Other Customer =BQ Supplier Number N Only present for a backout operation SUPPLIER NUMBER Opt Opt Opt Other Customer =BR Number N Only present for a backout operation CUSTOMER NUMBER Opt Opt Opt =BS Other Destination Supplier Number N Only present for a backout operation SUPPLIER NUMBER Opt Opt Opt Other Destination Customer Number =BT N Only present for a backout operation CUSTOMER NUMBER Opt Opt Opt Other Destination Number =BU N Only present for a backout operation DESTINATION NUMBER Opt Opt Opt LOT Movement Number =BV N BOL NUMBER Opt Opt Opt Final Weight =BW N Final weight recorded after product has been SQL_LONG loaded Opt Opt Opt Weight =BX N Mass quantity associated with this compartment SQL_LONG Opt Opt Opt Loaded Additive =BY Weight N Amount of additive, in mass, loaded into the compartment SQL_LONG Opt Opt Opt User Field 10 N/F/ Order Compartment (Order Loaded) User D/T Field 10 Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) FUEL-FACS+ Host Interface Specification, FBS Version 5.1 21 Pump Back Movement Number =CQ Ter Sup Cus Opt Opt Opt Yes Yes Yes Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 11 =CR N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =CS N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =CT N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =CU N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =CV N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =CW N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =CX N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =CY N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =CZ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =DA N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 2.3.4 Order Recipe Record (03) The order and format of the stream of data sent for an Order Recipe record are detailed in the following table: Table 2-9 Order Recipe Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T Tank code of the tank the terminal product was delivered from/to TANK CODE Opt Opt Opt Preset Code =AB T Preset at which the product was loaded/unloaded HARDWARE TYPE Opt Opt Opt Meter Code =AC T If metered, the meter at which the product was metered HARDWARE TYPE Opt Opt Opt Injector Code =AD T If injected, the injector at which the additive was injected HARDWARE TYPE Opt Opt Opt Inventory =AE Supplier Number N Supplier number of the supplier who owns the terminal product that was sold SUPPLIER NUMBER Yes Yes No Terminal Product =AF Number N Terminal product number for the product in the tank PRODUCT NUMBER Yes Yes Yes Terminal Product =AG Type N Whether the terminal product was metered, injected, or weighed TERMINAL PRODUCT TYPE Yes Yes Yes 22 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Blend Percent =AH F If metered, the percentage of the total blend this terminal product makes up SQL FLOAT Opt Opt Opt Rate =AI N If injected, the rate in PPM at which injection SQL LONG was done Opt Opt Opt Method of Measure =AJ N Whether the terminal product was measured METHOD OF in volume or mass MEASURE Yes Yes Yes Override Temperature Enabled =AK N Whether the temperature was a live terminal BOOLEAN DISABLED Yes Yes Yes product temperature or a static one Ordered Quantity =AL N Quantity of the terminal product ordered SQL LONG Yes Yes Yes Gross Quantity =AM N If not weighed, the gross quantity of the terminal product delivered; If weighed, the weight of the terminal product delivered SQL LONG Opt Opt Opt Net Quantity =AN N If metered, the net quantity of the terminal product delivered; if weighed, the weight of the terminal product delivered SQL LONG Opt Opt Opt Weight =AO N Mass quantity associated with this terminal product SQL LONG Opt Opt Opt Density =AP F If metered, the density of the terminal product SQL FLOAT delivered Opt Opt Opt Specific Gravity =AQ F If metered, the specific gravity of the terminal SQL FLOAT product delivered Opt Opt Opt COE =AR F If metered, the coefficient of expansion of the SQL FLOAT terminal product delivered Opt Opt Opt Temperature =AS F If metered, the weighted average SQL FLOAT temperature of the terminal product delivered Opt Opt Opt RVP =AT F If metered, the Reid vapor pressure of the terminal product delivered SQL FLOAT Opt Opt Opt Oxygen =AU F If metered, the oxygen percentage of the terminal product delivered SQL FLOAT Opt Opt Opt Start Gross Totalizer =AV N If metered, the start gross totalizer of the meter SQL LONG Opt Opt Opt End Gross Totalizer =AW N If metered, the end gross totalizer of the meter SQL LONG Opt Opt Opt Start Net Totalizer =AX N If metered, the start net totalizer of the meter SQL LONG Opt Opt Opt End Net Totalizer =AY N If metered, the end net totalizer of the meter SQL LONG Opt Opt Opt Start Weight =AZ N No longer supported SQL LONG No No No End Weight =BA N No longer supported SQL LONG No No No Customer Net Quantity =BB N Same as net quantity SQL LONG Opt Opt Opt Additive WCF =BC F Value used to calculate volume to/from mass SQL_FLOAT for additives Opt Opt Opt Tare Scale Interface =BD T If weighed, the user interface location where the final weight was recorded Opt Opt Opt Left on Truck =BE N Indicates that the product represented by this BOOLEAN DISABLED Opt Opt Opt recipe component was left on the truck from a previous load FUEL-FACS+ Host Interface Specification, FBS Version 5.1 USER INTERFACE CODE 23 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Final Scale Interface =BF T If weighed, the user interface location where the final weight was recorded USER INTERFACE CODE Opt Opt Opt Fractional Start Gross Totalizer =BG N If metered, the fractional portion of the start gross totalizer of the meter SQL LONG Opt Opt Opt Fractional End Gross Totalizer =BH N If metered, the fractional portion of the end gross totalizer of the meter SQL LONG Opt Opt Opt Derived Values =BI N Indication of whether the volume or mass values are calculated by formula METHOD OF MEASURE Opt Opt Opt PETROEX Component Product Code =BJ T PETROEX COMPONENT PRODUCT CODE Opt Opt Opt Additive Quantity =BK N SQL LONG Opt Opt Opt Product Quantity =BL N SQL LONG Opt Opt Opt 2.3.5 Order Allocation Header Record (07) The Order Allocation header record is used to indicate the number of Order Allocation detail records that follow and does not actually contain any data fields. 2.3.6 Order Allocation Detail Record (08) The order and format of the stream of data sent for an Order Allocation detail record are detailed in the following table. Note that data is not sent when a reference ID is not specified for the allocation. Table 2-10 Allocation Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus Reference ID =AA T Reference ID for the allocation detail; if null, the record is not sent VARCHAR(40) Opt Opt Opt Committed Quantity =AB N Total of all quantities committed against this allocation SQL LONG Opt Opt Opt Loaded Quantity =AC N Total of all quantities loaded against this allocation SQL LONG Opt Opt Opt 2.3.7 Order Dispatch Header Record (09) The Order Dispatch header record is used to indicate the number of Order Dispatch detail records that follow and does not actually contain any data fields. 2.3.8 Order Dispatch Detail Record (10) The order and format of the stream of data sent for an Order Dispatch detail record are detailed in the following table: 24 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Table 2-11 Order Dispatch Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus PRODUCT NUMBER Yes Yes Yes Product Number =AA N Product number of the product to be delivered Compartment Number =AB N If by compartment, the compartment number COMPARTMENT of the trailer the product is to be loaded into NUMBER Opt Opt No Quantity =AC N Gross quantity of the product to be loaded SQL LONG Yes Yes Yes Duty Status =AD N Customs duty to be applied DUTY STATUS Opt Opt Opt Trailer Number =AE N If by compartment, the number of the trailer TRAILER NUMBER associated with the compartment number for the product to be loaded into User Field 1 =AF N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AG N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AH N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AI N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AJ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AK N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AL N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AM N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AN N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 10 =AO N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Opt Opt No 25 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 15 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =AY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 2.4 Order Exchange Transaction Sequence (01) When product is sold from one supplier to another via an exchange agreement, an Exchange transaction sequence is sent to the host of the supplier selling the product. The following table identifies the records that make up the sequence. Note that this transaction data is no longer supported as a separate transaction sequence with a separate transaction ID. The transaction ID and record ID have been modified so that the exchange transaction data is included as part of the order transaction when a product exchange has taken place. Table 2-12 Order Exchange Transaction Sequence Transaction Transaction Record Record ID ID 01 Order (with Exchange records) Subrecords to Follow 05 Exchange header # of Exchange Product records to follow 06 Exchange Product Zero Each Order Exchange transaction sequence contains one Exchange header record followed by an Exchange Product record for each terminal product sold. The flow of the Order Exchange transaction sequence is as follows: Exchange Header Exchange Product 1 . . . Exchange Product N 26 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.4.1 Exchange Header Record (05) The order and format of the stream of data sent for an Exchange header record are detailed in the following table: Table 2-13 Exchange Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Operation =AA N Operation being performed for this order (bill, ORDER OPERATION No backout, etc.) Yes No Throughputter =AC N SUPPLIER NUMBER No Supplier number of the supplier selling the product; this supplier may or may not own the inventory of one of the terminal products sold to the exchanger (see the Purchased From field in the Exchange Product record below for more information) Yes No Type =AD N Order type ORDER TYPE No Yes No Movement Number =AE N Unique BOL number for the terminal BOL NUMBER No Yes No BOL Number =AF N Unique BOL number for the host BOL NUMBER No Yes No Revision Number =AG N Number of times the order has been revised SQL-LONG No Yes No Folio Number =AH N4 Number identifying which folio the order was loaded in FOLIO NUMBER No Yes No Order Entry Time =AI D Date and time the order was entered SQL DATE TIME No Yes No Start Load Time =AJ D Date and time loading of the order was started SQL DATE TIME No Yes No End Load time =AK D Date and time loading of the order was stopped SQL DATE TIME No Yes No Terminal Code =RE T TERMINAL CODE Opt Opt Opt 2.4.2 Exchange Product Record (06) The order and format of the stream of data sent for an Exchange Product record are detailed in the following table: Table 2-14 Exchange Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T Tank code of the tank the terminal product was delivered from/to TANK CODE No Yes No Preset Code =AB T Preset at which the product was loaded/unloaded HARDWARE TYPE No Yes No Meter Code =AC T If metered, the meter at which the product was metered HARDWARE TYPE No Opt No 4 The format of the folio number is YYYYMMDDD, where YYYY is the year, MM is the month, and DDD is the end-of-day number. The end-of-day number starts at one at the beginning of the month and increases by one each time an end-of-day is performed. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 27 Outgoing Transactions Injector Code =AD T If injected, the injector at which the additive was injected HARDWARE TYPE No Opt No Terminal Product =AE Number N Terminal product number for the product in the tank PRODUCT NUMBER No Yes No Terminal Product =AF Type N Whether the terminal product was metered, injected, or weighed TERMINAL PRODUCT TYPE No Yes No No Yes No Method of Measure =AG N Whether the terminal product was measured METHOD OF in volume or mass MEASURE Override Temperature Enabled =AH N Whether the live terminal product temperature was used or a static one BOOLEAN DISABLED No Yes No Gross Quantity =AI N If not weighed, the gross quantity of the terminal product delivered SQL LONG No Opt No Net Quantity =AJ N If metered, the net quantity of the terminal product delivered SQL LONG No Opt No Weight =AK N Mass quantity associated with this terminal product SQL LONG No Opt No Density =AL F If metered, the density of the terminal product SQL FLOAT delivered No Opt No Specific Gravity =AM F If metered, the specific gravity of the terminal SQL FLOAT product delivered No Opt No Coefficient of Expansion =AN F If metered, the coefficient of expansion of the SQL FLOAT terminal product delivered No Opt No Temperature =AO F If metered, the weighted average SQL FLOAT temperature of the terminal product delivered No Opt No RVP =AP F If metered, the Reid vapor pressure of the terminal product delivered SQL FLOAT No Opt No Oxygen =AQ F If metered, the oxygen percentage of the terminal product delivered SQL FLOAT No Opt No Start Gross Totalizer =AR N If metered, the start gross totalizer of the meter SQL LONG No Opt No End Gross Totalizer =AS N If metered, the end gross totalizer of the meter SQL LONG No Opt No Start Net Totalizer =AT N If metered, the start net totalizer of the meter SQL LONG No Opt No End Net Totalizer =AU N If metered, the end net totalizer of the meter No Opt No Additive WCF =AX F Value used to calculate volume to/from mass SQL FLOAT for additives No Opt No Tare Scale Interface =AY T If weighed, the user interface location where the tare weight was recorded USER INTERFACE CODE No Opt No Final Scale Interface =AZ T If weighed, the user interface location where the final weight was recorded USER INTERFACE CODE No Opt No Purchased From =BA N Supplier number that this terminal product was purchased from, if the throughputter did not own the inventory being sold to the exchanger; otherwise, the throughputter number for the transaction SUPPLIER NUMBER No Yes No Sold To =BB N Supplier number that this terminal product was sold to SUPPLIER NUMBER No Yes No Derived Values =BC N Indicates whether the volume or mass values METHOD OF are calculated by formula MEASURE 28 SQL LONG Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Fractional Start Gross Totalizer =BD N If metered, the fractional portion of the start gross totalizer of the meter SQL LONG No Opt No Fractional End Gross Totalizer =BE N If metered, the fractional portion of the end gross totalizer of the meter SQL LONG No Opt No 2.5 Bulk Movement Transaction Sequence (03) When a bulk receipt, disposal, or transfer occurs, a Bulk Movement transaction sequence is sent to the host. The following table identifies the records that make up the sequence: Table 2-15 Bulk Movement Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 03 Bulk Movement 01 Bulk Movement header Two – the Planned header and the Product header 02 Product detail One – the Batch Detail header 03 Batch detail Zero 04 Planned header # of Planned detail records to follow 05 Product header # of Product detail records to follow 06 Batch Detail header # of Batch detail records to follow 07 Planned detail Zero The Bulk Movement transaction sequence consists of one Bulk Movement header followed by one Planned header record and one Product header record. The Planned header record is followed by a Planned detail record for each planned tank/product movement in the bulk movement. The Product header record is followed by one Product detail record for each loaded product in the movement. Each Product detail record is followed by one Batch Detail header record. This is followed by one or more Batch detail records. The flow of the Bulk Movement transaction sequence is as follows. Bulk Movement Header Planned Header Planned Detail 1 . . . Planned Detail N Product Header Product Detail 1 Batch Detail Header Batch Detail 1 . . . Batch Detail N . . . Product Detail N Batch Detail Header FUEL-FACS+ Host Interface Specification, FBS Version 5.1 29 Outgoing Transactions Batch Detail 1 . . . Batch Detail N Note that Bulk Transfer transactions contain exactly two Bulk Movement Product sequences, with the first sequence being the “from” product for the transfer and the second being the “to” product for the transfer. 2.5.1 Bulk Movement Header Record (01) The order and format of the stream of data sent for a Bulk Movement header record are detailed in the following table: Table 2-16 Bulk Movement Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Bulk Account Number5 =AA N Bulk account involved in the bulk movement; SUPPLIER NUMBER this value may be 0 if a bulk account is not involved Opt Opt No From Supplier Number =AB N SUPPLIER NUMBER Supplier number that the bulk movement came from; this value may be 0 if it is from a bulk account Opt Opt No To Supplier Number =AC N Supplier number that the bulk movement is sent to; this value may be 0 if sent to a bulk account SUPPLIER NUMBER Opt Opt No Type =AD N Bulk receipt (1), disposal (2), or transfer (3) BULK MOVEMENT TYPE Yes Yes No Reference Number =AE T Reference number entered for the bulk movement VARCHAR(20) Yes Yes No Movement Number =AF N Unique BOL number for the terminal BOL NUMBER Yes Yes No BOL Number =AG N Unique BOL number for the host BOL NUMBER Yes Yes No Revision Number =AH N Number of times the bulk movement has been revised SQL LONG Yes Yes No Folio Number =AI N Number identifying which folio the bulk movement was loaded in FOLIO NUMBER Yes Yes No Movement Date =AJ D Date and time the bulk movement was entered SQL DATE TIME Yes Yes No Vessel =AK T Vessel from/to which the bulk movement was CHAR(20) transferred, if entered Yes Yes No DOC Operator Code =AL T DOC operator code entered for the bulk movement CHAR(10) Yes Yes No Batch Voyage Number =AM T Batch voyage number entered for the bulk movement CHAR(10) Yes Yes No 5 Within this table, the term “bulk account” is defined as the account number of an entity not defined within FUEL-FACS+ that received or sent the bulk movement, such as a refinery, a barge, a pipeline, or a particular company. 30 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Operation =AN N BULK MOVEMENT OPERATION Yes Yes No User Field 1 =AO N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Host Reference ID =AX T VARCHAR(20) Opt Opt No Remarks =AZ T VARCHAR(80) Opt Opt No Terminal Code =RE T TERMINAL CODE Opt Opt Opt Operation being performed for this bulk movement (bill, backout, etc.) 2.5.1.1 Bulk Movement Types The following table describes, for each type of bulk movement, whether the bulk account, from supplier, and to supplier are present in the transaction: Table 2-17 Bulk Movement Types Bulk Movement Type Bulk Account From Supplier To Supplier Receipt Yes No Yes Disposal Yes Yes No Transfer No Yes Yes 2.5.2 Bulk Movement Planned Header Record (04) The Bulk Movement Planned header record is used to specify the number of Planned detail records to follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 31 Outgoing Transactions 2.5.3 Bulk Movement Planned Detail Record (07) The order and format of the stream of data sent for a Bulk Movement Planned detail record are detailed in the following table: Table 2-18 Bulk Movement Planned Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus Orientation =AA N Direction of product movement for this planned record MARINE TANK ORIENTATION Opt Opt No Tank Code =AB T Tank code of the tank the terminal product will be delivered from or to TANK CODE Opt Opt No Terminal Product =AC Number N Terminal product number for the product in the tank PRODUCT NUMBER Yes Yes No Planned Date Time =AD D Date/time the product movement is planned to occur SQL DATE TIME Opt Opt No Planned Quantity =AE N Primary planned quantity for the product movement SQL LONG Yes Yes No Quantity Type =AF N Type of units represented by the Planned Quantity INVENTORY QTY TYPE Yes Yes No Alternate Planned Quantity =AG N Alternate, optional planned quantity for the product movement SQL LONG Opt Opt No Alternate Quantity Type =AH N Type of units represented by the alternate planned quantity; required if alternate planned quantity is provided INVENTORY QTY TYPE Opt Opt No Remarks =AI T General remarks about the product movement DESCRIPTION Opt Opt No User Field 1 =AJ N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AK N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AL N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AM N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AN N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AO N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 32 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 9 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 10 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =AY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =AZ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =BA N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =BB N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =BC N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 2.5.4 Bulk Movement Product Header Record (05) The Bulk Movement Product header record is used to specify the number of Product detail records to follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 33 Outgoing Transactions 2.5.5 Bulk Movement Product Detail Record (02) The order and format of the stream of data sent for a Bulk Movement Product detail record are detailed in the following table: Table 2-19 Bulk Movement Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T Tank code of the tank the terminal product was delivered from or to TANK CODE Yes Yes No Supplier Number =AB N Supplier number of the supplier who owns the terminal product SUPPLIER NUMBER Yes No Terminal Product =AC Number N Terminal product number for the product in the tank PRODUCT NUMBER Yes Yes No Terminal Product =AD Type N Terminal product type (metered, injected, or weighed) TERMINAL PRODUCT TYPE Yes Yes No Method of Measure =AE N Whether the terminal product was measured METHOD OF in volume or mass MEASURE Yes Yes No Gross Quantity =AF N SQL LONG If not weighed, the gross quantity of the terminal product being moved; if weighed, the weight of the detail terminal product being moved Opt Opt No Net Quantity =AG N SQL LONG If not weighed, the net quantity of the terminal product being moved; if weighed, the weight of the detail terminal product being moved Opt Opt No Weight =AH N No longer supported No Density =AI F If metered, the density of the terminal product SQL FLOAT being moved Opt Opt No Specific Gravity =AJ F If metered, the specific gravity of the terminal SQL FLOAT product being moved Opt Opt No Coefficient of Expansion =AK F If metered, the coefficient of expansion of the SQL FLOAT terminal product being moved Opt Opt No Temperature =AL F If metered, the weighted average temperature of the terminal product being moved SQL FLOAT Opt Opt No Octane =AM F If metered, the octane of the supplier’s product being moved SQL FLOAT Opt Opt No RVP =AN F If metered, the Reid vapor pressure of the terminal product being moved SQL FLOAT Opt Opt No Oxygen =AO F If metered, the oxygen percentage of the terminal product being moved SQL FLOAT Opt Opt No User Field 1 =AP N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 34 SQL LONG No No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Field Name Label Type Description / Value Domain User Field 4 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Additive WCF =AY F Value used to calculate volume to/from mass SQL FLOAT for additives Opt Opt No Pressure =AZ F If metered, the pressure of the terminal product being moved SQL FLOAT Opt Opt No Flow Rate =BA F If metered, the flow rate at which the terminal SQL FLOAT product was moved Opt Opt No Average Meter Factor =BB F If metered, the average meter factor of the meter through which the terminal product was moved SQL FLOAT Opt Opt No VCF =BC F If metered, the volume correction factor of the terminal product being moved SQL FLOAT Opt Opt No PCF =BD F If metered, the pressure correction factor of the terminal product being moved SQL FLOAT Opt Opt No Start Date =BE D SQL DATE TIME Opt Opt No End Date =BF D SQL DATE TIME Opt Opt No Observed Density =BG F SQL FLOAT Opt Opt No Density at observed conditions; when supplied, used to calculate the Density tag above, which is at reference conditions Ter Sup Cus 2.5.6 Bulk Movement Batch Detail Header Record (06) The Bulk Movement Batch Detail header record is used to specify the number of Batch detail records to follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 35 Outgoing Transactions 2.5.7 Batch Detail Record (03) The order and format of the stream of data sent for a Batch detail record are detailed in the following table: Table 2-20 Batch Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus PRODUCT NUMBER Yes Yes No Detail Terminal =AA Product Number N Product number of the batch detail component Gross Quantity =AB N If not weighed, the gross quantity of the detail SQL LONG terminal product being moved; if weighed, the weight of the detail terminal product being moved Opt Opt No Net Quantity =AC N SQL LONG If not weighed, the net quantity of the detail terminal product being moved; if weighed, the weight of the detail terminal product being moved Opt Opt No Temperature =AD F If metered, the weighted average temperature of the detail terminal product being moved SQL FLOAT Opt Opt No Density =AE F If metered, the density of the detail terminal product being moved SQL FLOAT Opt Opt No Pressure =AF F If metered, the pressure of the detail terminal SQL FLOAT product being moved Opt Opt No Flow Rate =AG F If metered, the flow rate that the detail terminal product was moved at SQL FLOAT Opt Opt No Specific Gravity =AH F If metered, the specific gravity of the terminal SQL FLOAT product being moved Opt Opt No Average Meter Factor =AI F If metered, the average meter factor of the meter through which the detail terminal product was moved SQL FLOAT Opt Opt No VCF =AJ F If metered, the volume correction factor of the detail terminal product being moved SQL FLOAT Opt Opt No PCF =AK F If metered, the pressure correction factor of the detail terminal product being moved SQL FLOAT Opt Opt No Start Gross Totalizer =AL N If metered, the start gross totalizer of the meter SQL LONG Opt Opt No End Gross Totalizer =AM N If metered, the end gross totalizer of the meter SQL LONG Opt Opt No Start Net Totalizer =AN N If metered, the start net totalizer of the meter SQL LONG Opt Opt No End Net Totalizer =AO N If metered, the end net totalizer of the meter Opt Opt No Meter Tag =AP N SQL FLOAT If metered, a value identifying the meter through which the detail terminal product was moved Opt Opt No Additive WCF =AQ F Value used to calculate volume to/from mass SQL FLOAT for additives Opt Opt No Start Date =AR D SQL DATE TIME Opt Opt No End Date =AS D SQL DATE TIME Opt Opt No 36 SQL LONG FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.6 Memo Inventory Transaction Sequence (04) At periodic intervals, a Memo Inventory transaction sequence is sent to the host detailing the tank inventory at the terminal. The following table identifies the records that make up the sequence: Table 2-21 Memo Inventory Transaction Sequence Transaction Transaction Record Record ID ID 04 Memo Inventory Subrecords to Follow 01 Memo Inventory header # of Memo Inventory Tank records to follow 02 Memo Inventory Tank Zero The Memo Inventory transaction sequence consists of one header record followed by a Tank record for each tank at the terminal. The flow of the Memo Inventory transaction sequence is as follows: Memo Inventory Header Memo Inventory Tank 1 . . . Memo Inventory Tank N 2.6.1 Memo Inventory Header Record (01) The order and format of the stream of data sent for a Memo Inventory header record are detailed in the following table: Table 2-22 Memo Inventory Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Time of Inventory =AA D SQL DATE TIME Yes No Terminal ID =RA N OWNER ID Opt Opt Opt Terminal Code =RE T TERMINAL CODE Opt Opt Opt Date/time the tank inventory was measured No 2.6.2 Memo Inventory Tank Record (02) The order and format of the stream of data sent for a Memo Inventory Tank record are detailed in the following table: Table 2-23 Memo Inventory Tank Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T Tank code of the tank the inventory is for TANK CODE Yes No No Terminal Product =AB Number N Terminal product number for the product in the tank PRODUCT NUMBER Yes No No RVP F Reid vapor pressure of the terminal product in the tank SQL FLOAT Yes No No =AC FUEL-FACS+ Host Interface Specification, FBS Version 5.1 37 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Oxygen =AD F Oxygen percentage of the terminal product SQL FLOAT Yes No No Level =AE T6 Level of the product in the tank TANK LEVEL Yes No No Receipt Indicator =AF N Whether product is being received into the tank at the time the transaction is generated BOOLEAN DISABLED Yes No No Activity Status =AG N Whether the tank is active or inactive TANK ACTIVITY STATUS Yes No No Pipe Fill =AH N Gross quantity of product in the pipe exiting the tank SQL LONG Yes No No Gross Quantity =AI N Gross quantity of product in the tank SQL LONG Yes No No Net Quantity =AJ N Net quantity of product in the tank SQL LONG Yes No No Temperature =AK F Temperature of the product in the tank SQL FLOAT Yes No No Density =AL F Density of the product in the tank SQL FLOAT Yes No No Specific Gravity =AM F Specific gravity of the product in the tank SQL FLOAT Yes No No COE =AN F Coefficient of expansion of the product in the SQL FLOAT tank Yes No No BSW Level =AO T6 Base sediment and water level in the tank Yes No No BSW Quantity =AP N Gross quantity of base sediment and water in SQL LONG the tank Yes No No Available Quantity =AQ N Gross quantity of product above the tank’s cutoff setpoint that is available to be used SQL LONG Yes No No Book Inventory =AR N Current book inventory in the tank SQL LONG Yes No No Additive WCF =AS F Value used to calculate volume to/from mass SQL FLOAT for additives Yes No No Manual Strap Type =BC N Strapping type for manual tank data STRAP TYPE Yes No No BSW Strap Type =BD N Strapping type for base sediment and water tank data STRAP TYPE Yes No No TOV =BE N Real-time gross quantity SQL LONG Yes No No NSV =BF N Real-time net quantity SQL LONG Yes No No Last Receipt Date =BG D SQL DATE TIME Yes No No NSW =BH N Weight in Air =BI N Net standard weight in air TANK LEVEL SQL LONG Yes No No SQL LONG Yes No No 6 The format for the level is either FFFIISS, if the unit of measure is imperial, or MMMCCmm, if the unit of measure is metric. (FFF is feet, II is inches, SS is sixteenths of inches, MMM is meters, CC is centimeters, and mm is millimeters.) 38 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.7 End-of-Day Marker Transaction Sequence (05) At the end of a day, an EOD Marker transaction sequence is sent to the host. The following table identifies the records that make up the sequence: Table 2-24 EOD Marker Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 05 EOD Marker header Four – one Book Inventory header record, one Tank Gain/Loss header record, one Meter Totalizer header record, and one Injector Totalizer header record 02 Book Inventory header # of Supplier records to follow 03 Supplier # of Product records to follow 04 Product # of Product Tank Inventory records to follow 11 Product Tank Zero EOD Marker 01 05 Tank Gain/Loss header # of Tank records to follow 06 Tank 07 Meter Totalizer header # of Meter records to follow 08 Meter Zero Zero 09 Injector Totalizer header # of Injector records to follow 10 Injector Zero The EOD Marker transaction sequence consists of one EOD Marker header record followed by a Book Inventory header record, a Tank Gain/Loss header record, a Meter Totalizer header record, and an Injector Totalizer header record. Immediately following the Book Inventory header record is a Supplier record for each supplier that maintains inventory at the terminal. Immediately following each Supplier record is a Product record for each inventoried product. Immediately following each Product record is a Product Tank record for each tank that contains inventory of the product for the supplier. Immediately following the Tank Gain/Loss header record is a Tank record for each tank at the terminal. Immediately following the Meter Totalizer header record is a Meter record for each meter at the terminal. Immediately following the Injector Totalizer header record is an Injector record for each injector at the terminal. The flow of the EOD Marker transaction sequence is as follows: EOD Marker Header EOD Book Inventory Header EOD Supplier 1 EOD Product 1 Product Tank 1 . . . Product Tank N EOD Product N Product Tank 1 . . . FUEL-FACS+ Host Interface Specification, FBS Version 5.1 39 Outgoing Transactions Product Tank N EOD Supplier N EOD Product 1 Product Tank 1 . . . Product Tank N EOD Product N EOD Tank Gain/Loss Header EOD Tank 1 . . . EOD Tank N EOD Meter Totalizer Header EOD Meter 1 . . . EOD Meter N EOD Injector Totalizer Header EOD Injector 1 . . . EOD Injector N 2.7.1 EOD Marker Header Record (01) The order and format of the stream of data sent for an EOD Marker header record are detailed in the following table: Table 2-25 EOD Marker Header Record Field Name Label Type Description / Value Folio Number =AA Open Date =AB D Date the folio was opened SQL DATE TIME Yes Yes Yes Close Date =AC D Date the folio was closed SQL DATE TIME Yes Yes Yes Terminal Code =RE T TERMINAL CODE Opt Opt Opt T7 Folio number of the folio just closed Domain Ter Sup Cus FOLIO NUMBER Yes Yes Yes 2.7.2 EOD Book Inventory Header Record (02) The EOD Book Inventory header record is used to specify the number of EOD Supplier records that follow and does not actually contain any data fields. 7 The format of the folio number is YYYYMMDDD, where YYYY is the year, MM is the month, and DDD is the end-of-day number. The end-of-day number starts at 001 at the beginning of the month and increases by one each time an end-of-day is performed. 40 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.7.3 EOD Supplier Record (03) The order and format of the stream of data sent for an EOD Supplier record are detailed in the following table: Table 2-26 EOD Supplier Record Field Name Label Type Description / Value Supplier Number =AA N Domain Supplier number of the supplier maintaining inventory at the terminal Ter Sup Cus Yes Yes No 2.7.4 EOD Product Record (04) The order and format of the stream of data sent for an EOD Product record are detailed in the following table: Table 2-27 EOD Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Terminal Product =AA Number N Terminal product number for the product inventoried PRODUCT NUMBER Yes Yes No Beginning Inventory =AB N Beginning-of-month inventory SQL LONG Yes Yes No Committed =AC N Quantity of inventory that has been committed but not yet loaded SQL LONG Yes Yes No Receipts =AD N Quantity of product received since the beginning of the month SQL LONG Yes Yes No Disposals =AE N Quantity of product disposed since the beginning of the month SQL LONG Yes Yes No Current Inventory =AF N Current book inventory SQL LONG Yes Yes No MTD Bulk Receipts =AG N Month-to-date bulk receipts (the sum of MTD SQL LONG bulk receipts, MTD rack receipts, and MTD transfers in equals receipts) Yes Yes No MTD Rack Receipts =AH N Month-to-date rack receipts (the sum of MTD SQL LONG bulk receipts, MTD rack receipts, and MTD transfers in equals receipts) Yes Yes No MTD Transfers In =AI N Month-to-date transfers in (the sum of MTD bulk receipts, MTD rack receipts, and MTD transfers in equals receipts) SQL LONG Yes Yes No MTD Bulk Disposals =AJ N Month-to-date bulk disposals (the sum of MTD bulk disposals, MTD rack disposals, and MTD transfers out equals disposals) SQL LONG Yes Yes No MTD Rack Disposals =AK N Month-to-date rack disposals (the sum of MTD bulk disposals, MTD rack disposals, and MTD transfers out equals disposals) SQL LONG Yes Yes No MTD Transfers Out =AL N Month-to-date transfers out (the sum of MTD SQL LONG bulk disposals, MTD rack disposals, and MTD transfers out equals disposals) Yes Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 41 Outgoing Transactions 2.7.5 EOD Product Tank Record (11) The order and format of the stream of data sent for an EOD Supplier Tank Inventory record are detailed in the following table: Table 2-28 EOD Product Tank Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA N Tank code of the tank containing the terminal TANK CODE product Yes Yes No Beginning Inventory =AB N Beginning-of-month tank inventory SQL LONG Yes Yes No Fractional Beginning Inventory =AC N Beginning-of-month tank inventory rollover fractional SQL LONG Yes Yes No MTD Bulk Receipts =AD N Month-to-date bulk receipts SQL LONG Yes Yes No Fractional MTD Bulk Receipts =AE N Month-to-date bulk receipts rollover fractional SQL LONG Yes Yes No MTD Rack Receipts =AF N Month-to-date rack receipts SQL LONG Yes Yes No Fractional MTD Rack Receipts =AG N Month-to-date rack receipts rollover fractional SQL LONG Yes Yes No MTD Transfers In =AH N Month-to-date transfers in SQL LONG Yes Yes No Fractional MTD Transfers In =AI N Month-to-date transfers in rollover fractional SQL LONG Yes Yes No MTD Bulk Disposals =AJ N Month-to-date bulk disposals SQL LONG Yes Yes No Fractional MTD Bulk Disposals =AK N Month-to-date bulk disposals rollover fractional SQL LONG Yes Yes No MTD Rack Disposals =AL N Month-to-date rack disposals SQL LONG Yes Yes No Fractional MTD Rack Disposals =AM N Month-to-date rack disposals rollover fractional SQL LONG Yes Yes No MTD Transfers Out =AN N Month-to- date transfers out SQL LONG Yes Yes No Fractional MTD Transfers Out =AO N Month-to- date transfers out rollover fractional SQL LONG Yes Yes No Current Inventory =AP N Current tank inventory SQL LONG Yes Yes No Fractional Current Inventory =AQ N Current tank inventory rollover fractional SQL LONG Yes Yes No 2.7.6 EOD Tank Gain/Loss Header Record (05) The EOD Tank Gain/Loss header record is used to specify the number of EOD Tank Gain/Loss records that follow and does not actually contain any data fields. 42 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.7.7 EOD Tank Gain/Loss Record (06) The order and format of the stream of data sent for an EOD Tank Gain/Loss record are detailed in the following table: Table 2-29 EOD Tank Gain / Loss Record Field Name Label Type Description / Value Tank Code Domain Ter Sup Cus =AA T Tank code of the tank the inventory is for TANK CODE Yes No No Terminal Product =AB Number N Terminal product code for the product in the tank PRODUCT CODE Yes No No Method of Measure =AC N Whether the terminal product was measured METHOD OF by volume or mass MEASURE Yes No No Opening Physical =AD N Net quantity of product in the tank at the beginning of the folio Yes No No Bulk Receipts =AE N Net quantity of bulk receipts put into the tank SQL LONG Yes No No Bulk Disposals =AF N Net quantity of bulk disposals taken from the SQL LONG tank Yes No No Bulk Transfers In =AG N Net quantity of bulk transfers into the tank SQL LONG Yes No No Bulk Transfers Out =AH N Net quantity of bulk transfers from the tank SQL LONG Yes No No Rack Receipts =AI N Net quantity of rack receipts put into the tank SQL LONG Yes No No Rack Disposals =AJ N Net quantity of rack disposals taken from the SQL LONG tank Yes No No Closing Physical =AK N Net quantity of product in the tank at the end SQL LONG of the folio Yes No No Manual Closing Physical =AL N Physical net quantity of product in the tank at BOOLEAN DISABLED Yes No the end of the folio No Gain/Loss =AM N Gain or loss for the tank SQL LONG Yes No No Closing TOV =AN N Gross quantity of product in the tank at the end of the folio SQL LONG Yes No No Closing Density =AO N Density of the product in the tank at the end of the folio SQL FLOAT Yes No No Closing Temperature =AP N Temperature of the product in the tank at the SQL FLOAT end of the folio Yes No No SQL LONG 2.7.8 EOD Meter Totalizer Header Record (07) The EOD Meter Totalizer header record is used to specify the number of EOD Meter records that follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 43 Outgoing Transactions 2.7.9 EOD Meter Record (08) The order and format of the stream of data sent for an EOD Meter record are detailed in the following table: Table 2-30 EOD Meter Record Field Name Label Type Description / Value Domain Preset Code =AA T Preset code that the meter is attached to HARDWARE TYPE Yes No No Meter Code =AB T Meter code that the totalizer information is for HARDWARE TYPE Yes No No Terminal Product =AC Number N Terminal product number for the product being metered Yes No No Gross Totalizer =AD N Gross totalizer quantity value for the meter at SQL LONG the end of the day Yes No No Gross Throughput =AE N Gross quantity of product moved through the SQL LONG meter for the day Yes No No Gross Unaccounted =AF N Gross quantity of unaccounted product for the meter for the day SQL LONG Yes No No Net Totalizer =AG N Net totalizer quantity value for the meter at the end of the day SQL LONG Yes No No Net Throughput =AH N Net quantity of product moved through the meter for the day SQL LONG Yes No No Net Unaccounted =AI N Net quantity of unaccounted product for the meter for the day SQL LONG Yes No No PRODUCT NUMBER Ter Sup Cus 2.7.10 EOD Injector Totalizer Header Record (09) The EOD Injector Totalizer header record is used to specify the number of EOD Injector records to follow and does not actually contain any data fields. 2.7.11 EOD Injector Record (10) The order and format of the stream of data sent for an EOD Injector record are detailed in the following table: Table 2-31 EOD Injector Record Field Name Label Type Description / Value Domain Ter Sup Cus Preset Code =AA T Preset code that the injector is attached to HARDWARE TYPE Yes No No Injector Code =AB T Injector code that the totalizer information is for HARDWARE TYPE Yes No No Terminal Product =AC Number N Terminal product number for the product being injected PRODUCT NUMBER Yes No No Totalizer =AD N Totalizer quantity value for the injector at the SQL LONG end of the day Yes No No Throughput =AE N Quantity of product moved through the injector for the day SQL LONG Yes No No Unaccounted =AF N Quantity of unaccounted product for the injector for the day SQL LONG Yes No No Certification Rate =AG N Minimum injection rate for the terminal product being injected SQL LONG Yes No No 44 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.8 End-of-Month Marker Transaction Sequence (06) At the end of a month, an EOM Marker transaction sequence is sent to the host. The following table identifies the records that make up the sequence: Table 2-32 EOM Marker Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 06 EOM Marker 01 EOM Marker Header Two – one EOM Book Inventory header record and one EOM Tank Gain/Loss header record 02 EOM Book Inventory header # of EOM Supplier records to follow 03 EOM Supplier # of EOM Product records to follow 04 EOM Product # of EOM Product Tank records to follow 11 EOM Product Tank Zero 05 EOM Tank Gain/Loss header # of EOM Tank records to follow 06 Tank Zero The EOM Marker transaction sequence consists of one EOM Marker header record followed by an EOM Book Inventory header record and an EOM Tank Gain/Loss header record. Immediately following the EOM Book Inventory header record is an EOM Supplier record for each supplier that maintains inventory at the terminal. Immediately following each EOM Supplier record is an EOM Product record for each inventoried product. Immediately following each EOM Product record is an EOM Product Tank record for each tank that contains inventory of the product for the supplier. Immediately following the EOM Tank Gain/Loss header record is an EOM Tank record for each tank at the terminal. The flow of the EOM Marker transaction sequence is as follows: EOM Marker Header EOM Book Inventory Header EOM Supplier 1 EOM Product 1 EOM Product . . . EOM Product EOM Product N EOM Product . . . EOM Product EOM Supplier N EOM Product 1 EOM Product . . . Tank 1 Tank N Tank 1 Tank N Tank 1 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 45 Outgoing Transactions EOM Product Tank N EOM Product N EOM Product Tank 1 . . . EOM Product Tank N EOM Tank Gain/Loss Header EOM Tank 1 . . . EOM Tank N 2.8.1 EOM Marker Header Record (01) The order and format of the stream of data sent for an EOM Marker header record are detailed in the following table: Table 2-33 EOM Marker Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Folio Number =AA T Folio number of the carryover folio just closed FOLIO NUMBER Yes Yes Yes Open Date =AB D Date the folio was opened SQL DATE TIME Yes Yes Yes Close Date =AC D Date the folio was closed SQL DATE TIME Yes Yes Yes Terminal Code =RE T TERMINAL CODE Opt Opt Opt 2.8.2 EOM Book Inventory Header Record (02) The EOM Book Inventory header record is used to specify the number of EOM Supplier records to follow and does not actually contain any data fields. 2.8.3 EOM Supplier Record (03) The order and format of the stream of data sent for an EOM Supplier record are detailed in the following table: Table 2-34 EOM Supplier Record Field Name Label Type Description / Value Supplier Number =AA 46 N Supplier number of the supplier maintaining inventory at the terminal Domain Ter Sup Cus SUPPLIER NUMBER Yes Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.8.4 EOM Product Record (04) The order and format of the stream of data sent for an EOM Product record are detailed in the following table: Table 2-35 EOM Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Terminal Product =AA Number N Terminal product number for the product inventoried PRODUCT NUMBER Yes Yes No Beginning Inventory =AB N Beginning-of-month inventory SQL LONG Yes Yes No Receipts =AC N Quantity of product received since the beginning of the month SQL LONG Yes Yes No Disposals =AD N Quantity of product disposed since the beginning of the month SQL LONG Yes Yes No Final Inventory =AE N Final end-of-month inventory, including gain/loss adjustments SQL LONG Yes Yes No Gain/Loss =AF N Portion of gain/loss for this supplier SQL LONG Yes Yes No 2.8.5 EOM Product Tank Record (11) The order and format of the stream of data sent for an EOM Product Tank record are detailed in the following table: Table 2-36 EOM Product Tank Record Field Name Label Type Description / Value Tank Code =AA N Tank code of the tank containing the terminal TANK CODE product Yes Yes No Beginning Inventory =AB N Beginning-of-month tank inventory SQL LONG Yes Yes No Fractional Beginning Inventory =AC N Beginning-of-month tank inventory rollover fractional SQL LONG Yes Yes No MTD Bulk Receipts =AD N Month-to-date bulk receipts SQL LONG Yes Yes No Fractional MTD Bulk Receipts =AE N Month-to-date bulk receipts rollover fractional SQL LONG Yes Yes No MTD Rack Receipts =AF N Month-to-date rack receipts SQL LONG Yes Yes No Fractional MTD Rack Receipts =AG N Month-to-date rack receipts rollover fractional SQL LONG Yes Yes No MTD Transfers In =AH N Month-to-date transfers in SQL LONG Yes Yes No Fractional MTD Transfers In =AI N Month-to- date transfers in rollover fractional SQL LONG Yes Yes No MTD Bulk Disposals =AJ N Month-to -date bulk disposals SQL LONG Yes Yes No Fractional MTD Bulk Disposals =AK N Month-to-date bulk disposals rollover fractional SQL LONG Yes Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Domain Ter Sup Cus 47 Outgoing Transactions Field Name Label Type Description / Value Domain Ter Sup Cus MTD Rack Disposals =AL N Month-to-date rack disposals SQL LONG Yes Yes No Fractional MTD Rack Disposals =AM N Month-to- date rack disposals rollover fractional SQL LONG Yes Yes No MTD Transfers Out =AN N Month-to-date transfers out SQL LONG Yes Yes No Fractional MTD Transfers Out =AO N Month-to-date transfers out rollover fractional SQL LONG Yes Yes No Current Inventory =AP N Current tank inventory SQL LONG Yes Yes No Fractional Current Inventory =AQ N Current tank inventory rollover fractional SQL LONG Yes Yes No 2.8.6 EOM Tank Gain/Loss Header Record (05) The EOM Tank Gain/Loss header record is used to specify the number of EOM Tank Gain/Loss records to follow and does not actually contain any data fields. 2.8.7 EOM Tank Gain/Loss Record (06) The order and format of the stream of data sent for an EOM Tank Gain/Loss record are detailed in the following table: Table 2-37 EOM Tank Gain / Loss Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T Tank code of the tank the inventory is for TANK CODE Yes No No Terminal Product =AB Number N Terminal product code for the product in the tank PRODUCT NUMBER Yes No No Method of Measure =AC N Whether the terminal product was measured METHOD OF by volume or mass MEASURE Yes No No Opening Physical =AD N Net quantity of product in the tank at the beginning of the folio Yes No No Bulk Receipts =AE N Net quantity of bulk receipts put into the tank SQL LONG Yes No No Bulk Disposals =AF N Net quantity of bulk disposals taken from the SQL LONG tank Yes No No SQL LONG Bulk Transfers In =AG N Net quantity of bulk transfers into the tank SQL LONG Yes No No Bulk Transfers Out =AH N Net quantity of bulk transfers from the tank SQL LONG Yes No No Rack Receipts =AI N Net quantity of rack receipts put into the tank SQL LONG Yes No No Rack Disposals =AJ N Net quantity of rack disposals taken from the SQL LONG tank Yes No No Closing Physical =AK N Net quantity of product in the tank at the end SQL LONG of the folio Yes No No Manual Closing Physical =AL N Physical net quantity of product in the tank at BOOLEAN ENABLED Yes No the end of the folio No Gain/Loss =AM N Gain or loss for the tank No 48 SQL LONG Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions 2.9 Trip Transaction Sequence (01) When a trip (or order within a trip) is billed, backed out, or rebilled, a Trip transaction sequence is sent to the host. The following table describes the records that make up the sequence: Table 2-38 Trip Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 01 Trip 04 Trip header # of Order or Exchange sequences to follow Order 1 01 Order header Three – one Order Compartment header record, one Allocation header record, and one Order Dispatch header record 11 Order Compartment header # of Order Compartment detail records to follow 02 Order Compartment detail # of Order Recipe records to follow 03 Order Recipe Zero 07 Allocation header # of Allocation detail records to follow 08 Allocation detail Zero 09 Order Dispatch header # of Order Dispatch detail records to follow 10 Order Dispatch detail Zero 05 Exchange header # of Exchange Product records to follow 06 Exchange Product Zero 01 Order header Three – one Order Compartment header record, one Allocation header record, and one Order Dispatch header record 11 Order Compartment header # of Order Compartment detail records to follow 02 Order Compartment detail # of Order Recipe records to follow 03 Order Recipe Zero 07 Allocation header # of Allocation detail records to follow 08 Allocation detail Zero 09 Order Dispatch header # of Order Dispatch detail records to follow 10 Order Dispatch detail Zero 05 Exchange header # of Exchange Product records to follow OR Exchange 1 THEN… Order 2… n OR Exchange 2…n FUEL-FACS+ Host Interface Specification, FBS Version 5.1 49 Outgoing Transactions Transaction Transaction Record Record ID ID 06 Exchange Product Subrecords to Follow Zero The Trip transaction sequence consists of one Trip header record, followed by one or more Order or Exchange transaction sequences. Each Order transaction sequence consists of one header record followed by an Order Compartment header record, an Allocation header record, and an Order Dispatch header record. One or more Order Compartment detail records follow the Order Compartment header record. One or more Order Recipe records follow each Order Compartment detail record. Zero or more Allocation detail records may follow the Allocation header record. Zero or more Order Dispatch detail records may follow the Order Dispatch header record. Each Exchange transaction sequence consists of one Exchange header record followed by a Product record for each terminal product sold. The flow of the Trip transaction sequence is as follows: Trip Header Order Header 1 Order Compartment Header Order 1 Compartment 1 Order 1 Recipe 1 . . . Order 1 Recipe N . . . Order 1 Compartment N Order 1 Recipe 1 . . . Order 1 Recipe N Order Allocation Header Allocation Detail 1 . . . Allocation Detail N Order Dispatch Header Order Dispatch Detail 1 . . . Order Dispatch Detail N OR Exchange Header 1 Exchange 1 Product 1 . . . Exchange 1 Product N Order Header 2 Order Compartment Header Order 2 Compartment 1 50 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Outgoing Transactions Order 2 Recipe 1 . . . Order 2 Recipe N . . . Order 2 Compartment N Order 2 Recipe 1 . . . Order 2 Recipe N Order Allocation Header Allocation Detail 1 . . . Allocation Detail N Order Dispatch Header Order Dispatch Detail 1 . . . Order Dispatch Detail N OR Exchange Header 2 Exchange 2 Product 1 . . . Exchange 2 Product N 2.9.1 Trip Header Record (04) The order and format of the stream of data sent for a Trip header record are detailed in the following table: Table 2-39 Trip Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Trip Movement Number =AA N Unique BOL number for the terminal MOVEMENT NUMBER Yes Yes Yes Delivery Confirmed =AB N Whether the trip was delivered as loaded BOOLEAN DISABLED Yes Yes Yes Delivery Date =AC D Date trip was delivered SQL DATE TIME Opt Opt Opt Delivery Sequence =AD N Order delivery sequence SQL LONG Opt Opt Opt Folio Number =AE N8 Number identifying the folio the trip was loaded in FOLIO NUMBER Yes Yes Yes 8 The format of the folio number is YYYYMMDDD, where YYYY is the year, MM is the month, and DDD is the end-of-day number. The end-of-day number starts at 001 at the beginning of the month, and increases by one each time an end-of-day is performed. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 51 Outgoing Transactions Field Name Label Type Description / Value Domain Remarks =AF Ter Sup Cus T(80) User-defined comment field DESCRIPTION Opt Opt Opt Revision Number =AG N Number of times the trip has been revised SQL LONG Yes Yes Yes Creator Type =AH N Host or local creator CREATOR TYPE Yes Yes Yes User Field 1 =AI N/F/ D/T Optional user field data Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AJ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AK N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AL N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AM N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AN N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AO N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AP N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AQ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Manually Completed =AR N BOOLEAN DISABLED Opt Opt Opt Operation =AS N Host Reference ID =AT Terminal Code =RE 52 Operation being performed for this trip (bill, backout, etc.) HOST OPERATION Yes Yes Yes T EXTERNAL REF ID Opt Opt Opt T TERMINAL CODE Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3 Incoming Transactions 3.1 Incoming Transaction Format The FUEL-FACS+ standard format for data transmitted from a host computer is detailed in the following table: Table 3-1 Incoming Transaction Format Field Picture Description Transaction Number 999999 Identifies each instance of a transaction received Operation X (A)dd, (M)odify, (D)elete, or (?) The (?) operation is only for master file data and means the sending host does not know whether it is an Add or Modify operation. Sending (?) as the operation causes the master file data to be tried first as a Modify operation; if that fails, an Add operation is tried. Transaction ID 99 Defines the type of transaction being received Record ID 99 Defines the type of individual record within a transaction Subrecords to Follow 99 Defines the number of records associated with this record that will follow Data Stream Variable The actual data for the transaction 3.1.1 Incoming Host Types The types and content of the transactions that can be received by the FUEL-FACS+ system from a host computer depend on the type of host configured in the FUEL-FACS+ system. The following table defines the valid incoming host types: Table 3-2 Valid Incoming Host Types Host Terminal Owner Supplier Customer 3.1.2 Incoming Transaction Number The transaction number is a number that is increased by one for each new database transaction received by the FUEL-FACS+ system. This allows FUEL-FACS+ to output a reference number for error/ACK/NAK purposes. All records with the same transaction number are processed together. If one of these records fails, all of them fail. More than one header can use the same transaction number (i.e., transactions are not limited to 99). FUEL-FACS+ Host Interface Specification, FBS Version 5.1 53 Incoming Transactions 3.1.3 Incoming Transaction ID The types of transactions currently supported by the FUEL-FACS+ system and the types of hosts that can send these transactions are detailed in the following table: Table 3-3 Incoming Transaction IDs Transaction Transaction ID Terminal Owner Host Supplier Host Customer Host 01 Database Download Yes – all Yes – only those that apply to that supplier No 02 Dispatch Orders Yes – all Yes – only those that apply to that supplier Yes – only those that apply to the customer 03 Exchanger Allocation Yes – all Yes – only those that apply to that supplier No 04 Customer Allocation Yes – all Yes – only those that apply to that supplier No 05 Destination Allocation Yes – all Yes – only those that apply to that supplier No 09 Planned Bulk Movement Yes – all Yes – only those that apply to that supplier No 12 Business Group Allocation Yes – all Yes – only those that apply to that supplier No 3.1.4 Incoming Record ID Each transaction can be composed of one or more records. The types of records for each of the above transactions are defined in the corresponding section of this document. The FUEL-FACS+ system uses the transaction ID and the number of subrecords to group the incoming data. A data group is deemed to be a set of data with the same transaction ID and the correct number of subrecords, as specified in the record header. A data group may contain multiple header records. If an error occurs in the data or insufficient or surplus records are received, the system does not update the database and returns an error or ACK/NAK to the download routine. 3.1.5 Incoming Data Stream The actual data received in each of the above transactions consists of a variable number of variable-length data fields, each preceded by a unique field label. The purpose of the field label is to allow forward compatibility as new fields are added in new releases of the FUEL-FACS+ system. When FUEL-FACS+ reads the transactions, it searches the data field for only those fields supported and ignores fields that are not required. 54 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions The actual data fields for each transaction are defined in the following sections. Each section describes the transaction and details each record received for the transaction in a table format. The columns of the table are as follows: Table 3-4 Incoming Data Stream Column Description Field Name The name of the data field Label The label preceding the actual value Type The type of data contained in the field; the four types of data currently supported are (N)umeric, (F)loating numeric, (T)ext9, and (D)ate10 Description/Value A general description of the data field The domain in the FUEL-FACS+ Database Specification, where a list of values can be found for each field Domain Ter For a terminal owner host, this column will contain either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. Sup For a supplier host, this column will contain either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. Cus For a customer host, this column will contain either Yes, No, or Opt. Yes indicates that the field is required; Opt indicates that the field is optional; and No indicates that the field is not supported for this host. 3.2 Database Download Transaction Sequence (01) Business database information for a terminal owner or supplier host may be downloaded to the FUEL-FACS+ system. The following table identifies the records that make up the sequence: Table 3-5 Database Download Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 01 # of records to follow, forming a database transaction Database Download 01 Header 02 Terminal Owner Zero 03 Product Group Zero 04 Terminal Product Zero 05 Terminal Hazard Warning Zero 06 Terminal Product Comment Zero 9 Text strings may contain any printable character. Note that if an equal sign (=) is required, this must be prefixed by another equal sign. 10 The format for a date/time is YYYYMMDD<space>HH:mm:SS, where YYYY is the year, MM is the month, DD is the day, HH is the hour, mm is the minute, and SS is the second. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 55 Incoming Transactions Transaction Transaction Record Record ID ID 56 Subrecords to Follow 07 Carrier Zero 08 Trailer Zero 09 Compartment Zero 10 Trailer Limits Zero 11 Driver Zero 12 Supplier Zero 13 Carrier Supplier Zero 14 Bulk Account Zero 15 Hazard Warning Zero 16 Product Comment Zero 17 Supplier Product Zero 18 Exchange Agreement Zero 19 Customer Zero 20 Carrier Customer Zero 21 Customer Product Zero 22 Destination Zero 23 Tractor Zero 24 Customer Credit Zero 25 Contract Zero 26 Contract Exchange Zero 27 Exchange Terminal Product Zero 29 Calendar Zero 32 Injector Zero 33 Meter Zero 34 Preset Zero 35 Supplier Inventory Zero 36 Supplier Product Recipe Zero 37 Tank Zero 38 Tank Strapping Zero 39 User Interface Zero 40 Translate Bulk Account Zero 41 Translate Carrier Zero 42 Translate Customer Zero 43 Translate Destination Zero 44 Translate Driver Zero 45 Translate Product Group Zero 46 Translate Supplier Zero 47 Translate Supplier Product Zero 48 Translate Terminal Product Zero 49 Translate Trailer Zero 50 Translate Tractor Zero FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Transaction Transaction Record Record ID ID Subrecords to Follow 51 Translation Group Zero 86 Carrier Destination Zero 87 Destination Product Zero 88 Business Group Zero 90 Customer Business Group Zero 91 Destination Business Group Zero The Database Download transaction sequence consists of one header record followed by any number of database records. All database record operations under the header record are performed on the database as one transaction; that is, either all the database operations are performed successfully or none are performed. More than one header record can reference the same transaction number. The flow of the Database Download transaction sequence is as follows: Database Download Header Database Record 1 . . . Database Record N . . . Database Download Header Database Record 1 . . . Database Record N 3.2.1 Database Download Header Record (01) The Database Download header record is used to specify the number of database records to follow and does not actually contain any data fields. 3.2.2 Bulk Account Record (14) The order and format of the stream of data sent for the Bulk Account record are detailed in the following table: Table 3-6 Bulk Account Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Bulk Account Number =AB N SUPPLIER NUMBER Yes Yes No Name =AC T NAME Opt Opt No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 57 Incoming Transactions 3.2.3 Business Group Record (88) The order and format of the stream of data sent for the Business Group record are detailed in the following table: Table 3-7 Business Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Business Group Code =AA T BUSINESS GROUP CODE Yes Yes No Description =AB T DESCRIPTION Opt Opt No Use for Credit =AC N BOOLEAN DISABLED Opt Opt No Allocation Enabled =AM N BOOLEAN DISABLED Opt Opt No Allocation by Component =AN N BOOLEAN DISABLED Opt Opt No Allocation by Supplier Product =AO N BOOLEAN DISABLED Opt Opt No Allocation by Supplier Product Group =AP N BOOLEAN DISABLED Opt Opt No Allocation by Terminal Product Group =AQ N BOOLEAN DISABLED Opt Opt No Allocation by Contract =AR N BOOLEAN DISABLED Opt Opt No 3.2.4 Calendar Record (29) The order and format of the stream of data sent for the Calendar record are detailed in the following table: Table 3-8 Calendar Record Field Name Label Type Description / Value Domain Ter Sup Cus Calendar ID =AA N UNIQUE ID Yes No No Date =AB D SQL DATE Opt No No Reason =AC T DESCRIPTION Opt No No 3.2.5 Carrier Record (07) The order and format of the stream of data sent for the Carrier record are detailed in the following table: Table 3-9 Carrier Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No No Access Class =AB T ACCESS CLASS Opt No No BOL Comment 1 =AC T BOL LINE Opt No No BOL Comment 2 =AD T BOL LINE Opt No No Certification Date 1 =AE D SQL DATE TIME Opt No No Certification Date 2 =AF D SQL DATE TIME Opt No No Certification Date 3 =AG D SQL DATE TIME Opt No No Certification Date 4 =AH D SQL DATE TIME Opt No No Certification Date 5 =AI D SQL DATE TIME Opt No No Certification Date 6 =AJ D SQL DATE TIME Opt No No 58 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Certification Date 7 =AK D SQL DATE TIME Opt No No Certification Date 8 =AL D SQL DATE TIME Opt No No Certification Date 9 =AM D SQL DATE TIME Opt No No Dispatch Orders =AN N BOOLEAN DISABLED Opt No No Enter Terminal =AO N BOOLEAN ENABLED Opt No No Fuel Vehicles =AP N BOOLEAN DISABLED Opt No No Lockout Entry =AQ N BOOLEAN DISABLED Opt No No Lockout Entry Reason =AR T DESCRIPTION Opt No No Lockout Loading =AS N BOOLEAN DISABLED Opt No No Lockout Loading Reason =AT T DESCRIPTION Opt No No Multi Product Loading =AU N BOOLEAN ENABLED Opt No No Name =AV T NAME Opt No No Order Required at Gate =AW N BOOLEAN DISABLED Opt No No PIN Required =AX N BOOLEAN DISABLED Opt No No Rack Orders =AY N BOOLEAN ENABLED Opt No No SCAC Code =AZ T CHAR(4) Opt No No PDXR Carrier ID =BA T TABS CARRIER ID Opt No No Trailer Cards =BB N BOOLEAN DISABLED Opt No No Trailer Manual Entry =BC N BOOLEAN ENABLED Opt No No User Field 1 =BD N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 2 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =BL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No Confirm Last Trailer =BM N BOOLEAN ENABLED No Tractor Cards =BN N BOOLEAN DISABLED Opt No No Tractor Manual Entry =BO N BOOLEAN DISABLED Opt No No Confirm Last Tractor =BP N BOOLEAN DISABLED Opt No No Next Order Only =BQ N BOOLEAN DISABLED Opt No No Fueling Default Trailer =BR N TRAILER NUMBER Opt No No Fueling Customer Supplier =BS N SUPPLIER NUMBER Opt No No Fueling Customer Number =BT N CUSTOMER NUMBER Opt No No Fueling Destination Number =BU N DESTINATION NUMBER Opt No No Trips =BV N BOOLEAN DISABLED Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Opt No 59 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus PETROEX Carrier Code =BW T PETROEX CARRIER CODE Opt No No Contract Orders =BX N BOOLEAN DISABLED Opt No No Use Trailer Card Sensor =BY N BOOLEAN DISABLED Opt No No Rack Trip =BZ N BOOLEAN ENABLED Opt No No Recent Customer List Enable =CA N BOOLEAN ENABLED Opt No No PETROEX FEIN =CB T PETROEX_FEIN Opt No No Multi-Trailer Enabled =CC N BOOLEAN DISABLED Opt No No Vehicle Cards =CD N BOOLEAN DISABLED Opt No No Vehicle Manual Entry =CE N BOOLEAN DISABLED Opt No No Confirm Last Vehicle =CF N BOOLEAN DISABLED Opt No No PDXR Carrier FEIN =CG T PDXR_FEIN Opt No No Contract Trip =CH N BOOLEAN DISABLED Opt No No Dispatching Placeholder =CI N BOOLEAN DISABLED Opt No No 3.2.6 Carrier Customer Record (20) The order and format of the stream of data sent for the Carrier Customer record are detailed in the following table: Table 3-10 Carrier Customer Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA Yes Yes No N CARRIER NUMBER Supplier Number =AB N SUPPLIER NUMBER Yes Yes No Customer Number =AC N CUSTOMER NUMBER Yes Yes No Enabled =AD N BOOLEAN ENABLED Opt Opt No Host Carrier Number =AE N CARRIER NUMBER Opt Opt No 3.2.7 Carrier Destination Record (86) The order and format of the stream of data sent for the Carrier Destination record are detailed in the following table: Table 3-11 Carrier Destination Record Field Name Label Type Description / Value Domain Carrier Number =AA N CARRIER NUMBER Yes Yes No Supplier Number =AB N SUPPLIER NUMBER Yes Yes No Customer Number =AC N CUSTOMER NUMBER Yes Yes No Destination Number =AD N DESTINATION NUMBER Opt Opt No Enabled =AE N BOOLEAN ENABLED Opt Opt No 60 Ter Sup Cus FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.2.8 Carrier Supplier Record (13) The order and format of the stream of data sent for the Carrier Supplier record are detailed in the following table: Table 3-12 Carrier Supplier Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes Yes No Supplier Number =AB N SUPPLIER NUMBER Yes Yes No Enabled =AC N BOOLEAN ENABLED Opt Opt No Host Carrier Number =AD N CARRIER NUMBER Opt Opt No Limit Customers =AE N BOOLEAN ENABLED Opt Opt No Limit Destinations =AF N BOOLEAN DISABLED Opt Opt No 3.2.9 Compartment Record (09) The order and format of the stream of data sent for the Compartment record are detailed in the following table: Table 3-13 Compartment Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No No Trailer Number =AB N TRAILER NUMBER Yes No No Compartment Number =AC N COMPARTMENT NUMBER Yes No No Capacity =AD N SQL LONG Opt No No Valid Product Group Code =AE T GROUP CODE Yes No No 3.2.10 Contract Record (25) The order and format of the stream of data sent for the Contract record are detailed in the following table: Table 3-14 Contract Record Field Name Label Type Description / Value Domain Ter Sup Cus Contract Number =AA Yes Yes No N CONTRACT NUMBER Carrier Number =AB N CARRIER NUMBER Opt Opt No Supplier Number =AC N SUPPLIER NUMBER Yes Yes No Customer Number =AD N CUSTOMER NUMBER Yes Yes No Destination Number =AE N DESTINATION NUMBER Opt Opt No Enabled =AG N BOOLEAN ENABLED Opt Opt No Effective Date =AH D SQL DATE TIME Opt Opt No Expiration Date =AI D SQL DATE TIME Opt Opt No Remarks =AJ T DESCRIPTION Opt Opt No User Field 1 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) FUEL-FACS+ Host Interface Specification, FBS Version 5.1 61 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 2 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 7 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =BL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =BM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) 3.2.11 Contract Exchange Record (26) The order and format of the stream of data sent for the Contract Exchange record are detailed in the following table: Table 3-15 Contract Exchange Record Field Name Label Type Description / Value Domain Ter Sup Cus Contract Number =AA N CONTRACT NUMBER Yes Yes No Terminal Product Number =AB N PRODUCT NUMBER Yes Yes No Throughputter =AC N SUPPLIER NUMBER Yes Yes No Exchanger =AD N SUPPLIER NUMBER Yes Yes No 3.2.12 Customer Record (19) The order and format of the stream of data sent for the Customer record are detailed in the following table: Table 3-16 Customer Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Access Class =AC T ACCESS CLASS Opt Opt No Allocation Enabled =AD N BOOLEAN DISABLED Opt Opt No Billing Address 1 =AE T ADDRESS Opt Opt No Billing Address 2 =AF T ADDRESS Opt Opt No Billing Address 3 =AG T ADDRESS Opt Opt No Billing Address 4 =AH T ADDRESS Opt Opt No Billing Type =AI N BILLING TYPE Opt Opt No BOL Comment 1 =AJ T BOL LINE Opt Opt No BOL Comment 2 =AK T BOL LINE Opt Opt No 62 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Credit Enabled =AL N BOOLEAN DISABLED Opt Opt No Credit Limit =AM F SQL FLOAT Opt Opt No Destination Allocation Enabled =AN N BOOLEAN DISABLED Opt Opt No DET Name =AO T NAME Opt Opt No Enabled =AP N BOOLEAN ENABLED Opt Opt No Host Customer Number =AQ N CUSTOMER NUMBER Opt Opt No Host Supplier Number =AR N SUPPLIER NUMBER Opt Opt No Invoice Required =AS N BOOLEAN DISABLED Opt Opt No Lockout Loading =AT N BOOLEAN DISABLED Opt Opt No Lockout Loading Reason =AU T DESCRIPTION Opt Opt No Name =AV T NAME Opt Opt No Phone Number =AW T PHONE NUMBER Opt Opt No Prompt P.O. Number =AX N BOOLEAN DISABLED Opt Opt No Prompt Requisition Number =AY N BOOLEAN DISABLED Opt Opt No Purchase Order Number =AZ T PURCHASE ORDER NUMBER Opt Opt No Requisition Number =BA T PURCHASE ORDER NUMBER Opt Opt No PDXR Consignee Number =BB T TABS CONSIGNEE NUMBER Opt Opt No PDXR Offline Directive =BC N TABS OFFLINE DIRECTIVE Opt Opt No PDXR Subscriber =BD N BOOLEAN DISABLED Opt Opt No User Field 1 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 2 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 7 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =BL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =BM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) PETROEX Number =BN T CHAR(14) Opt Opt No DET Name 2 =BP T NAME Opt Opt No DET Customer Number =BQ N SQL LONG Opt Opt No Numeric P.O./Requisition Numbers =BR N BOOLEAN ENABLED Opt Opt No Print Net on BOL =BS N BOOLEAN ENABLED Opt Opt No PETROEX Consignee Number =BT T PETROEX CONSIGNEE NUMBER Opt Opt No PETROEX Subscriber =BU N BOOLEAN DISABLED Opt Opt No ELVIS Offline Directive =BV N TABS OFFLINE DIRECTIVE Opt Opt No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 63 Incoming Transactions 3.2.13 Customer Business Group Record (90) The order and format of the stream of data sent for the Customer Business Group record are detailed in the following table: Table 3-17 Customer Business Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Business Group Code =AC T BUSINESS GROUP CODE Yes Yes No 3.2.14 Customer Credit Record (24) The order and format of the stream of data sent for the Customer Credit record are detailed in the following table: Table 3-18 Customer Credit Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Credit Amount =AC F SQL FLOAT Yes Yes No Reference Date =AD D SQL DATE TIME Opt Opt No Reference Number =AE T VARCHAR(20) Opt Opt No Remarks =AF T VARCHAR(80) Opt Opt No Entered By =AG T USER NAME Opt Opt No 3.2.15 Customer Product Record (21) The order and format of the stream of data sent for the Customer Product record are detailed in the following table: Table 3-19 Customer Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Product Number =AC N PRODUCT NUMBER Yes Yes No BOL Product Name =AD T VARCHAR(20) Opt Opt No Enabled =AE N BOOLEAN ENABLED Opt Opt No Host Product Number =AF N PRODUCT NUMBER Opt Opt No Price =AG F SQL FLOAT Opt Opt No Product Comment Code =AH T GROUP CODE Opt Opt No PDXR Blend Indicator =AI N TABS BLEND INDICATOR Opt Opt No PDXR Product Code =AJ T TABS PRODUCT CODE Opt Opt No PDXR Product Identifier =AK T TABS PRODUCT IDENTIFIER Opt Opt No 64 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.2.16 Destination Record (22) The order and format of the stream of data sent for the Destination record are detailed in the following table: Table 3-20 Destination Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Destination Number =AC N DESTINATION NUMBER Yes Yes No BOL Comment 1 =AD T BOL LINE Opt Opt No BOL Comment 2 =AE T BOL LINE Opt Opt No Delivery Fee =AF F SQL FLOAT Opt Opt No Enabled =AG N BOOLEAN ENABLED Opt Opt No Host Destination Number =AH N DESTINATION NUMBER Opt Opt No Oxy Fuels Control Area =AI N BOOLEAN DISABLED Opt Opt No Shipping Address 1 =AJ T ADDRESS Opt Opt No Shipping Address 2 =AK T ADDRESS Opt Opt No Shipping Address 3 =AL T ADDRESS Opt Opt No Shipping Address 4 =AM T ADDRESS Opt Opt No Opt Opt No PDXR Consignee Number =AN T TABS CONSIGNEE NUMBER User Field 1 =AO N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 2 =AP N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =AQ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =AR N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =AS N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =AT N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 7 =AU N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =AV N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =AW N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) DET Name =AX T NAME Opt Opt No DET Name 2 =AY T NAME Opt Opt No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 65 Incoming Transactions 3.2.17 Destination Business Group Record (91) The order and format of the stream of data sent for the Destination Business Group record are detailed in the following table: Table 3-21 Destination Business Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Destination Number =AC N DESTINATION NUMBER Yes Yes No Business Group Code =AD T BUSINESS GROUP CODE Yes Yes No 3.2.18 Destination Product Record (87) The order and format of the stream of data sent for the Destination Product record are detailed in the following table: Table 3-22 Destination Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Destination Number =AC N DESTINATION NUMBER Yes Yes No Product Number =AD N PRODUCT NUMBER Yes Yes No 3.2.19 Driver Record (11) The order and format of the stream of data sent for the Driver record are detailed in the following table: Table 3-23 Driver Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No No Driver Number =AB N DRIVER NUMBER Yes No No BOL Comment 1 =AC T BOL LINE Opt No No BOL Comment 2 =AD T BOL LINE Opt No No Card Number =AE T CHAR(20) Opt No No Access Class11 =AF T ACCESS CLASS Opt No No Enabled =AG N BOOLEAN ENABLED Opt No No PIN Lockout11 =AH N BOOLEAN DISABLED Opt No No PIN Number11 =AI N SQL LONG Opt No No PIN Required11 =AJ N BOOLEAN DISABLED Opt No No Certification Date 1 =AK D SQL DATE TIME Opt No No 11 11 66 Only valid if the driver is assigned a card. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Certification Date 2 =AL D SQL DATE TIME Opt No No Certification Date 3 =AM D SQL DATE TIME Opt No No Certification Date 4 =AN D SQL DATE TIME Opt No No Certification Date 5 =AO D SQL DATE TIME Opt No No Certification Date 6 =AP D SQL DATE TIME Opt No No Certification Date 7 =AQ D SQL DATE TIME Opt No No Certification Date 8 =AR D SQL DATE TIME Opt No No Certification Date 9 =AS D SQL DATE TIME Opt No No Enter Terminal =AT N BOOLEAN ENABLED Opt No No Fuel Tractor =AU N BOOLEAN DISABLED Opt No No Initials =AV T CHAR(3) Opt No No License Number =AW T CHAR(10) Opt No No Lockout Entry =AX N BOOLEAN DISABLED Opt No No Lockout Entry Reason =AY T DESCRIPTION Opt No No Lockout Loading =AZ N BOOLEAN DISABLED Opt No No Lockout Loading Reason =BA T DESCRIPTION Opt No No Meter Prover =BB N BOOLEAN DISABLED Opt No No Meter Totalizer =BC N BOOLEAN DISABLED Opt No No Multi-Product Loading =BD N BOOLEAN ENABLED Opt No No Name =BE T NAME Opt No No User Field 1 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 2 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =BL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =BM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =BN N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No Next Order Only =BO N BOOLEAN DISABLED Opt No No Cancel Order =BP N BOOLEAN DISABLED Opt No No Multi-Loading Limit =BQ N SQL LONG Opt No No Recent Customer List Enable =BR N BOOLEAN ENABLED Opt No No Repeat Last Comm Info =BS N BOOLEAN DISABLED Opt No No Repeat Last Compartment Info =BT N BOOLEAN DISABLED Opt No No Global Lockout =BU N BOOLEAN DISABLED Opt No No Global Lockout Reason =BV T DESCRIPTION Opt No No Lockout Due to Trailer Misuse =BW N BOOLEAN DISABLED Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 67 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus PDXR Rack Driver ID =BX T PDXR_DRIVER_ID Opt No No Multi-Trailer Enabled =BY N BOOLEAN DISABLED Opt No No 3.2.20 Exchange Agreement Record (18) The order and format of the stream of data sent for the Exchange Agreement record are detailed in the following table: Table 3-24 Exchange Agreement Record Field Name Label Type Description / Value Domain Ter Sup Cus Throughputter =AA N SUPPLIER NUMBER Yes Yes No Exchanger =AB N SUPPLIER NUMBER Yes Yes No Ehost Thru Number =AC N SUPPLIER NUMBER Opt Opt No Exchange Enable =AD N BOOLEAN ENABLED Opt Opt No Thost Exch Number =AE N SUPPLIER NUMBER Opt Opt No Transfer Enable =AF N BOOLEAN ENABLED Opt Opt No 3.2.21 Exchange Terminal Product Record (27) The order and format of the stream of data sent for the Exchange Terminal Product record are detailed in the following table: Table 3-25 Exchange Terminal Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Throughputter =AA SUPPLIER NUMBER Yes Yes No N Exchanger =AB N SUPPLIER NUMBER Yes Yes No Terminal Product Number =AC N PRODUCT NUMBER Yes Yes No Priority =AD N SQL LONG Opt Opt No 3.2.22 Hazard Warning Record (15) The order and format of the stream of data sent for the Hazard Warning record are detailed in the following table: Table 3-26 Hazard Warning Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA SUPPLIER NUMBER Yes Yes No N Hazard Warning Code =AB T GROUP CODE Yes Yes No BOL Comment 1 =AC T BOL LINE Opt Opt No BOL Comment 2 =AD T BOL LINE Opt Opt No BOL Comment 3 =AE T BOL LINE Opt Opt No 68 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.2.23 Injector Record (32) The order and format of the stream of data sent for the Injector record are detailed in the following table: Table 3-27 Injector Record Field Name Label Type Description / Value Domain Ter Sup Cus Preset Code =AA T HARDWARE TYPE Yes No No Injector Code =AB T HARDWARE TYPE Yes No No Meter Code =AC T HARDWARE TYPE Opt No No Tank Code =AD T TANK CODE Opt No No Pump Code =AE T HARDWARE TYPE Opt No No Terminal Product Number =AF N PRODUCT NUMBER Opt No No Injector Number =AG N SQL LONG Opt No No Controlled By =AH N CONTROLLED BY Opt No No Downstream =AI N BOOLEAN DIASABLED Opt No No Shot Size =AJ F SQL FLOAT Opt No No Fixed Rate =AK N BOOLEAN ENABLED Opt No No Protocol Type =AL N INJECTOR PROTOCOL Opt No No Rate =AM N SQL LONG Opt No No Port Name =AN T PORT NAME Opt No No Address =AO N SQL LONG Opt No No Totalizer Rollover =AP N SQL LONG Opt No No EOD Manual Totalizer Enable =AQ N BOOLEAN DIASABLED Opt No No DDE Enable DSN =AR T DDE DATA SOURCE NAME Opt No No DDE Enable Item =AS T DDE ITEM Opt No No DDE Rate DSN =AT T DDE DATA SOURCE NAME Opt No No DDE Rate Item =AU T DDE ITEM Opt No No DDE Quantity DSN =AV T DDE DATA SOURCE NAME Opt No No DDE Quantity Item =AW T DDE ITEM Opt No No User DLL =AX T USER DLL Opt No No User Routine =AY T USER ROUTINE Opt No No DDE Pump DSN =AZ T DDE DATA SOURCE NAME Opt No No DDE Pump Item =BA T DDE ITEM Opt No No Unaccounted Alarm =BB N SQL LONG Opt No No Enabled =BC N BOOLEAN ENABLED Opt No No Fractional Totalizer Rollover =BD N SQL LONG Opt No No Verify Injector Totalizer Flag =BE N BOOLEAN DISABLED Opt No No Alarm Limit Enable =BF N BOOLEAN DISABLED Opt No No Limit Injector Alarms =BG N SQL LONG Opt No No DDE Alarm Pause DSN =BH T DDE DATA SOURCE NAME Opt No No DDE Alarm Pause Item =BI T DDE ITEM Opt No No DDE Alarm Terminate DSN =BJ T DDE DATA SOURCE NAME Opt No No DDE Alarm Terminate Item =BK T DDE ITEM Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 69 Incoming Transactions 3.2.24 Meter Record (33) The order and format of the stream of data sent for the Meter record are detailed in the following table: Table 3-28 Meter Record Field Name Label Type Description / Value Domain Ter Sup Cus Preset Code =AA T HARDWARE TYPE Yes No No Meter Code =AB T HARDWARE TYPE Yes No No Tank Code =AC T TANK CODE Opt No No Pump Code =AD T HARDWARE TYPE Opt No No Terminal Product Number =AE N PRODUCT NUMBER Opt No No Meter Number =AF N SQL LONG Opt No No Temperature Low Alarm =AG F SQL FLOAT Opt No No Temperature High Alarm =AH F SQL FLOAT Opt No No Override Temperature =AI F SQL FLOAT Opt No No Override Temperature Enable =AJ N BOOLEAN DIASABLED Opt No No Totalizer Rollover =AK N SQL LONG Opt No No Override Density Enable =AL N BOOLEAN DISABLED Opt No No EOD Manual Totalizer Enable =AM N BOOLEAN DISABLED Opt No No Unaccounted Alarm =AN N SQL LONG Opt No No DDE Enable DSN =AO T DDE DATA SOURCE NAME Opt No No DDE Enable Item =AP T DDE ITEM Opt No No DDE Blend Percent DSN =AQ T DDE DATA SOURCE NAME Opt No No DDE Blend Percent Item =AR T DDE ITEM Opt No No DDE Override Density Enable DSN =AS T DDE DATA SOURCE NAME Opt No No DDE Override Density Enable Item =AT T DDE ITEM Opt No No DDE Override Density DSN =AU T DDE DATA SOURCE NAME Opt No No DDE Override Density Item =AV T DDE ITEM Opt No No DDE Override Temperature Enable DSN =AW T DDE DATA SOURCE NAME Opt No No DDE Override Temperature Enable Item =AX T DDE ITEM Opt No No DDE Override Temperature DSN =AY T DDE DATA SOURCE NAME Opt No No DDE Override Temperature Item =AZ T DDE ITEM Opt No No DDE API Table DSN =BA T DDE DATA SOURCE NAME Opt No No DDE API Table Item =BB T DDE ITEM Opt No No DDE Gross DSN =BC T DDE DATA SOURCE NAME Opt No No DDE Gross Item =BD DDE ITEM Opt No No T DDE Net DSN =BE T DDE DATA SOURCE NAME Opt No No DDE Net Item =BF T DDE ITEM Opt No No DDE Temperature DSN =BG T DDE DATA SOURCE NAME Opt No No DDE Temperature Item =BH T DDE ITEM Opt No No 70 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus DDE Density DSN =BI T DDE DATA SOURCE NAME Opt No No DDE Density Item =BJ T DDE ITEM Opt No No DDE Pump DSN =BK T DDE DATA SOURCE NAME Opt No No DDE Pump Item =BL T DDE ITEM Opt No No Densitometer =BM N BOOLEAN DISABLED Opt No No Enabled =BN N BOOLEAN ENABLED Opt No No Totalizer Meter Code =BO T HARDWARE TYPE Opt No No Totalizer Meter Enable =BP N BOOLEAN DISABLED Opt No No Blend Only =BQ N BOOLEAN DISABLED Opt No No Override Density =BR F SQL FLOAT Opt No No Override Density Source =BS N OVERRIDE SOURCE Opt No No Override Temperature Source =BT N OVERRIDE SOURCE Opt No No DDE Override Density Upload DSN =BU T DDE DATA SOURCE NAME Opt No No DDE Override Density Upload Item =BV T DDE ITEM Opt No No DDE Override Temperature Upload DSN =BW T DDE DATA SOURCE NAME Opt No No DDE Override Temperature Upload Item =BX T DDE ITEM Opt No No Minimum Load Quantity =BY N SQL LONG Opt No No Blend Percent =BZ F SQL FLOAT Opt No No 3.2.25 Preset Record (34) The order and format of the stream of data sent for the Preset record are detailed in the following table: Table 3-29 Preset Record Field Name Label Type Description / Value Domain Ter Sup Cus Preset Code =AA T HARDWARE TYPE Yes No No Right Bay =AB T USER INTERFACE CODE Opt No No Left Bay =AC T USER INTERFACE CODE Opt No No Right Bay Order Entry =AD N BOOLEAN DISABLED Opt No No Enabled =AE N BOOLEAN ENABLED Opt No No Protocol Type =AF N PRESET PROTOCOL TYPE Opt No No Left Bay Order Entry =AG N BOOLEAN DISABLED Opt No No Port =AH T PORT NAME Opt No No Address =AI N SQL LONG Opt No No Blend Upstream =AJ N BOOLEAN DISABLED Opt No No Blending Required =AK N BOOLEAN DISABLED Opt No No In Line Blend =AL N BOOLEAN ENABLED Opt No No Sequential Blend =AM N BOOLEAN ENABLED Opt No No On Truck Blend =AN N BOOLEAN ENABLED Opt No No Minimum Load Quantity =AO N SQL LONG Opt No No DDE Quantity DSN =AP T DDE DATA SOURCE NAME Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 71 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus DDE Quantity Item =AQ T DDE ITEM Opt No No DDE Start DSN =AR T DDE DATA SOURCE NAME Opt No No DDE Start Item =AS T DDE ITEM Opt No No DDE Complete DSN =AT T DDE DATA SOURCE NAME Opt No No DDE Complete Item =AU T DDE ITEM Opt No No User DLL =AV T USER DLL Opt No No User Routine =AW T USER ROUTINE Opt No No No Flow Timeout =AX N SQL LONG Opt No No DDE Right Swing Arm DSN =AY T DDE DATA SOURCE NAME Opt No No DDE Right Swing Arm Item =AZ T DDE ITEM Opt No No DDE Right Swing Arm Polarity =BA N SQL LONG Opt No No DDE Left Swing Arm DSN =BB T DDE DATA SOURCE NAME Opt No No DDE Left Swing Arm Item =BC T DDE ITEM Opt No No DDE Left Swing Arm Polarity =BD N SQL LONG Opt No No Manual Quantity Enable =BE N BOOLEAN DISABLED Opt No No Left Swing Arm Preset Input =BF N SQL LONG Opt No No Right Swing Arm Preset Input =BG N SQL LONG Opt No No Language Translation DLL =BH T USER DLL Opt No No Language Translation Routine =BI T USER ROUTINE Opt No No Prompting Device =BJ N BOOLEAN ENABLED Opt No No DDE Prompt Number DSN =BK T DDE DATA SOURCE NAME Opt No No DDE Prompt Number Item =BL T DDE ITEM Opt No No DDE Prompt Type DSN =BM T DDE DATA SOURCE NAME Opt No No DDE Prompt Type Item =BN T DDE ITEM Opt No No DDE Prompt Reply Type DSN =BO T DDE DATA SOURCE NAME Opt No No DDE Prompt Reply Type Item =BP T DDE ITEM Opt No No DDE Prompt Reply Value DSN =BQ T DDE DATA SOURCE NAME Opt No No DDE Prompt Reply Value Item T DDE ITEM Opt No No =BR DDE Prompt Text DSN =BS T DDE DATA SOURCE NAME Opt No No DDE Prompt Text Item =BT T DDE ITEM Opt No No Flush Meter Code =BU T HARDWARE TYPE Opt No No Flush Quantity =BV N SQL LONG Opt No No Clean Line =BW N BOOLEAN ENABLED Opt No No High Flow Rate =BX N SQL LONG Opt No No Restricted High Flow Rate =BY N SQL LONG Opt No No Verify Injector Totalizer Flag =BZ N BOOLEAN DISABLED Opt No No Load Limit =CA N SQL LONG Opt No No Low Flow Rate =CB N SQL LONG Opt No No Restricted Low Flow Rate =CC N SQL LONG Opt No No Reverse Blend Sequence =CD N BOOLEAN DISABLED Opt No No Proving Mode =CE N BOOLEAN DISABLED Opt No No External Additive Masking =CF N BOOLEAN DISABLED Opt No No User Field 1 =CG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No 72 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 2 =CH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =CI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =CJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =CK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =CL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =CM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =CN N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =CO N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No 3.2.26 Product Comment Record (16) The order and format of the stream of data sent for the Product Comment record are detailed in the following table: Table 3-30 Product Comment Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Product Comment Code =AB T GROUP CODE Yes Yes No BOL Comment 1 =AC T BOL LINE Opt Opt No BOL Comment 2 =AD T BOL LINE Opt Opt No BOL Comment 3 =AE T BOL LINE Opt Opt No 3.2.27 Product Group Record (03) The order and format of the stream of data sent for the Product Group record are detailed in the following table: Table 3-31 Product Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Product Group Code =AA T GROUP CODE Yes No No Name =AB T PRODUCT NAME Opt No No Summer Maximum Quantity =AC N SQL LONG Opt No No Winter Maximum Quantity =AD N SQL LONG Opt No No VRU Time Period =AE N SQL LONG Opt No No VRU Limit =AF N SQL LONG Opt No No VRU Timeout =AG N SQL LONG Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 73 Incoming Transactions 3.2.28 Supplier Record (12) The order and format of the stream of data sent for the Supplier record are detailed in the following table: Table 3-32 Supplier Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Address 1 =AB T ADDRESS Opt Opt No Address 2 =AC T ADDRESS Opt Opt No Address 3 =AD T ADDRESS Opt Opt No Address 4 =AE T ADDRESS Opt Opt No Allocation Alarm Limit =AF N SQL LONG Opt Opt No BOL Comment 1 =AG T BOL LINE Opt Opt No BOL Comment 2 =AH T BOL LINE Opt Opt No Customer Allocation by Component Group =AI N BOOLEAN DISABLED Opt Opt No Customer Allocation by Component =AJ N BOOLEAN DISABLED Opt Opt No Customer Allocation by Product =AK N BOOLEAN ENABLED Opt Opt No Customer Allocation by Product =AL Group N BOOLEAN DISABLED Opt Opt No Customer Allocation Enabled =AM N BOOLEAN DISABLED Opt Opt No Destination Allocation Enabled =AN N BOOLEAN DISABLED Opt Opt No Exchange Allocation by Product =AO N BOOLEAN ENABLED Opt Opt No Exchange Allocation by Product =AP Group N BOOLEAN DISABLED Opt Opt No Exchange Allocation Enabled =AR N BOOLEAN DISABLED Opt Opt No Host Supplier Number =AS N SUPPLIER NUMBER Opt Opt No Limit by Customer Product =AT N BOOLEAN DISABLED Opt Opt No Load Full Compartment =AU N BOOLEAN DISABLED Opt Opt No Lockout Loading =AV N BOOLEAN DISABLED Opt No No No Lockout Loading Reason =AW T DESCRIPTION Opt No Name =AX T NAME Opt Opt No Shipping Phone =BA T PHONE NUMBER Opt Opt No PDXR Seller ID =BB T TABS SELLER ID Opt Opt No User Field 1 =BC N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 2 =BD N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) 74 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 7 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) PETROEX Company Code =BL T PETROEX COMPANY CODE Opt Opt No Contract Allocation Enabled =BM N BOOLEAN DISABLED Opt No No ELVIS Subscriber =BN N BOOLEAN DISABLED Opt No No 3.2.29 Supplier Inventory Record (35) The order and format of the stream of data sent for the Supplier Inventory record are detailed in the following table: Table 3-33 Supplier Inventory Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Terminal Product Number =AB N PRODUCT NUMBER Yes Yes No Host Product Code =AC T HOST CODE Opt Opt No Enabled =AD N BOOLEAN ENABLED Opt Opt No Negative Allowance =AE N SQL LONG Opt Opt No PETROEX Component Product =AF Code T PETROEX COMPONENT PRODUCT CODE Opt Opt No Buy from Exchange Agreement =AG N BOOLEAN DISABLED Opt Opt No Opt Opt No Percent Tank Share =AH F SQL FLOAT User Field 1 =AI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 2 =AJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =AK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =AL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =AM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =AN N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 7 =AO N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =AP N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =AQ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) FUEL-FACS+ Host Interface Specification, FBS Version 5.1 75 Incoming Transactions 3.2.30 Supplier Product Record (17) The order and format of the stream of data sent for the Supplier Product record are detailed in the following table: Table 3-34 Supplier Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Product Number =AB N PRODUCT NUMBER Yes Yes No Blend Out of Tolerance =AC N BLEND OUT OF TOLERANCE Opt Opt No Clean Fuel =AD N BOOLEAN DISABLED Opt Opt No Enabled =AE N BOOLEAN ENABLED Opt Opt No Hazard Warning Code =AF T GROUP CODE Opt Opt No Name =AG T PRODUCT NAME Opt Opt No Octane =AH F SQL FLOAT Opt Opt No On Truck Sequential Enabled =AI N BOOLEAN ENABLED Opt Opt No Preset Sequential Enabled =AJ N BOOLEAN ENABLED Opt Opt No Price =AK F SQL FLOAT Opt Opt No Product Comment Code =AL T GROUP CODE Opt Opt No Product Group Code =AM T GROUP CODE Opt Opt No Ratio Blending Enabled =AN N BOOLEAN ENABLED Opt Opt No Requires Intervention =AO N BOOLEAN DISABLED Opt Opt No PDXR Blend Indicator =AP N TABS BLEND INDICATOR Opt Opt No PDXR Product Code =AQ T TABS PRODUCT CODE Opt Opt No PDXR Product Identifier =AR T TABS PRODUCT IDENTIFIER Opt Opt No Terminal Hazard Warning =AS T GROUP CODE Opt Opt No Terminal Product Comment =AT T GROUP CODE Opt Opt No Opt Opt No Upstream Blending Enabled =AU N BOOLEAN ENABLED User Field 1 =AV N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 2 =AW N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 3 =AX N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 4 =AY N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 5 =AZ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 6 =BA N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 7 =BB N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 8 =BC N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) User Field 9 =BD N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt Opt No DATE TIME / VARCHAR(40) PETROEX Blend Indicator =BE N PETROEX BLEND INDICATOR Opt Opt No PETROEX Product Code =BF T PETROEX PRODUCT CODE 76 Opt Opt No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Overweight Trailer =BG Opt Opt No N OVERWEIGHT TRAILER 3.2.31 Supplier Product Recipe Record (36) The order and format of the stream of data sent for the Supplier Product Recipe record are detailed in the following table: Table 3-35 Supplier Product Recipe Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Product Number =AB N PRODUCT NUMBER Yes Yes No Terminal Product Number =AD N PRODUCT NUMBER Yes Yes No Component ID =AE N UNIQUE ID Yes Yes No Blend Percent =AF F SQL FLOAT Opt Opt No Rate =AG N SQL LONG Opt Opt No Blend Tolerance =AH F SQL FLOAT Opt Opt No Blend Sequence =AI N SQL LONG Opt Opt No Upper Deviation =AJ N SQL LONG Opt Opt No Lower Deviation =AK N SQL LONG Opt Opt No Host Product Code =AL T HOST CODE Opt Opt No Host Product Name =AM T VARCHAR(20) Opt Opt No Minus Blend Tolerance =AN F SQL FLOAT Opt Opt No Additive Masking =AO N BOOLEAN DISABLED Opt Opt No 3.2.32 Tank Record (37) The order and format of the stream of data sent for the Tank record are detailed in the following table: Table 3-36 Tank Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T TANK CODE Yes No Name =AB T VARCHAR(20) Opt No No Warehouse Number =AC N MARINE WAREHOUSE NUMBER Opt No No Terminal Product Number =AD N PRODUCT NUMBER Opt No No Enable =AE N BOOLEAN ENABLED Opt No No Shell Capacity =AF N SQL LONG Opt No No Work Capacity =AG N SQL LONG Opt No No Depth =AH T TANK LEVEL Opt No No Auto Enable =AI N BOOLEAN DISABLED Opt No No Deadband =AJ N SQL LONG Opt No No Auto Level Enable =AK N BOOLEAN DISABLED Opt No No No DDE Level DSN =AL T DDE DATA SOURCE NAME Opt No No DDE Level Item =AM T DDE ITEM Opt No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 77 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Auto Density Enable =AN N BOOLEAN DISABLED Opt No No Auto Temperature Enable =AO N BOOLEAN DISABLED Opt No No Auto Quantity Enable =AP N BOOLEAN DISABLED Opt No No DDE Density DSN =AQ T DDE DATA SOURCE NAME Opt No No DDE Density Item =AR T DDE ITEM Opt No No DDE Temperature DSN =AS T DDE DATA SOURCE NAME Opt No No DDE Temperature Item =AT T DDE ITEM Opt No No DDE Quantity DSN =AU T DDE DATA SOURCE NAME Opt No No DDE Quantity Item =AV T DDE ITEM Opt No No Send to Host at EOD =AW N BOOLEAN ENABLED Opt No No Pipe Fill =AX N SQL LONG Opt No No Protocol Type =AY N TANK PROTOCOL TYPE Opt No No Port Name =AZ T PORT NAME Opt No No Address =BA N SQL LONG Opt No No Remarks =BB T DESCRIPTION Opt No No Fast Scan =BC N BOOLEAN DISABLED Opt No No User DLL =BD T USER DLL Opt No No User Routine =BE T USER ROUTINE Opt No No Roof Correction Type =BF N ROOF CORRECTION TYPE Opt No No Roof Take Off Level =BG T TANK LEVEL Opt No No Roof Support Level =BH T TANK LEVEL Opt No No Roof Reference Density =BI F SQL FLOAT Opt No No Roof Above Adjustment =BJ F SQL FLOAT Opt No No Roof Below Adjustment =BK F SQL FLOAT Opt No No Strapping Inverted =BL N BOOLEAN DISABLED Opt No No DDE High Alarm DSN =BM T DDE DATA SOURCE NAME Opt No No DDE High Alarm Item =BN T DDE ITEM Opt No No DDE High High Alarm DSN =BO T DDE DATA SOURCE NAME Opt No No DDE High High Alarm Item =BP T DDE ITEM Opt No No DDE Low Alarm DSN =BQ T DDE DATA SOURCE NAME Opt No No DDE Low Alarm Item =BR T DDE ITEM Opt No No DDE Low Low Alarm DSN =BS T DDE DATA SOURCE NAME Opt No No DDE Low Low Alarm Item =BT T DDE ITEM Opt No No DDE Cutoff Alarm DSN =BU T DDE DATA SOURCE NAME Opt No No DDE Cutoff Alarm Item =BV T DDE ITEM Opt No No DDE Status DSN =BW T DDE DATA SOURCE NAME Opt No No DDE Status Item =BX T DDE ITEM Opt No No Auto Pressure Enable =BY N BOOLEAN DISABLED Opt No No Auto Mass Enable =BZ N BOOLEAN DISABLED Opt No No Download Enable =CA N BOOLEAN DISABLED Opt No No Download Level Enable =CB N BOOLEAN DISABLED Opt No No Download Quantity Enable =CC N BOOLEAN DISABLED Opt No No Download Temperature Enable =CD N BOOLEAN DISABLED Opt No No Download Pressure Enable N BOOLEAN DISABLED Opt No No 78 =CE FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Download Mass Enable =CF N BOOLEAN DISABLED Opt No No Manual Quality Enable =CG N BOOLEAN DISABLED Opt No No Auto BSW Level Enable =CH N BOOLEAN DISABLED Opt No No Auto BSW Quantity Enable =CI N BOOLEAN DISABLED Opt No No DDE BSW Level DSN =CJ T DDE DATA SOURCE NAME Opt No No DDE BSW Level Item =CK T DDE ITEM Opt No No DDE BSW Quantity DSN =CL T DDE DATA SOURCE NAME Opt No No DDE BSW Quantity Item =CM T DDE ITEM Opt No No Download Density Enable =CN N BOOLEAN DISABLED Opt No No Virtual Tank =CO N BOOLEAN DISABLED Opt No No DDE in Service DSN =CP T DDE DATA SOURCE NAME Opt No No DDE in Service Item =CQ T DDE ITEM Opt No No Tank Group =CR T TANK CODE Opt No No Auto Net Quantity Enable =CS N BOOLEAN DISABLED Opt No No DDE Net Quantity DSN =CT T DDE DATA SOURCE NAME Opt No No DDE Net Quantity Item =CU T DDE ITEM Opt No No Manual Net Quantity Enable =CV N BOOLEAN DISABLED Opt No No DDE BSW High Alarm DSN =CW T DDE DATA SOURCE NAME Opt No No DDE BSW High Alarm Item =CX T DDE ITEM Opt No No Shell Material Type =CY N SHELL MATERIAL TYPE Opt No No Shell Base Temperature =CZ F SQL FLOAT Opt No No Insulated =DA N BOOLEAN DISABLED Opt No No Level Units =DB N LEVEL UNITS Opt No No Majority Shareholder =DC N SUPPLIER NUMBER Opt No No Setpoint Quantity Enable =DD N BOOLEAN UNKNOWN Opt No No Roof Weight =DE N SQL LONG Opt No No User Field 1 =DF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 2 =DG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =DH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =DI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =DJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =DK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =DL N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =DM N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =DN N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 79 Incoming Transactions 3.2.33 Tank Strapping Record (38) The order and format of the stream of data sent for the Tank Strapping record are detailed in the following table: Table 3-37 Tank Strapping Record Field Name Label Type Description / Value Domain Ter Sup Cus Tank Code =AA T TANK CODE Yes No No Tank Level =AB T TANK LEVEL Yes No No Quantity =AC N SQL LONG Yes No No Strap Type =AF N STRAP TYPE Yes No No 3.2.34 Terminal Hazard Warning Record (05) The order and format of the stream of data sent for the Terminal Hazard Warning record are detailed in the following table: Table 3-38 Terminal Hazard Warning Record Field Name Label Type Description / Value Domain Ter Sup Cus Hazard Warning Code =AA T GROUP CODE Yes No No BOL Comment 1 =AB T BOL LINE Opt No No BOL Comment 2 =AC T BOL LINE Opt No No BOL Comment 3 =AD T BOL LINE Opt No No 3.2.35 Terminal Owner Record (02) The Terminal Owner record provides general information about the terminal. The order and format of the stream of data sent for the Terminal Owner record are detailed in the following table: Table 3-39 Terminal Owner Record Field Name Domain Ter Sup Cus BOL Comment 1 =AA T BOL LINE Opt No No BOL Comment 2 =AB T BOL LINE Opt No No BOL Company Name =AC T BOL LINE Opt No No BOL Emergency =AD Contact T BOL LINE Opt No No BOL Manager Initials =AE T CHAR(3) Opt No No Book Reference =AF Temperature N SQL LONG Yes No No EOD Automatic =AG N BOOLEAN ENABLED Opt No No EOD Automatic Time =AH D SQL TIME Opt No No EOD Driver Time =AI N SQL LONG Yes No No EOM on Last Day N BOOLEAN ENABLED Opt No No 80 Label Type Description / Value =AJ FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Flag Auto Preset =AK N BOOLEAN DISABLED Opt No No Flag BOL =AL Required to Exit N BOOLEAN DISABLED Opt No No Flag in Terminal =AM Enable N BOOLEAN DISABLED Opt No No Flag Inventory Source =AN N INVENTORY SOURCE Opt No No Flag Order Card =AO Required N BOOLEAN DISABLED Opt No No Flag Summer =AP N BOOLEAN ENABLED Opt No No Flag Unit of Measure =AQ N UNIT OF MEASURE Opt No No Limit Fast Scan Tanks =AR N SQL LONG Yes No No Limit Max Companyfuel =AS N SQL LONG Yes No No Limit Percent Allocation =AT F SQL FLOAT Yes No No Limit Percent Load Complete =AU N SQL LONG Yes No No Limit PIN Retries =AV N SQL LONG Yes No No Limit Purge Keep Days =AW N SQL LONG Yes No No Limit Slow Scan =AX Tanks N SQL LONG Yes No No Owner Name 1 T NAME Opt No No =AY Used to configure the maximum amount of product that can be loaded in a single “company use” or “fuel island” order Owner Name 2 =AZ T NAME Opt No No Percent Tank Share =BA N BOOLEAN ENABLED Yes No No Report Banner =BB T VARCHAR(40) Opt No No Terminal Address 1 =BC T ADDRESS Opt No No Terminal Address 2 =BD T ADDRESS Opt No No Terminal Address 3 =BE T ADDRESS Opt No No Terminal Address 4 =BF T ADDRESS Opt No No Terminal Code =BG T TERMINAL_CODE Yes No No Terminal Name =BH T NAME Opt No No Time Bay Inactivity =BI N SQL LONG Yes No No Time Card Inactivity Days =BJ N SQL LONG Yes No No Time in Terminal =BK N SQL LONG Yes No No Time Memo Interval =BL N SQL LONG Yes No No Time to Load =BM N SQL LONG Yes No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 81 Incoming Transactions Field Name Label Type Description / Value Domain User Field 1 =BN N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 2 =BO N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 3 =BP N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 4 =BQ N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 5 =BR N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 6 =BS N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 7 =BT N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 8 =BU N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No User Field 9 =BV N/F/ D/T Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) No N SQL LONG Yes No No VRU Min Risers =BX N SQL LONG Yes No No Flag Use DET Customer =BY N BOOLEAN DISABLED Yes No No DET Select Supplier =CA N BOOLEAN ENABLED Yes No No DET Select Trailer =CB N BOOLEAN ENABLED Yes No No DET Select Customer =CC N BOOLEAN ENABLED Yes No No DET Select Destination =CD N BOOLEAN ENABLED Yes No No DET Select Product =CE N BOOLEAN ENABLED Yes No No Check Allocation =CF Type N CHECK ALLOCATION Opt No TYPE No Minimum Allocation Quantity =CG N SQL LONG Opt No No Report Reference Temperature =CH F SQL FLOAT Yes No No Interrupted =CI Loading Restart N BOOLEAN ENABLED Yes No No Units Per Barrel =CJ F SQL FLOAT No VRU Max Risers =BW 82 Ter Sup Cus Yes No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Contract Orders =CK N SQL LONG Yes No No Terminal Phone =CL Number T PHONE NUMBER Yes No No Terminal FAX Number T PHONE NUMBER Yes No No =CM 3.2.36 Terminal Product Record (04) The order and format of the stream of data sent for the Terminal Product record are detailed in the following table: Table 3-40 Terminal Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Terminal Product Number =AA N PRODUCT NUMBER Yes No No API Code =AB T API CODE Yes No No Certification Rate =AC N SQL LONG Opt No No Enabled =AD N BOOLEAN ENABLED Opt No No Method of Measure =AE N METHOD OF MEASURE Opt No No Name =AF T PRODUCT NAME Opt No No Octane =AG F SQL FLOAT Opt No No Oxygenator =AH N BOOLEAN DISABLED Opt No No Product Group Code =AI T GROUP CODE Yes No No Requires VRU =AJ N BOOLEAN DISABLED Opt No No Type =AK N TERMINAL PRODUCT TYPE Opt No No User Field 1 =AL N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 2 =AM N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 3 =AN N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 4 =AO N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 5 =AP N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 6 =AQ N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 7 =AR N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 8 =AS N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No User Field 9 =AT N/F/D/ T SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Opt No No PETROEX Product =AU Code T PETROEX PRODUCT CODE Opt No No Calculate Mass/Volume N BOOLEAN DISABLED Opt No No =AV FUEL-FACS+ Host Interface Specification, FBS Version 5.1 83 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Product Density Label =AW T LABEL Opt No No Additive WCF =AX F SQL FLOAT Opt No No 3.2.37 Terminal Product Comment Record (06) The order and format of the stream of data sent for the Terminal Product Comment record are detailed in the following table: Table 3-41 Terminal Product Comment Record Field Name Label Type Description / Value Domain Ter Sup Cus Product Comment Code =AA T GROUP CODE Yes No BOL Comment 1 =AB T BOL LINE Opt No No BOL Comment 2 =AC T BOL LINE Opt No No BOL Comment 3 =AD T BOL LINE Opt No No No 3.2.38 Tractor Record (23) The order and format of the stream of data sent for the Tractor record are detailed in the following table: Table 3-42 Tractor Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No No Tractor Number =AB N TRACTOR NUMBER Yes No No Card Number =AC T CHAR(20) Opt No No 12 Access Class =AD T ACCESS CLASS Opt No No Enabled12 =AE N BOOLEAN ENABLED Opt No No PIN Lockout12 =AF N BOOLEAN DISABLED Opt No No PIN Number12 =AG N SQL LONG Opt No No PIN Required12 =AH N BOOLEAN DISABLED Opt No No Certification Date 1 =AI D SQL DATE TIME Opt No No Certification Date 2 =AJ D SQL DATE TIME Opt No No Certification Date 3 =AK D SQL DATE TIME Opt No No Certification Date 4 =AL D SQL DATE TIME Opt No No Certification Date 5 =AM D SQL DATE TIME Opt No No Certification Date 6 =AN D SQL DATE TIME Opt No No Certification Date 7 =AO D SQL DATE TIME Opt No No Certification Date 8 =AP D SQL DATE TIME Opt No No Certification Date 9 =AQ D SQL DATE TIME Opt No No Fueling Product Number =AS N PRODUCT NUMBER Opt No No Fueling Supplier Number =AT N SUPPLIER NUMBER Opt No No 12 84 Only valid if the tractor is assigned a card. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus License =AU T CHAR(10) Opt No No Lockout Entry =AV N BOOLEAN DISABLED Opt No No Lockout Entry Reason =AW T DESCRIPTION Opt No No Lockout Loading =AX N BOOLEAN DISABLED Opt No No Lockout Loading Reason =AY T DESCRIPTION Opt No No Serial Number =AZ T CHAR(18) Opt No No State =BA T CHAR(10) Opt No No User Field 1 =BB N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 2 =BC N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =BD N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No 3.2.39 Trailer Record (08) The order and format of the stream of data sent for the Trailer record are detailed in the following table: Table 3-43 Trailer Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No No Trailer Number =AB N TRAILER NUMBER Opt No No Card Number =AC T CHAR(20) Opt No No =AD T ACCESS CLASS Opt No No 13 Access Class 13 Enabled =AE N BOOLEAN ENABLED Opt No No PIN Lockout13 =AF N BOOLEAN DISABLED Opt No No 13 =AG N SQL LONG Opt No No =AH N BOOLEAN DISABLED Opt No No PIN Number PIN Required13 Certification Date 1 =AI D SQL DATE TIME Opt No No Certification Date 2 =AJ D SQL DATE TIME Opt No No Certification Date 3 =AK D SQL DATE TIME Opt No No 13 Only valid if the trailer is assigned a card. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 85 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Certification Date 4 =AL D SQL DATE TIME Opt No No Certification Date 5 =AM D SQL DATE TIME Opt No No Certification Date 6 =AN D SQL DATE TIME Opt No No Certification Date 7 =AO D SQL DATE TIME Opt No No Certification Date 8 =AP D SQL DATE TIME Opt No No Certification Date 9 =AQ D SQL DATE TIME Opt No No Enter Terminal =AR N BOOLEAN DISABLED Opt No No Fueling Product Number =AS N PRODUCT NUMBER Opt No No Fueling Supplier Number =AT N SUPPLIER NUMBER Opt No No License =AU T CHAR(10) Opt No No Lockout Entry =AV N BOOLEAN DISABLED Opt No No Lockout Entry Reason =AW T DESCRIPTION Opt No No Lockout Loading =AX N BOOLEAN DISABLED Opt No No Lockout Loading Reason =AY T DESCRIPTION Opt No No Serial Number =AZ T CHAR(18) Opt No No State =BA T CHAR(10) Opt No No PDXR Truck Number =BB T TABS TRUCK NUMBER Opt No No User Field 1 =BC N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 2 =BD N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 3 =BE N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 4 =BF N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 5 =BG N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 6 =BH N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 7 =BI N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 8 =BJ N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No User Field 9 =BK N/F/ D/T SQL LONG / SQL FLOAT / SQL Opt No DATE TIME / VARCHAR(40) No Loading Type =CA N LOADING TYPE Opt No No Host Trailer Code =CB T CHAR(15) Opt No No Host Alternate Trailer Code =CC T CHAR(15) Opt No No Requires Intervention =CD N BOOLEAN DISABLED Opt No No PETROEX Truck Number =CE N PETROEX TRUCK NUMBER Opt No No Usable Capacity =CF N SQL LONG Opt No No Multi-Loading Limit =CG N SQL LONG Opt No No Max Tare Weight =CH N SQL LONG Opt No No Global Lockout =CI N BOOLEAN DISABLED Opt No No Global Lockout Reason =CJ T DESCRIPTION Opt No No Requires Restricted Flow =CK N BOOLEAN DISABLED Opt No No Requires Restricted Low Flow =CL N BOOLEAN DISABLED Opt No No 86 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus PETROEX Vehicle Type =CM T PETROEX VEHICLE TYPE Opt No No Unladen Weight =CN N SQL LONG Opt No No Maximum Weight =CO N SQL LONG Opt No No 3.2.40 Trailer Limits Record (10) The order and format of the stream of data sent for the Trailer Limits record are detailed in the following table: Table 3-44 Trailer Limits Record Field Name Label Type Description / Value Domain Ter Sup Cus Carrier Number =AA N CARRIER NUMBER Yes No Trailer Number =AB N TRAILER NUMBER Yes No No Product Group Code =AC T GROUP CODE Yes No No Summer Maximum Quantity =AD N SQL LONG Opt No No Winter Maximum Quantity =AE N SQL LONG Opt No No No 3.2.41 Translate Bulk Account Record (40) The order and format of the stream of data sent for the Translate Bulk Account record are detailed in the following table: Table 3-45 Translate Bulk Account Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA Yes No No T TRANSLATION GROUP CODE Supplier Number =AA N SUPPLIER NUMBER Yes No No Bulk Account Number =AB N SUPPLIER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.42 Translate Carrier Record (41) The order and format of the stream of data sent for the Translate Carrier record are detailed in the following table: Table 3-46 Translate Carrier Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Carrier Number =AA N CARRIER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 87 Incoming Transactions 3.2.43 Translate Customer Record (42) The order and format of the stream of data sent for the Translate Customer record are detailed in the following table: Table 3-47 Translate Customer Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Supplier Number =AA N SUPPLIER NUMBER Yes No No Customer Number =AB N CUSTOMER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.44 Translate Destination Record (43) The order and format of the stream of data sent for the Translate Destination record are detailed in the following table: Table 3-48 Translate Destination Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Supplier Number =AA N SUPPLIER NUMBER Yes No No Customer Number =AB N CUSTOMER NUMBER Yes No No Destination Number =AC N DESTINATION NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.45 Translate Driver Record (44) The order and format of the stream of data sent for the Translate Driver record are detailed in the following table: Table 3-49 Translate Driver Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA Yes No T TRANSLATION GROUP CODE No Carrier Number =AA N CARRIER NUMBER Yes No No Driver Number =AA N DRIVER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 88 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.2.46 Translate Product Group Record (45) The order and format of the stream of data sent for the Translate Product Group record are detailed in the following table: Table 3-50 Translate Product Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Product Group Code =AA T GROUP CODE Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.47 Translate Supplier Record (46) The order and format of the stream of data sent for the Translate Supplier record are detailed in the following table: Table 3-51 Translate Supplier Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Supplier Number =AA N SUPPLIER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.48 Translate Supplier Product Record (47) The order and format of the stream of data sent for the Translate Supplier Product record are detailed in the following table: Table 3-52 Translate Supplier Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Supplier Number =AA N SUPPLIER NUMBER Yes No No Product Number =AB N PRODUCT NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.49 Translate Terminal Product Record (48) The order and format of the stream of data sent for the Translate Terminal Product record are detailed in the following table: Table 3-53 Translate Terminal Product Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Terminal Product =AA N PRODUCT NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 89 Incoming Transactions 3.2.50 Translate Tractor Record (50) The order and format of the stream of data sent for the Translate Tractor record are detailed in the following table: Table 3-54 Translate Tractor Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Carrier Number =AA N CARRIER NUMBER Yes No No Tractor Number =AB N TRACTOR NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.51 Translate Trailer Record (49) The order and format of the stream of data sent for the Translate Trailer record are detailed in the following table: Table 3-55 Translate Trailer Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Carrier Number =AA N CARRIER NUMBER Yes No No Trailer Number =AB N TRAILER NUMBER Yes No No Translated Value =TB T TRANSLATED VALUE Yes No No 3.2.52 Translation Group Record (51) The order and format of the stream of data sent for the Translation Group record are detailed in the following table: Table 3-56 Translation Group Record Field Name Label Type Description / Value Domain Ter Sup Cus Translation Group Code =TA T TRANSLATION GROUP CODE Yes No No Group Description =AA T DESCRIPTION Yes No No 90 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.2.53 User Interface Record (39) The order and format of the stream of data sent for the User Interface record are detailed in the following table: Table 3-57 User Interface Record Field Name Label Type Description / Value Domain Ter Sup Cus User Interface Code =AA T USER INTERFACE CODE Yes No No Card Sensor Code =AB T VARCHAR(10) Yes No No Printer 1 =AC T VARCHAR(10) Yes No No Display Device Code =AD T VARCHAR(10) Yes No No Type =AE N USER INTERFACE CODE Yes No No Enabled =AF N BOOLEAN ENABLED Yes No No Description =AG T DESCRIPTION Yes No No Printer 2 =AH T VARCHAR(10) Yes No No Printer 3 =AI T VARCHAR(10) Yes No No Document User Interface =AJ T VARCHAR(10) Yes No No User Defined =AK N BOOLEAN DISABLED Yes No No User DLL =AL T USER DLL Yes No No User Routine =AM T USER ROUTINE Yes No No Assume Last Tractor =AN N BOOLEAN DISABLED Yes No No Assume Last Trailer =AO N BOOLEAN DISABLED Yes No No Default Sensor Contact Use =AP N SENSOR CONTACT USE Yes No No Trailer Card Sensor Code =AQ T CHAR(10) Yes No No User Field 1 =AR N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 2 =AS N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 3 =AT N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 4 =AU N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 5 =AV N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 6 =AW N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 7 =AX N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 8 =AY N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No User Field 9 =AZ N/F/ D/T SQL LONG / SQL FLOAT / SQL Yes No DATE TIME / VARCHAR(40) No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 91 Incoming Transactions 3.3 Dispatch Order Transaction Sequence (02) To add a dispatch order to the FUEL-FACS+ database, the host sends a Dispatch Order transaction sequence. An order can be dispatched by product or compartment. If the order is part of a trip, the host must send a Trip transaction sequence prior to the dispatch orders that make up the trip. The following table identifies the transaction records that make up the sequence: Table 3-58 Dispatch Order Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 02 Two – one Dispatch Order Product header record and one Dispatch Order Exchange header record Dispatch Order 01 Dispatch Order header 04 Dispatch Order Product # of Dispatch Order Product header records to follow 02 Dispatch Order Product Zero 05 Dispatch Order Exchange header # of Dispatch Order Exchange records to follow 06 Dispatch Order Exchange Zero The Dispatch Order transaction sequence consists of one Dispatch Order header transaction record, followed by one Dispatch Order Product header record, followed by a Dispatch Order Product transaction record for each product or compartment to be loaded. The Dispatch Order Product transaction records are followed by one Dispatch Order Exchange header record. This is followed by zero or more optional Dispatch Order Exchange transaction records. The following figure shows the flow of the Dispatch Order transaction sequence: Dispatch Order Header Dispatch Order Product Header Dispatch Order Product 1 . . . Dispatch Order Product N Dispatch Order Exchange Header Dispatch Order Exchange 1 . . . Dispatch Order Exchange N 92 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.3.1 Dispatch Order Header Record (01) The order and format of the stream of data sent for a Dispatch Order header transaction record are detailed in the following table: Table 3-59 Dispatch Order Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N Supplier number of the supplier host in the FUEL-FACS+ database SUPPLIER NUMBER Yes Yes Yes Carrier Number =AC N Carrier number of the carrier the order is being dispatched to CARRIER NUMBER Yes Yes Yes Trailer Number =AD N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the first Opt Opt No Loading Driver Number =AE N Driver number of the driver requested to load DRIVER NUMBER the order Opt Opt No Delivering Driver =AF Number N Driver number of the driver requested to deliver the order DRIVER NUMBER Opt Opt Opt Customer Number =AG N Customer number of the customer the order is being dispatched to CUSTOMER NUMBER Yes Yes Yes Destination Number =AH N Destination number of the destination to receive the order DESTINATION NUMBER Yes Yes Yes Type =AI N Order type (disposal, receipt, or company use) ORDER TYPE Yes Yes Yes Purchase Order Number =AJ T Purchase order number to use for the order PURCHASE ORDER NUMBER Opt Opt Opt Requisition Number =AK T Requisition number to use for the order PURCHASE ORDER NUMBER Opt Opt Opt BOL Comment 1 =AL T Comment to print on the BOL, line 1 BOL LINE Opt Opt Opt BOL Comment 2 =AM T Comment to print on the BOL, line 2 BOL LINE Opt Opt Opt Invoice Comment 1 =AN T Comment to print on the invoice, line 1 BOL LINE Opt Opt Opt Invoice Comment 2 =AO T Comment to print on the invoice, line 2 BOL LINE Opt Opt Opt Destination Comment 1 =AP T Comment to print on the BOL, line 1 BOL LINE Opt Opt Opt Destination Comment 2 =AQ T Comment to print on the BOL, line 2 BOL LINE Opt Opt Opt Movement Number =AR N Movement number of the order BOL NUMBER Yes Yes Yes Tractor Number =AS N TRACTOR NUMBER Opt Opt Opt Invoice Required =AT N BOOLEAN DISABLED Opt Opt Opt Delivery Fee =AU F SQL FLOAT Bill Freight =AV N BOOLEAN ENABLED Opt Opt Opt Delivery Date =AW D SQL DATE TIME Shift =AX N SQL LONG Opt Opt Opt Stop =AY N SQL LONG Opt Opt Opt Remarks =AZ T CHAR(80) Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Opt Opt Opt Opt Opt Opt 93 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Trip Movement Number =BA N MOVEMENT NUMBER Opt Opt Opt User Field 1 =BB N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =BC N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =BD N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =BE N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =BF N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =BG N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =BH N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =BI N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =BJ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) T BOL LINE FAN Comment 1 =BK FAN Comment 2 =BL T Second Trailer Number =BS N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the second Opt Opt No Third Trailer Number =BT N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the third Opt Opt No Preload Flag =BU N BOOLEAN DISABLED Opt Opt Opt User Field 10 =BV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =BW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =BX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =BY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 94 BOL LINE Opt Opt Opt Opt Opt Opt FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions User Field 14 =BZ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =CA N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =CB N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =CC N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =CD N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =CE N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =CF N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Host Reference ID =CG T EXTERNAL_REF_ID Fourth Trailer Number =CH N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the fourth Opt Opt No Fifth Trailer Number =CI N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the fifth Opt Opt No Sixth Trailer Number =CJ N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the sixth Opt Opt No Seventh Trailer Number =CK N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the seventh Opt Opt No Eighth Trailer Number =CL N TRAILER NUMBER Trailer the order is being dispatched to; required if by compartment, optional otherwise; when multiple trailers exist, this is the eighth Opt Opt No Opt Opt Opt 3.3.2 Dispatch Order Product Header Record (04) The Dispatch Order Product header record is used to indicate the number of Dispatch Order Product records to follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 95 Incoming Transactions 3.3.3 Dispatch Order Product Record (02) The order and format of the stream of data sent for a Dispatch Order Product transaction record are detailed in the following table: Table 3-60 Dispatch Order Product Record Field Name Label Type Description / Value Domain Ter Sup Cus PRODUCT NUMBER Yes Yes Yes Product Number =AA N Product number of the product to be delivered Compartment Number =AB N If by compartment, the compartment number COMPARTMENT of the trailer the product is to be loaded into NUMBER Opt Opt No Quantity =AC N Gross quantity of the product to be loaded SQL LONG Yes Yes Yes Duty Status =AD N Customs duty to be applied DUTY STATUS Opt Opt Opt Trailer Number =AE N If by compartment, the number of the trailer TRAILER NUMBER associated with the compartment number for the product to be loaded into User Field 1 =AF N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AG N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AH N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AI N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AJ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AK N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AL N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AM N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AN N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 10 =AO N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 96 Opt Opt No FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions User Field 13 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =AY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 3.3.4 Dispatch Order Exchange Header Record (05) The Dispatch Order Exchange header record is used to indicate the number of Dispatch Order Exchange records that follow and does not actually contain any data fields. 3.3.5 Dispatch Order Exchange Record (06) The Dispatch Order Exchange transaction record defines all or part of the first-tier exchange agreements for each terminal product in the dispatch order. Note that Dispatch Order Exchange records are optional. All exchange information for an order that is not filled in at dispatch time is completed when the order is loaded. Any exchange information specified at dispatch time is honored when the order is loaded, unless no exchange agreement is required for a specified terminal product. That is, if order exchange information is defined at dispatch time for a terminal product, but at loading time the terminal product is available from the supplier for the order, then no exchange agreements are used for that terminal product. All dispatch-time exchange information for that terminal product is deleted from the order to make the order consistent with the suppliers actually used for the order. All dispatch exchange information is validated at load time against current master file data, including supplier inventory and exchange agreement information. If the dispatch information does not satisfy business rule requirements, the order fails AIC validations and cannot be loaded. The order and format of the stream of data sent for a Dispatch Order Exchange transaction record are detailed in the following table: FUEL-FACS+ Host Interface Specification, FBS Version 5.1 97 Incoming Transactions Table 3-61 Dispatch Order Exchange Record Field Name Label Type Description / Value Domain Ter Sup Cus Terminal Product =AA Number N Terminal product number for the product being exchanged PRODUCT NUMBER Yes Yes No Throughputter N Supplier number of the supplier selling the specified terminal product to the end supplier, which is now an exchanger for this transaction SUPPLIER NUMBER Yes Yes No =AB 3.4 Allocation Transaction Sequence These transactions have a similar format consisting of an allocation type record (Exchanger, Customer, Destination, or Business Group), followed by an Allocation Detail header record, Allocation detail records, and optionally for each Allocation detail record, a Detail Override header and Allocation Detail Override records. Table 3-62 Allocation Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow Depends on type One – the Allocation Detail header Allocation 01 Allocation header 04 Allocation Detail header # of Allocation Detail records to follow 02 Allocation Detail record Zero, or one if Allocation Detail Override header follows 05 Allocation Detail Override header # of Allocation Detail Override records to follow 03 Allocation Detail Override Zero The transaction ID in the header record (record ID 01) uniquely identifies the allocation type; the remaining records have the same format for all allocation types. The next record is an Allocation Detail header that specifies the number of Allocation Detail records to follow. Each Allocation Detail record can optionally be followed by an Allocation Detail Override header record that indicates the number of Allocation Detail Override records to follow. The flow of the Allocation transaction sequence is as follows: Allocation Header (type: Exchange, Customer, Destination, Group) Allocation Detail Header 1 Allocation Detail Record 1 Allocation Detail Override Header 1 Allocation Detail Override Record . . . Allocation Detail Override Record Allocation Detail Record 2 Allocation Detail Override Header 2 Allocation Detail Override Record . . . 98 Business 1.1 1.N 2.1 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Allocation Detail Override Record 2.N Allocation Detail Record N 3.4.1 Allocation Header Types These are the first records in an Allocation transaction sequence with a record ID of 01. 3.4.1.1 Exchanger Allocation Transaction To add an allocation between a throughputter and an exchanger to the FUEL-FACS+ database, the host sends an Exchanger Allocation transaction sequence. The following tables show the format of the first record in an Exchanger Allocation sequence: Table 3-63 Exchanger Allocation Transaction Transaction Transaction Record Record ID ID Subrecords to Follow 03 One – the Allocation Detail header Exchanger Allocation 01 Header The order and format of the stream of data sent for the Exchanger Allocation header record are detailed in the following table: Table 3-64 Exchanger Allocation Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Throughputter =AA N SUPPLIER NUMBER Yes Yes No Exchanger =AB N SUPPLIER NUMBER Yes Yes No =AC T GROUP CODE Opt Opt No Terminal Product Number =AD N PRODUCT NUMBER Opt Opt No Enabled =AE N BOOLEAN ENABLED Opt Opt No 14 Product Group Code 14 Percent Override =AF F SQL FLOAT Opt Opt No Allow Grace Load =AG N BOOLEAN DISABLED Opt Opt No Product Group Type =AH N PRODUCT GROUP TYPE Opt Opt No Refer to Section 3.4.2 for details on the remainder of the Allocation transaction sequence. 3.4.1.2 Customer Allocation Transaction To add an allocation between a supplier and a customer to the FUEL-FACS+ database, the host sends a Customer Allocation transaction sequence. The following table shows the format of the first record in a Customer Allocation sequence: 14 Either a product group code or terminal product number can be specified, but not both. If both a product group code and terminal product number are on allocation, then multiple Exchanger Allocation transaction sequences must be sent. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 99 Incoming Transactions Table 3-65 Customer Allocation Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 04 One — the Allocation Detail header Customer Allocation 01 Header The order and format of the stream of data sent for the Customer Allocation header record are detailed in the following table: Table 3-66 Customer Allocation Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No 15 Product Group Code =AC T GROUP CODE Opt Opt No Product Number15 =AD N PRODUCT NUMBER Opt Opt No Terminal Product Number =AE N PRODUCT NUMBER Opt Opt No Enabled =AF N BOOLEAN ENABLED Opt Opt No 15 Percent Override =AG F SQL FLOAT Opt Opt No Contract Number =AH N CONTRACT NUMBER Opt Opt No By Dates =AI T Allow Grace Load =AK N Opt Opt No BOOLEAN DISABLED Opt Opt No Refer to Section 3.4.2 for details on the remainder of the Allocation transaction sequence. 3.4.1.3 Destination Allocation Transaction To add an allocation between a supplier and a destination to the FUEL-FACS+ database, the host sends a Destination Allocation transaction sequence. The following table shows the format of the first record in a Destination Allocation sequence: Table 3-67 Destination Allocation Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 05 One – the Allocation Detail header Destination Allocation 01 Header The order and format of the stream of data sent for the Allocation header record are detailed in the following table: Table 3-68 Destination Allocation Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Supplier Number =AA N SUPPLIER NUMBER Yes Yes No Customer Number =AB N CUSTOMER NUMBER Yes Yes No Destination Number =AC N DESTINATION NUMBER Yes Yes No 15 Either a product group code, product number, or terminal product number can be specified, but not more than one. If more than one is required, then multiple Customer Allocation transaction sequences must be sent. 100 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Product Group Code =AD T GROUP CODE Opt Opt No Product Number15 =AE N PRODUCT NUMBER Opt Opt No Terminal Product Number =AF N PRODUCT NUMBER Opt Opt No Enabled =AG N BOOLEAN ENABLED Opt Opt No 15 15 Percent Override =AH F SQL FLOAT Opt Opt No Contract Number =AI N CONTRACT NUMBER Opt Opt No By Dates =AJ T Allow Grace Load =AK N Opt Opt No BOOLEAN DISABLED Opt Opt No Refer to Section 3.4.2 for details on the remainder of the Allocation transaction sequence. 3.4.1.4 Business Group Allocation Transaction To add an allocation between a supplier and a business group to the FUEL-FACS+ database, the host sends a Business Group Allocation transaction sequence. The following table shows the format of the first record in a Business Group Allocation sequence: Table 3-69 Business Group Allocation Transaction Sequence Transaction Transaction Record Record ID ID 01 Header 12 Business Group Allocation Subrecords to Follow One – the Allocation Detail header The order and format of the stream of data sent for the Business Group Allocation header record are detailed in the following table: Table 3-70 Business Group Allocation Header Record Field Name Business Group Code Product Group Code16 Product Supplier Number Product Number16 Terminal Product Number16 Enabled Percent Override Contract Number Allow Grace Load Label =AA =AB =AC =AD =AE =AF =AG =AH =AI Type Description / Value T T N N N N F T N Domain BUSINESS GROUP CODE GROUP CODE SUPPLIER_NUMBER PRODUCT NUMBER PRODUCT NUMBER BOOLEAN ENABLED SQL FLOAT CONTRACT NUMBER BOOLEAN DISABLED Ter Yes Opt Opt Opt Opt Opt Opt Opt Opt Sup Yes Opt Opt Opt Opt Opt Opt Opt Opt Cus No No No No No No No No No Refer to Section 3.4.2 for details on the remainder of the Allocation transaction sequence. 16 Either a product group code, supplier product number, or terminal product number can be specified, but not more than one. If more than one is required, then multiple Business Group Allocation transaction sequences must be sent. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 101 Incoming Transactions 3.4.2 Allocation Detail Header Record (04) The Allocation Detail header record is used to specify the number of Allocation detail records that follow and does not actually contain any data fields. 3.4.3 Allocation Detail Record (02) The order and format of the stream of data sent for the Allocation detail record are detailed in the following table: Table 3-71 Allocation Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus Duration Units =AA N DURATION UNITS Opt Opt No Effective Date =AB D SQL DATE TIME Opt Opt No Enabled =AC N BOOLEAN ENABLED Opt Opt No Expiration Date =AD D SQL DATE TIME Opt Opt No Number of Periods =AE N SQL LONG Opt Opt No Period Duration =AF N SQL LONG Opt Opt No Quantity =AG N SQL LONG Opt Opt No Type =AH N ALLOCATION DETAIL TYPE Opt Opt No Reference ID =AI T VARCHAR(40) Opt Opt No Enable Previous Period Carryover =AK N BOOLEAN DISABLED Opt Opt No 3.4.4 Allocation Detail Override Header Record (05) The Allocation Detail Override header record is used to specify the number of Allocation Detail Override records that follow and does not actually contain any data fields. 3.4.5 Allocation Detail Override Record (03) The order and format of the stream of data sent for the Allocation Detail Override record are detailed in the following table: Table 3-72 Allocation Detail Override Record Field Name Label Type Description / Value Domain Ter Sup Cus Reference ID =AA N DURATION UNITS Yes Yes No Effective Date =AB D SQL DATE TIME Opt Opt No Expiration Date =AC D SQL DATE TIME Opt Opt No Enabled =AD N BOOLEAN ENABLED Opt Opt No Percent Override =AE N SQL FLOAT Opt Opt No 102 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions 3.5 Dispatch Trip Transaction Sequence (02) To add a trip to the FUEL-FACS+ database, the host sends a Trip transaction sequence. Note that the host must send all Trip transactions before sending any Dispatch Order transactions that reference the trip movement number. The following table identifies the transaction records that make up the sequence. The table shows a typical transaction sequence in which the Trip transaction is followed by a Dispatch Order transaction for an order in the trip. Table 3-73 Dispatch Trip Transaction Sequence Transaction Transaction Record Record ID ID Subrecords to Follow 02 Dispatch Trip header # of Dispatch Order transaction sequences to follow 01 Dispatch Order header Two – one Dispatch Order Product header record and one Dispatch Order Exchange header record 04 Dispatch Order Product # of Dispatch Order Product header records to follow Dispatch Trip 03 02 Dispatch Order Product Zero 05 Dispatch Order Exchange header # of Dispatch Order Exchange records to follow 06 Dispatch Order Exchange Zero The Dispatch Trip transaction sequence consists of a Dispatch Trip header transaction record, followed by one or more Dispatch Order header or data transaction records. The flow of the Dispatch Trip transaction sequence is as follows: Dispatch Trip 1 Header Dispatch Order 1 Header Dispatch Order 1 Product Header Dispatch Order 1 Product 1 . . Dispatch Order 1 Product N Dispatch Order 1 Exchange Header Dispatch Order 1 Exchange 1 . . . Dispatch Order 1 Exchange N Dispatch Order 2 Header Dispatch Order 2 Product Header Dispatch Order 2 Product 1 . . Dispatch Order 2 Product N Dispatch Order 2 Exchange Header FUEL-FACS+ Host Interface Specification, FBS Version 5.1 103 Incoming Transactions Dispatch Order 2 Exchange 1 . . . Dispatch Order 2 Exchange N 3.5.1 Dispatch Trip Header Record (03) The order and format of the stream of data sent for a Dispatch Trip header transaction record are detailed in the following table: Table 3-74 Dispatch Trip Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Movement Number =AA Movement number of the trip MOVEMENT NUMBER Yes Yes Yes N BOL Comment 1 =AB T Comment to print on the BOL – line 1 BOL LINE Opt Opt Opt BOL Comment 2 =AC T Comment to print on the BOL – line 2 BOL LINE Opt Opt Opt SQL DATE TIME Delivery Date =AD D Delivery date for the trip Delivery Sequence =AE N Sequence of delivery for the orders in the trip SQL LONG Remarks Opt Opt Opt Opt Opt Opt =AF T General-purpose field for remarks DESCRIPTION Opt Opt Opt FAN Comment 1 =AG T Comment to print on the filling advice notice (FAN) – line 1 BOL LINE Opt Opt Opt FAN Comment 2 =AH T Comment to print on the FAN – line 2 BOL LINE Opt Opt Opt User Field 1 =AI N/F/ User-defined data – field 1 D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AJ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AK N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AL N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AM N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AN N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AO N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AP N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AQ N/F/ D/T Opt Opt Opt SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 10 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 104 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus User Field 11 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =AY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =AZ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =BA N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =BB N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Host Reference ID =BC T EXTERNAL REF ID Opt Opt Opt 3.6 Planned Bulk Movement Transaction Sequence (09) To add a planned bulk movement to the FUEL-FACS+ database, the host sends a Planned Bulk Movement transaction sequence. The following table identifies the transaction records that make up the Planned Bulk Movement transaction sequence: FUEL-FACS+ Host Interface Specification, FBS Version 5.1 105 Incoming Transactions Table 3-75 Planned Bulk Movement Transaction Sequence Transaction Transaction Record Record ID ID 09 Planned Bulk 01 Movement Subrecords to Follow Planned Bulk Movement One – the Planned header header 04 Planned header # of Planned detail records to follow 07 Planned detail Zero The Planned Bulk Movement transaction sequence consists of one Planned Bulk Movement header record followed by a Planned header record. The Planned header record is followed by a Planned detail record for each planned tank/terminal product in the bulk movement. The flow of the Planned Bulk Movement transaction sequence is as follows: Planned Bulk Movement Header Planned Header Planned Detail 1 . . . Planned Detail N Note that Bulk Transfer transactions contain exactly two Bulk Movement Planned records—one source record and one destination record. 3.6.1 Planned Bulk Movement Header Record (01) The order and format of the stream of data sent for a Planned Bulk Movement header record are detailed in the following table: Table 3-76 Planned Bulk Movement Header Record Field Name Label Type Description / Value Domain Ter Sup Cus Bulk Account Number17 =AA N Refer to Table 3-77 Bulk Movement Types in SUPPLIER NUMBER section 3.6.1.1 Opt Opt No From Supplier Number =AB N Refer to Table 3-77 Bulk Movement Types in SUPPLIER NUMBER section 3.6.1.1 Opt Opt No To Supplier Number =AC N Refer to Table 3-77 Bulk Movement Types in SUPPLIER NUMBER section 3.6.1.1 Opt Opt No Type =AD N Bulk disposal, receipt, or transfer BULK MOVEMENT TYPE Yes Yes No Reference Number =AE T Reference number entered for the bulk movement VARCHAR(20) Yes Yes No Movement Number =AF N Unique BOL number for the terminal BOL NUMBER Yes Yes No Movement Date =AJ D Date and time the bulk movement was entered SQL DATE TIME Yes Yes No 17 Within this table, the term “bulk account” is defined as the account number of an entity not defined within FUEL-FACS+ that received or sent the bulk movement, such as a refinery, a barge, a pipeline, or a particular company. 106 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions Field Name Label Type Description / Value Domain Ter Sup Cus Vessel =AK T Vessel from/to which the bulk movement was CHAR(20) transferred, if entered Opt Opt No DOC Operator Code =AL T DOC operator code entered for the bulk movement CHAR(10) Opt Opt No Batch Voyage Number =AM T Batch voyage number entered for the bulk movement CHAR(10) Opt Opt No User Field 1 =AO N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 8 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) Host Reference ID =AX T VARCHAR(20) Opt Opt No Remarks =AZ T VARCHAR(80) Opt Opt No 3.6.1.1 Bulk Movement Types The following table describes, for each type of bulk movement, whether the bulk account, “from” supplier, and “to” supplier are present in the transaction: Table 3-77 Bulk Movement Types Bulk Movement Type Bulk Account From Supplier To Supplier Receipt Yes No Yes Disposal Yes Yes No Transfer No Yes Yes 3.6.2 Planned Bulk Movement Planned Header Record (04) The Planned Bulk Movement Planned header record is used to specify the number of Planned Bulk Movement Planned detail records to follow and does not actually contain any data fields. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 107 Incoming Transactions 3.6.3 Planned Bulk Movement Planned Detail Record (07) The order and format of the stream of data sent for a Planned Bulk Movement Planned detail record are detailed in the following table: Table 3-78 Planned Bulk Movement Planned Detail Record Field Name Label Type Description / Value Domain Ter Sup Cus Orientation =AA N Direction of product movement for this planned record; only pertinent for bulk transfers; each transfer should have exactly one source and one destination record; ignored for bulk receipts and disposals because orientation is implied by their movement type MARINE TANK ORIENTATION Opt Opt No Tank Code =AB T Tank code of the tank the terminal product will be delivered from/to TANK CODE Opt Opt No Terminal Product =AC Number N Terminal product number for the product in the tank PRODUCT NUMBER Yes Yes No Planned Date Time =AD D Date/time the product movement is planned to occur TERMINAL PRODUCT TYPE Opt Opt No Planned Quantity =AE N Primary planned quantity for the product movement SQL LONG Yes Yes No Quantity Type =AF N Type of units represented by the Planned Quantity INVENTORY QTY TYPE Yes Yes No Alternate Planned Quantity =AG N Alternate, optional planned quantity for the product movement SQL LONG Opt Opt No Alternate Quantity Type =AH N Type of units represented by the alternate planned quantity; required if alternate planned quantity is provided INVENTORY QTY TYPE Opt Opt No Remarks =AI T General remarks about the product movement DESCRIPTION Opt Opt No User Field 1 =AJ N/F/ Optional user field data D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 2 =AK N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 3 =AL N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 4 =AM N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 5 =AN N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 6 =AO N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 7 =AP N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) 108 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Incoming Transactions User Field 8 =AQ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 9 =AR N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 10 =AS N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 11 =AT N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 12 =AU N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 13 =AV N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 14 =AW N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 15 =AX N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 16 =AY N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 17 =AZ N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 18 =BA N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 19 =BB N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) User Field 20 =BC N/F/ D/T Opt Opt No SQL LONG / SQL FLOAT / SQL DATE TIME / VARCHAR(40) FUEL-FACS+ Host Interface Specification, FBS Version 5.1 109 Host File Import/Export Procedures 4 Host File Import/Export Procedures 4.1 Host Transports Host transactions can be imported and exported by means of three types of transport: ASCII file, transaction per file, and HostDB. 4.2 ASCII Files ASCII files can be imported and exported by the host interface. 4.2.1 ASCII Import Procedure The following procedure should be used to import ASCII files: 1. The ASCII file must be named after the host interface code set up for your terminal host, with “INP” as the extension. For example, if your host interface code is “CSI”, then the ASCII file would be named CSI.INP . 2. The ASCII file you are importing must be stored in the FUELFACS\DATABASE directory. 3. In a DOS prompt, type ASCIIFILEIMPORT <host interface code>. For example, if your host interface code is “CSI”, then you would type ASCIIFILEIMPORT CSI . This will perform the import procedure. If any errors occur, they will be copied to a file named <host interface code>.ERR . 4.2.2 ASCII File Export Procedure To export ASCII files, type ASCIIFILEEXPORT <host interface code> in a DOS prompt. For example if your host interface code is “CSI”, then you would type ASCIIFILEEXPORT CSI . This will convert the current file (.CUR) to a data file (.DAT) stored in the FUELFACS\DATABASE directory. The file will be named <host interface code>.DAT . For example, if your host interface code is “CSI”, the file would be named CSI.DAT . A new .CUR file will be created and the process will start over. Each time the export is performed, any older versions of the file will be overwritten. 110 FUEL-FACS+ Host Interface Specification, FBS Version 5.1 Host File Import/Export Procedures 4.3 Transaction Per File With a “transaction per file” host, every transaction is expected to be in its own file, and the system periodically scans the host directory for files to process. Incoming files should be placed into a receiving directory first before being renamed into the incoming host directory. If files are written directly into the incoming host directory, Windows allows the host to open and read the file while it is still being written, which can result in partial transactions being read. When the host reads a partial transaction, two problems can occur: An alarm or error is generated. The host reads the transaction as empty, ignores it, continues to process other transactions, and deletes files at the end of processing. Note that even if the file finishes being written while the system is processing other transactions, it will be ignored and deleted if it is a partial file when the host initially reads it. 4.4 HostDB HostDB can also be used to import and export host transactions. FUEL-FACS+ Host Interface Specification, FBS Version 5.1 111