Allocation Reports

The Allocations Report provides a detailed summary of credit and product allocations for a terminal or terminal group and consignee or consignee group.

The Allocations Report tracks all authorization types in DTN TABS (Deny, Open, One Time, Product/Credit). Allocations can be tracked for a specific terminal or terminal group and a specific consignee or consignee group.

The Allocations Report displays details regarding product and credit allocations, and types of authorization options to be implemented.  DTN recommends running the Allocations Report for troubleshooting allocation denies and to view the remaining amount of an allocation.

Window Definitions for the Allocations Report

Listed below are the field definitions for the Allocations Report.

  • Terminals
    • Displays a terminal. When you select a terminal, the system populates the Consignees or Consignee Groups field with the consignees/consignee groups that have been assigned to the selected terminal.
  • Terminal Groups
    • Provides a terminal group. When you select a terminal group, the system populates the Consignees or Consignee Groups field with the consignees or consignee groups that have been assigned to the terminals within the selected terminal group.
  • Consignees
    • Identifies a consignee. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Consignees Groups
    • Indicates a consignee group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Product or Product Groups
    • Identifies product where liftings were done. Options are:
      • Product Name
      • Product Group
      • Product Family
  • Auth Option
    • Describes the authorization option that you want to include in the report. Options are:
      • All: Includes all authorization options
      • Deny: Includes allocations that are set to deny
      • One Time: Includes allocations set up on a one-time basis
      • Open: Includes all Open or active allocations
      • Credit and/or Product: Includes all allocations with a credit or product allocation
  • Include Expired Allocations
    • If checked, expired allocations will be included in the report.
  • Show Seller Allocations
    • Ensures any allocations set up by a DTN TABS Seller are included in the DTN TABS Marketer’s Allocation Report, if selected.
    • If the Seller has authorized the Marketer to view the Seller’s allocations, the Show Seller Allocations field displays.
  • Product Details
    • Indicates that you want the report to include details for product allocations, if selected.
  • Product Remaining
    • Provides a specific allocation remaining of a product allocation. Options are:
      • < 
      • <=
      • =
      • >=
      • > 
      • between
  • Product Next Refresh Date
    • Defines a specified Next Refresh Date on a product allocation.
  • Scale Back %
    • Identifies a specified scale back percentage.  Options are:
      • < 
      • <=
      • =
      • >=
      • > 
      • Between
  • Allocation Status
    • Identifies the status of the allocation header record used in product and/or credit authorizations. Options are:
      • All
      • Active
      • Unenforced
      • Inactive

Report Results for Allocations Report

Definitions for the Allocations Report results are:

Note: The Allocation Report displays all direct and indirect allocations associated with your selection criteria. For instance, if you selected a consignee at a specific terminal, this report shows any allocations for that consignee at that terminal. It also displays any allocations for the consignee groups to which the consignee has been assigned.

  • Terminal Name
    • Describes the name for this terminal, as defined through the Terminal Setup page. If a name is not defined, this defaults to the Terminal ID.
  • Terminal Group
    • Specifies the unique identifier for the terminal group.
  • Consignee Name
    • Defines the name of the consignee through the Consignee Setup page. If you did not define a name, this field defaults to the Consignee Number.
  • Consignee Status
    • Identifies whether the consignee has been approved to view Seller’s allocations, If the consignee is a Marketer Consignee.
  • Consignee Group
    • Contains the unique identifier for the consignee group.
  • Product/Product Group
    • Search by Product or Product Group.  Options include:
      • Product Name
        Product Group
        Product Family
  • Auth Option
    • Displays the authorization option. Options include:
      • Open
      • Deny
      • One Time
      • Credit and/or Product
  • Enforce Full Truck
    • Indicates if the enforce full truck option is selected.
  • Auth Used
    • Determines whether the authorization for a one-time allocation was used.
  • Credit Checked
    • Specifies whether there is a credit allocation attached.
  • Product Checked
    • Indicates whether there is a product allocation attached.
Product Allocations Report

The Product Allocation Report lists any product allocations for terminal/terminal group and consignee/consignee group.

Window Definitions for Product Allocation Report

Listed below are the field definitions for the Product Allocation Report.

  • Search By
    • Describes the criteria selected for a product allocation. Options are:
      • Terminal & TG
      • Terminal by Name
      • Terminal Group
      • Terminal SPLC
      • Terminal by City
      • Terminal by Plant
  • Terminal & Terminal Group
    • Displays a terminal. When you select a terminal, the system populates the Consignees or Consignee Groups field with the consignees/consignee groups that have been assigned to the selected terminal.
    • Provides a terminal group. When you select a terminal group, the system populates the Consignees or Consignee Groups field with the consignees or consignee groups that have been assigned to the terminals within the selected terminal group.
  • Search By
    • Describes the criteria selected find a product allocation. Options are:
      • Consignee & CG
      • Consignee Name
      • Consignee Group
      • Consignee #
      • Consignee by City
  • Consignee & Consignee Group
    • Identifies a consignee. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
    • Indicates a consignee group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Allocation Status
    • Specifies an allocation. Options are:
      • All
      • Active
      • Unenforced
      • Inactive
  • Product Remaining
    • Provides a specific allocation remaining of a product allocation. Options are:
      • < 
      • <=
      • =
      • >=
      • > 
      • between
  • Scaleback
    • Identifies a specific scale back percentage. Select an option and enter a percentage. Options are:
      • < 
      • <=
      • =
      • >=
      • > 
      • Between
  • Include Expired Allocation
    • Filters Active/Inactive/Unenforced Product Allocation records.

Report Results for Product Allocations Report

Definitions for the Product Allocation Report results are:

  • Terminal State
    • Describes the state where the terminal is located.
  • Terminal Name
    • Contains the terminal or terminal group name.
  • Channel ID
    • Specifies the ID code (assigned by your company) that maps to your ERP or billing system. Corresponds with Channel Name.
  • Channel Name
    • Displays the name assigned by your company (ex. Branded Distributors, Wholesale, etc.)
  • Customer Number
    • Indicates the consignee number.
  • Customer Name
    • Defines the name of the consignee through the Consignee Setup page. If a name is not defined, this field defaults to the consignee number.
  • Enforce Full Truck
    • Indicates whether enforce full truck is enabled.
  • Allocation Name
    • Displays the name of the allocation.
  • Product Code
    • Identifies the product, product group, or product family to which the product allocation applies. This column contains the PIDX product code for a product and product family level allocations.
  • Product Description
    • Describes the product.
  • Refresh Type
    • Defines the frequency the allocation is refreshed. Options are:
      • Daily
      • Weekly
      • Monthly
      • Tri-Monthly
      • Custom
  • Active Status
    • Indicates if the allocation is active. Options are:
      • Active
      • Inactive
      • Unenforced
  • Start Amount
    • Displays the number of gallons initially allocated.
  • Scale Percent
    • Describes the percentage by which the allocation is being temporarily increased or decreased.
  • Scaled Start Amount
    • Specifies the scaled start amount. This amount is calculated as follows:
      • Start Amount x Scale Percent
  • Lifted Amount
    • Provides the number of gallons lifted against this allocation.
  • GPO Allowance
    • Describes the amount that exceeds the allowed allocation and that incremented lifted amount of the GPO.
  • Full Truck Hold Amount
    • Contains the hold amount, if Enforce Full Truck is enabled.
  • Remaining Amount
    • Indicates the number of gallons remaining on this allocation. The formula is:
      • Start Amount x Scale Percent – Lifted Amount + GPO Allowed Amount
  • GPO Allowed Amount
    • Defines the allowed amount for a global product override.
  • GPO Lifted Amount
    • Displays the number of gallons that have been lifted against the GPO.
  • Lifted Percent
    • Describes the percentage of gallons that have been lifted. The formula is:
      • [Lifted Amount divided by (Scaled Start Amount plus GPO Allowed Amount.)]
  • Unit of Measure
    • Indicates what unit of measure is being used for the allocation.
  • Lifting Qualifier
    • Display the net or gross gallons.
  • Next Refresh Date
    • Contains the date and time the allocation is set to be refreshed with the specified Refresh Amount.
  • Moved Amount
    • Identifies the allocated volume moved from the primary terminal to the back-up terminal, if using Move Allocations functionality.
  • Moved Ref Amount
    • Provides the moved allocation refresh volume, if using Move Allocations functionality
  • Move Reset Date
    • Indicates the date the moved allocation will reset from the back-up terminal to the primary terminal, if using Move Allocations functionality.
Lifted vs Allocated Report

The Lifted vs Allocated Report displays allocation and scaled starts, and lifted amounts summed up by the refresh periods.  The report also includes a chart for graphical representation of the trend over the specified date range.

The following fields are available on the Lifted vs Allocated Report page:

  • Search By
    • Describes the criteria selected for a product allocation. Options are:
      • Terminal & TG
      • Terminal by Name
      • Terminal Group
      • Terminal SPLC
      • Terminal by City
      • Terminal by Plant
  • Terminal & Terminal Groups
    • Displays a terminal. When you select a terminal, the system populates the Consignees or Consignee Groups field with the consignees/consignee groups that have been assigned to the selected terminal.
    • Provides a terminal group. When you select a terminal group, the system populates the Consignees or Consignee Groups field with the consignees or consignee groups that have been assigned to the terminals within the selected terminal group.
  • Search By
    • Describes the criteria selected find a product allocation. Options are:
      • Consignee & CG
      • Consignee Name
      • Consignee Group
      • Consignee #
      • Consignee by City
  • Consignee & Consignee Group
    • Identifies a consignee. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
    • Indicates a consignee group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Search By
    • Describes the criteria selected find a product allocation. Options are:
      • Product Name
      • Product Group
      • Product Family
  • Product or Product Group
    • Identifies a Product. When you select a product or product group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
    • Indicates a product group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Start Date Between
    • Provides the date range for this report.
  • Report Time Zone
    • Contains the time zone used for this report.
  • Daylight Savings/Summer Time
    • Specifies whether Daylight Saving Time is acknowledged.
  • Refresh Type
    • Defines the frequency the allocation is refreshed. Options are:
      • Daily
      • Weekly
      • Monthly
      • Tri-Monthly
      • Custom
  • Allocation Status
    • Specifies an allocation. Options are:
      • Active
      • Unenforced
      • Active and Unenforced
  • Report UOM
    • Indicates what unit of measure (uom) is being used. Only volume based products are considered. Options are:
      • Gallons
      • Liters
      • Imperial Gallons
      • Cubic Meters
      • Kilo Barrels
      • Metric Ton
      • Imperial Ton
      • Ton
      • Kilogram
      • Pounds
  • using digits of precision
    • Displays the number of decimal places to display.
  • Include Zero Level of Allocations
    • Includes the allocation that has been set to zero (0), if selected.

Definitions for the Lifted vs. Allocated Report results are:

  • Start Date
    • Specifies the start date of the lifting.
  • Start Amount
    • Provides the start amount of the allocation.
  • Scaled Amount
    • Contains the calculated total amount of the allocation including the scaled percentage amount.
  • Lifted Amount
    • Displays the amount lifted on the start date.
Allocations Error Report

The Allocations Error Report provides a detailed summary of any errors that occurred while setting up an allocation for terminal or terminal group and consignee or consignee group. For example, if an allocation record is created but fails to attach a specific product allocation to the record, this report indicates that as an error.

Under the Product Details pane, if the report displays the “there are no product details available for this allocation” message, go back to the Allocations > Product > Manage page to create and attach a product allocation.

Window Definitions for the Allocations Error Report

Listed below are the field definitions for the Allocations Error Report:

  • Search By
      • Describes the criteria selected for a product allocation. Options are:
        • Terminal & TG
        • Terminal by Name
        • Terminal Group
        • Terminal SPLC
        • Terminal by City
        • Terminal by Plant
    • Terminal & Terminal Groups
      • Displays a terminal. When you select a terminal, the system populates the Consignees or Consignee Groups field with the consignees/consignee groups that have been assigned to the selected terminal.
      • Provides a terminal group. When you select a terminal group, the system populates the Consignees or Consignee Groups field with the consignees or consignee groups that have been assigned to the terminals within the selected terminal group.
    • Search By
      • Describes the criteria selected find a product allocation. Options are:
        • Consignee & CG
        • Consignee Name
        • Consignee Group
        • Consignee #
        • Consignee by City
        • Channel as Consignee/CG
        • SoldTo as Consignee/CG
    • Consignee & Consignee Group
      • Identifies a consignee. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
      • Indicates a consignee group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.

Report Results for Allocations Error Report

Definitions for the Allocations Error Report results are:

  • Terminal Name
    • Describes the name for this terminal, as defined through the Terminal Setup page. If a name is not defined, this defaults to the Terminal ID.
  • Terminal Group
    • Specifies the unique identifier for the terminal group.
  • Consignee Group
    • Contains the unique identifier for the consignee group.
  • Auth Option
    • Displays the authorization option. Options include:
      • Open
      • Deny
      • One Time
      • Credit and/or Product
  • Auth Used
    • Determines whether the authorization for a one-time allocation was used.
  • Credit Checked
    • Specifies whether there is a credit allocation attached.
  • Product Checked
    • Indicates whether there is a product allocation attached.
  • Product Details
    • Name
      • Describes the proprietary Product Allocation Name.
    • Allocation Type
      • Determines whether the Product Allocation type used is Flat or Hierarchical.
    • Product Code
      • Identifies the product, product group, or product family to which the product allocation applies. This column contains the PIDX product code for a product and product family level allocations.
    • Product Group
      • Contains the specific product groups from the Product Groups arrow.
    • Product Family
      • Displays the specific product family from the Product Family arrow.
    • Ref Type
      • Defines the frequency the allocation is refreshed. Options are:
        • Daily
        • Weekly
        • Monthly
        • Tri-Monthly
        • Custom
    • Ref Days
      • Identifies the number of days until the allocation will refresh on Custom refresh types.
    • Start Amt
      • Defines the number of gallons initially allocated.
    • Ref Amt
      • Displays the number of gallons that will refresh on the next refresh date.
    • Start Date
      • Contains the date and time that the allocation went into effect.
    • Next Ref Date
      • Determines the date and time that the allocation Start Amount is refreshed with the Refresh Amount.
    • End Date
      • Specifies the date and time after which the allocation is no longer in effect.
    • Status
      • Indicates whether the product allocation is Active or Inactive.
    • Carry Forward
      • Determines whether the product allocation record was flagged to carry forward volumes.
    • Lifted Amount
      • Provides the number of gallons lifted against this allocation.
    • Scale Percent
      • Describes the percentage by which the allocation is being temporarily increased or decreased.
    • GPO Allowance
      • Indicates the amount that exceeds the allowed allocation and that incremented lifted amount of the GPO.
    • Unit of Measure
      • Defines what unit of measure is being used for the allocation.
    • Comments
      • Provides user comments used on the product allocation.
    • Credit Details
      • Contains credit allocation details for the selected terminal/terminal group and consignee/consignee group.
Historical Allocations Report

The Historical Allocations Report provides a summary of the allocations that were in effect when a loading error or a denial occurred on a given date. The report can be used to trace exactly what happened to an allocation by terminal or terminal group and consignee or consignee group at a given time. The report can provide details by user, action result, and transaction type.

Window Definitions for Historical Allocations Report

Listed below are the field definitions for the Historical Allocations Report:

    • Search By
      • Describes the criteria selected for a product allocation. Options are:
        • Terminal & TG
        • Terminal by Name
        • Terminal Group
        • Terminal SPLC
        • Terminal by City
        • Terminal by Plant
    • Terminal & Terminal Groups
      • Displays a terminal. When you select a terminal, the system populates the Consignees or Consignee Groups field with the consignees/consignee groups that have been assigned to the selected terminal.
      • Provides a terminal group. When you select a terminal group, the system populates the Consignees or Consignee Groups field with the consignees or consignee groups that have been assigned to the terminals within the selected terminal group.
    • Search By
      • Describes the criteria selected find a product allocation. Options are:
        • Consignee & CG
        • Consignee Name
        • Consignee Group
        • Consignee #
        • Consignee by City
        • Channel as Consignee/CG
        • SoldTo as Consignee/CG
    • Consignee & Consignee Group
      • Identifies a consignee. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
      • Indicates a consignee group. When you select a terminal or terminal group first, the system populates the Consignee or Consignee Group field with the consignees that have been assigned to the selected terminal or terminal group.
  • Date and Time
    • Specifies the date and time for the historical information.

Report Results for Historical Allocations Report

  • Terminal
    • Describes the proprietary name for the terminal.
  • Customer
    • Identifies the Consignee or Consignee Group.
  • Auth Option
    • Displays the authorization option. Options are:
      • All: Includes all authorization options
      • Deny: Includes allocations that are set to deny.
      • One Time: Includes allocations set up on a one-time basis
      • Open: Includes all Open or active allocations
      • Credit and/or Product: Includes all allocations with a credit or product allocation
  • Auth Used
    • Determines whether the authorization for a one-time allocation was used.
  • Credit Checked
    • Specifies whether there is a credit allocation attached.
  • Product Checked
    • Determines whether there is a product allocation attached.
  • Modified Date
    • Indicates the date and time the allocation was last modified.
  • Mod
    • Identifies action type of the modified record.  I = Inserted, M = Modified, D = Deleted.
  • Product Details
    • Name
      • Describes the proprietary Product Allocation Name.
    • Type
      • Determines whether the Product Allocation type used is Flat or Hierarchical.
    • Prod/Prod Grp/Prod Fam
      • Specifies the Product, Product Group or Product Family used in the allocation.
    • Comments
      • Provides user comments used on the product allocation.
    • Ref Type
      • Defines the frequency the allocation is refreshed. Options are:
        • Daily
        • Weekly
        • Monthly
        • Tri-Monthly
        • Custom
    • Ref Days
      • Identifies the number of days until the allocation will refresh on Custom refresh types.
    • Start Amt
      • Defines the number of gallons initially allocated.
    • Ref Amt
      • Displays the number of gallons that will refresh on the next refresh date.
    • Dec Amt
      • Provides the minimum amount that the credit allocation’s Allocation Remaining is decreased when product is lifted. Not dependent on the actual amount lifted.
    • Rem Amt
      • Specifies the credit amount or the number of gallons of product remaining to be lifted on the allocation.
    • Start Date
      • Contains the date and time that the allocation went into effect.
    • Next Ref Date
      • Determines the date and time that the allocation Start Amount is refreshed with the Refresh Amount.
    • End Date
      • Specifies the date and time after which the allocation is no longer in effect.
    • Status
      • Indicates whether the product allocation is Active or Inactive.
    • Carry Fwd
      • Determines whether the product allocation record was flagged to carry forward volumes.
    • Lifted Amt
      • Provides the number of gallons lifted against this allocation.
    • GPO Allowance
      • Indicates the amount that exceeds the allowed allocation and that incremented lifted amount of the GPO.
    • Scale %
      • Describes the percentage by which the allocation is being temporarily increased or decreased.
    • Unit of Measure
      • Defines what unit of measure is being used for the allocation.
    • Date Last Modified
      • Indicates the date and time the allocation was last modified.
    • Mod
      • Identifies action type of the modified record.
        • M = Modified
        • I = Inserted (or created)
        • D = Deleted
    • Moved Amt
      • Provides the allocated volume moved from the primary terminal to the back-up terminal, if using Move Allocations functionality.
    • Moved Ref Amt
      • Contains the moved allocation refresh volume, if using Move Allocations functionality.
    • Move Reset Date
      • Displays the date the moved allocation will reset from the back-up terminal to the primary terminal, if using Move Allocations functionality.
Historical Allocations (Time Span) Report

The Historical Allocations (Time Span) Report provides a summary of the allocations that were in effect when a loading error or a denial occurred over a specified period of time. The report determines what happened to an allocation by terminal or terminal group and consignee or consignee group over a span of time. The report can provide details by user, action result, and transaction type.

Note: The report that is generated online summarizes historical information. For a much more detailed report, click .

Window Definitions for Historical Allocations (Time Span) Report

Listed below are the field definitions for the Historical Allocations (Time Span) Report:

  • Terminals
    • Describes a terminal. When a terminal is selected, the system populates the Consignees or Consignee Groups field with the consignees and consignee groups that have been assigned to the selected terminal.
  • Terminal Groups
    • Specifies a terminal group. When a terminal group is selected, the system populates the Consignees or Consignee Groups fields with the consignees and consignee groups that have been assigned to the terminals within the selected terminal group.
  • Consignees
    • Provides a consignee. When a terminal or terminal group is selected first, the system populates the Consignees field with the consignees that have been assigned to the selected terminal or terminal group.
  • Consignee Groups
    • Indicates a consignee group. When a terminal or terminal group is selected first, the system populates the Consignee Groups field with the consignee groups that have been assigned to the selected terminal or terminal group.
  • Start Date and Time
    • Specifies the desired start date and time to view historical information.
  • End Date and Time
    • Defines the desired end Date and time to view historical information.

Report Results for Historical Allocations (Time Span) Report

Definitions for the Historical Allocations (Time Span) Report results are:

  • Active
    • Indicates whether the allocation is currently in effect. Options are:
      • Y
      • N
  • Terminal Name or Terminal Group
    • Specifies the terminal or terminal group to which the allocation applies.
  • Consignee Name or Consignee Group
    • Provides the consignee or consignee group to which the allocation applies.
  • Auth Option
    • Indicates the authorization option. Options are:
      • Deny
      • Open
      • One Time Credit and/or Product
  • Auth Used
    • Defines whether the authorization for a one-time allocation was used.
  • Credit Checked
    • Specifies whether there is a credit allocation attached.
  • Product Checked
    • Indicates whether there is a product allocation attached.
  • Product Details
    • Provides product allocation details for the selected terminal or terminal group and consignee or consignee group combination.
  • Credit Details
    • Contains credit allocation details for the selected terminal/terminal group and consignee/consignee group.
  • Name
    • Specifies the name of the product or credit allocation as defined by the user.
  • Type
    • Determines the type of credit or product allocation. Options are:
      • Flat
      • Hierarchical
  • Prod/Prod Grp/Prod Fam
    • Identifies the product, product group, or product family to which the product allocation applies.
  • Comments
    • Displays the notes or comments that apply to the allocation.
  • Ref Type
    • Specifies the Refresh Period.
      • For a legacy Credit Allocation and Flat Allocation. Options are
      • Monthly
      • Tri-Monthly
      • Weekly
      • Daily
      • Custom
    • For a Hierarchical Allocation, options are:
      • Monthly
      • Weekly
      • Daily
  • Ref Days
    • Indicates the day for the refresh, if this Refresh Type or Period is Custom.
  • Start Amt
    • Provides the initial credit amount or the number of gallons of product authorized for the allocation.
  • Ref Amt
    • Contains the credit amount or the number of gallons of product that the allocation Start Amount is automatically refreshed on the next Refresh Date.
  • Dec Amt
    • Identifies the minimum amount that the credit allocation’s Allocation Remaining is decreased when product is lifted. Not dependent on the actual amount lifted.
  • Rem Amt
    • Specifies the credit amount or the number of gallons of product remaining to be lifted on the allocation.
  • Start Date
    • Displays the date and time that the allocation went into effect.
  • Next Ref Date
    • Describes the date and time that the allocation Start Amount is refreshed with the Refresh Amount.
  • End Date
    • Defines the date and time after which the allocation is no longer in effect.
  • Carry Fwd
    • Indicates whether any Allocation Remaining on the next Refresh Date should be added to the Start Amount after it has been refreshed with the Refresh Amount. Options are:
      • Y
      • N
  • Lifted Amt
    • Identifies the credit amount or number of gallons of product lifted by the customer during the Refresh Period.
  • Scale %
    • Defines the percentage by which the product allocation is being increased or decreased. A scale % of 100 indicates the customer can load 100% of the allocated amount.
  • Date Last Modified
    • Displays the date and time the product allocation was last modified.
  • Mod
    • Indicates the change status of the allocation as follows:
      • M = Modified
      • I = Inserted (or created)
      • D = Deleted
Global Product Override Report

The Global Product Override Report summarizes global product override (GPO) activity for a selected terminal, consignee, and product combination. The report can be filtered by keyword or by terminal or terminal group and consignee or consignee group. A creation or expiration date or range of dates can be specified. The report can also be filtered to view active/future, expired or historical data for overrides.

The Historical Data filter produces a report with details about any modifications to the GPO that occurred during the specified time frame.

Window Definitions for Global Product Override (GPO) Report

Listed below are the field definitions for the Global Product Override Report:

  • Search for GPO by Keyword
    • This pane filters for GPOs by using a keyword for the terminal name, terminal group name, consignee name, or consignee group name.
      • Search By
        • Describes the criteria selected to find a Global Product Override (GPO). Options are:
          • Terminal Name
          • Consignee Name
          • Terminal Group Name
          • Consignee Group Name.
      • Key Word
        • Defines a full or partial key word that corresponds with your Search By selection.
      • Created Between …. And
        • Selects the creation date and time range using the calendar icon and time arrows.
      • Expired Between …. And
        • Specifies an expiration date and time range using the calendar icon and time arrows.
      • Select Overrides to be Shown
        • Filters the GPO report based on the selected information. Options are:
          • Active Overrides: Includes all GPO records that are active during the selected time frame.
          • Expired Overrides: Includes all GPO records that were no longer active during the selected time frame.
          • Historical Data for Overrides: Includes any modifications to the GPO record that occurred during the specified time frame. If this is unchecked, the report will display the most recent version of the GPO.
      • GPO Request Method
        • Options are:
          • All – Returns both Add loads and GPO setup/approvals
          • Add loads – Requested Pre-approved Override loads
          • GPO setup/approval – Global Product Overrides issued and approved
  • Search for GPO by Terminal or Terminal Group  and Consignee or Consignee Group
    • Sorts GPOs for a specified terminal or terminal group and consignee or consignee group combination.
      • Terminals or Terminal Group
        • Specifies the terminal or terminal group associated with the GPO. When a terminal group is selected, the system populates the Consignees or Consignee Groups fields with the consignees and consignee groups that have been assigned to the terminals within the selected terminal group.
        • At least one terminal or terminal group must be selected.
      • Consignee or Consignee Groups
        • Provides a consignee or consignee group. When a terminal or terminal group is selected first, the system populates the Consignee or Consignee Group field with the consignees and consignee groups that have been assigned to the selected terminal or terminal group.
        • At least one consignee or consignee group must be selected.
      • Product, Product Groups or Product Families
        • Displays the product or product group or product family to which the GPO applies. If you want to see a report that includes all products, product groups, and product families to which a GPO is associated, do not select an option from these drop-down menus.
      • Created Between …. And
        • Selects the creation date and time range using the calendar icon and time arrows.
      • Expired Between …. And
        • Specifies an expiration date and time range using the calendar icon and time arrows.
      • Select Overrides to be Shown
        • Filters the GPO report based on the selected information. Options are:
          • Active Overrides: Includes all GPO records that are active during the selected time frame.
          • Expired Overrides: Includes all GPO records that were no longer active during the selected time frame.
          • Historical Data for Overrides: Includes any modifications to the GPO record that occurred during the specified time frame. If this is not selected, the report displays the most recent version of the GPO.
      • GPO Request Method
        • Options are:
          • All – Returns both Add loads and GPO setup/approvals
          • Add loads – Requested Pre-approved Override loads
          • GPO setup/approval – Global Product Overrides issued and approved

Report Results for Global Product Override (GPO) Report

Definitions for the Global Product Override Report results are:

  • Terminal and Consignee
    • Describes the terminal or terminal group and consignee or consignee group to which the GPO applies.
  • Product
    • Specifies the product, product group, or product family to which the GPO applies.
  • Allowed Amount
    • Provides the allowed amount for the GPO.
  • Lifted Amount
    • Indicates the amount lifted against the GPO. When the Lifted Amount equals the Allowed Amount, the customer is out of allocation for that GPO.
  • Created Date
    • Contains the date and time the GPO was created.
  • Effective Date
    • Identifies the date and time the GPO is effective.
  • Expiration Date
    • Displays the date and time the GPO expires.
  • Unit of Measure
    • Indicates what unit of measure is being used for the GPO.
  • GPO Type
    • Determines whether the GPO issued is Incremental or Borrowed.
  • Request Method
    • Identifies whether the GPO method requested is Add Loads or GPO Setup.
  • Comments
    • Displays user defined comments, if applicable.
  • Audit Information
    • Tracks changes to the GPO record. Options are:
      • GPO Reason Code – Displays user defined reason code, if applicable.
      • User Name – The name of the user who created or modified the GPO.
      • Date Modified – The date and time that the corresponding Allowed Amount was set.
      • Status – Active – Indicates if the corresponding GPO is active.
      • Inactive – Indicates if the GPO is inactive.
  • Modification Type
    • Indicates if the corresponding GPO has been modified. Options are:
      • New – The original GPO without any modifications. This option is seen only when Historical Data for Overrides is selected.
      • Update – A modified GPO. This option is seen only when Historical Data for Overrides is selected.
      • Current – The most recent version of the GPO. This option is seen only when Historical Data for Overrides is not selected.
Product Allocations Availability Report

The Product Allocations Availability Report displays the percentage of time when the scale percent on the Active Allocation records was greater than or equal to a specified percentage.

Window Definitions for Product Allocations Availability Report

Listed below are the field definitions for the Product Allocations Availability Report:

  • Country
    • Provides the country for the report.
    • Click the Add link to include more countries.
  • Product
    • Specifies the product group or product family.
    • Click the Add link to include more product and product groups.
  • Consignee/CGroup
    • Selects a consignee or consignee group. When you select a consignee or consignee group, the system only shows audits of the specified consignee or consignee group.
    • Click the Add link include more consignees and consignee groups.
  • Refresh Type
    • Indicates the type of refresh. Options are:
      • All
      • Daily
      • Weekly
      • Monthly
      • Trimonthly
      • Custom
    • Click the Add link to include more refresh types.
  • Start Date
    • Contains the date and time that the allocation went into effect.
  • Scale Percent Target
    • Describes the percentage by which the allocation is being temporarily increased or decreased.
  • End Date
    • Specifies the date and time after which the allocation is no longer in effect.

Report Results for Product Allocations Availability Report

Definitions for the Product Allocations Availability Report results are:

  • Country
    • Describes the country for the report.
  • Terminal
    • Contains the unique identifier for the terminal. The Terminal ID consists of the SPLC code for the terminal and the Terminal Owner’s ID.
  • Customer
    • Provides the allowed amount for the GPO.
  • Product
    • Indicates the amount lifted against the GPO. When the Lifted Amount equals the Allowed Amount, the customer is out of allocation for that GPO.
  • Refresh Type
    • Defines the frequency the allocation is refreshed. Options are:
      • Daily
      • Weekly
      • Monthly
      • Tri-Monthly
      • Custom
  • Scale Percent Target
    • Describes the percentage by which the allocation is being temporarily increased or decreased.
  • Availability percent Actual
    • Start Date
      • Contains the date and time that the allocation went into effect.
    • End Date
      • Specifies the date and time after which the allocation is no longer in effect.
Moved Allocations Report

The Moved Allocations Report provides a detailed summary of allocations that were moved from one terminal to another using the Move Allocations functionality.

Window Definitions for Moved Allocations Report

Listed below are the field definitions for the Moved Allocations Report:

  • Search By
    • Describes the criteria selected find a product allocation. Options are:
      • Terminal & TG
      • Terminal by Name
      • Terminal Group
      • Terminal SPLC
      • Terminal by City
      • Terminal by Plant
  • Terminal or Terminal Group
    • Displays list of all available Terminal or Terminal Groups.
  • Moved Event  Modified Date From
    • Selects the date the moved event was modified from using the calendar icon.
  • Moved Event Modified Date To
    • Specifies the date the moved event was modified to using the calendar icon.

Report Results for Moved Allocation Report

Definitions for the Moved Allocations Report results are:

  • Event Name
    • Contains the name of the event.
  • Source Terminal Name
    • Defines the source terminal or terminal group of the source allocations.
  • Destination Terminal Name
    • Provides the destination terminal or terminal group in which the allocations are moving to.
  • Move Event Status
    • Identifies whether the move event is Active or Inactive.
  • Modified Date
    • Indicates the date the move event was modified.
  • Modified By
    • Describes the user that last modified the move event.
  • Move Action
    • Displays the move event current state.  Options are:
      • Pending – Move event saved but not yet moved. If the event is in pending status when it expires, it will remain on the Current Move Events.
      • Moved – Move event that is in effect/activated.  After the move event has expired it will no longer display under Current Move Events.
      • Reset – Move event that has reset date less than the current date and therefore no longer in effect.
      • Invalid – Move event that has no allocations associated with the move event because allocations were deleted or removed from the move event.
  • Comments
    • Specifies user defined comments, if applicable.
  • Start Amount Adjustment
    • Determines the adjusted start amount.
  • Refresh Amount Adjustment
    • Identifies the adjusted refresh amount.
  • Move Date
    • Defines the effective date of the move event.
  • Reset Date Time
    • Describes the date the move event resets from the destination terminal back to the source terminal.
  • Source Terminal Details
    • Consignee/CGroup
      • Contains the consignee or consignee group.
    • Product
      • Identifies the product, product group, or product family to which the product allocation applies. This column contains the PIDX product code for a product and product family level allocations.
    • Unit of Measure
      • Indicates what unit of measure is being used for the allocation.
    • Refresh Type
      • Defines the frequency the allocation is refreshed. Options are:
        • Daily
        • Weekly
        • Monthly
        • Tri-Monthly
        • Custom
    • Refresh Days
      • Indicates the custom day for the refresh, if the Refresh Type or Period is Custom.
    • Start Amt
      • Displays the number of gallons initially allocated.
    • Refresh Amt
      • Describes the credit amount or the number of gallons of product remaining to be lifted on the allocation.
    • Scale Percent
      • Describes the percentage by which the allocation is being increased or decreased.
    • Active Status
      • Indicates if the allocation is active. Options are:
        • Active
        • Inactive
        • Unenforced
    • Start Date
      • Contains the date and time that the allocation went into effect.
    • Next Refresh Date
      • Contains the date and time the allocation is set to be refreshed with the specified Refresh Amount.
  • Destination Terminal Details
    • Consignee/CGroup
      • Contains the consignee or consignee group.
    • Product
      • Identifies the product, product group, or product family to which the product allocation applies. This column contains the PIDX product code for a product and product family level allocations.
    • Unit of Measure
      • Indicates what unit of measure is being used for the allocation.
    • Refresh Type
      • Defines the frequency the allocation is refreshed.
    • Refresh Days
      • Provides the custom day for the refresh, if the Refresh Type or Period is Custom.
    • Start Amt
      • Displays the number of gallons initially allocated.
    • Moved Amt
      • Indicates the number of gallons moved from the source terminal to the destination terminal.
    • Refresh Amt
      • Identifies the credit amount or the number of gallons of product remaining to be lifted on the allocation.
    • Moved Refresh Amt
      • Describes the credit amount or the number of gallons of product allocation remaining to be lifted on the allocation.
    • Original Scale Percent
      • Specifies the source terminal initial scale percentage.
    • Adjusted Scale Percent
      • Defines the destination terminal set scale percentage.
    • Active Status
      • Determines whether the moved allocation is active.
        • Y = Active
        • N = Not Active
    • Start Date
      • Contains the date and time that the allocation went into effect.
    • Next Refresh Date
      • Displays the date and time the allocation is set to be refreshed with the specified Refresh Amount.

 

Category: Getting Started