Projects:Freight Management/Technical Specification

Contents 1 Introduction 2 Module Definition 3 New Windows 3.1 Carrier 3.2 Freight Category 3.3 Delivery Period 4 Modified Windows 4.1 Organization 4.2 Sales Order 4.3 Goods Shipment 5 UOM Type 6 New Processes 6.1 Create new Freight (Price List) 6.2 Select Freight 6.3 Update Total Weight

Introduction

In this document are described all the developments needed to properly implement the Freight Management module.

Module Definition

• Name: Freight Management
• Java Package: org.openbravo.materialmgmt.freightmgmt
• DB Prefix: OBMFM
• Commercial: Yes
• Dependencies:
  • Core (Openbravo 3 Framework) 3.0MP26 (to be released in August)

New Windows

Carrier

Main window where carriers and their fares are configured. Window structure has 3 tabs in three levels:

Header

OBMFM_Carrier table. Carrier definition.

Freight

OBMFM_Freight table. Freight main definition.

Definition

OBMFM_Freight_Definition table. Each fare of the freight definition.

Freight Category

Window where freight are configured. Single tab:

Header

OBMFM_Freight_Category table.

Delivery Period

Window where delivery periods are configured. Single tab:

Header

OBMFM_Delivery_Period table.

Modified Windows

Organization

Added new field Fixed Cost Product to define the product to be used when inserting Fixed Cost lines in Sales Orders. Used when Sales Order's selected freight definition does not have a delivery period with a Fixed Cost Product.

Sales Order

• Header:
  • Field Delivery Charges: List to define how the freight is going to be charged to the customer, available values are:
    • OQU: Cost based on Ordered quantities (Product Units)
    • OQW: Cost based on Ordered quantities (Weight)
    • FC: Fixed cost
    • FREE: Free
    • NCLP: No cost. Local pickup
    • NCCD: No cost. Carriage due
    • Not implemented SQB: Cost based on Shipped quantities (Bundles)
    • Not implemented SQW: Cost based on Shipped quantities (Weight)
  • Button Select Freight
  • Button Set Weight
  • Field Delivery Period: Foreign key to OBMFM_Delivery_Period used to filter the Select Freight Pick and Execute
  • Field Freight: Read only foreign key to OBMFM_Freight, filled by the Select Freight Pick and Execute.
  • Field Weight: In Status bar with the total weight of the Order. Filled automatically by an Action Handler or manually using the Set weight button.
  • Field Weight UOM: Foreign key to C_UOM filtered by weight type uoms. Defaulted to Client's weight UOM.
• Lines:
  • Field Is Freight Amount Line: Flag to determine when the line contains the freight amount.
  • Field Freight Definition: Read only foreign key to OBMFM_Freight_Definition, filled by the Select Freight Pick and Execute.

Goods Shipment

New fields Freight, Delivery Charges and Delivery Notes filled by the Create Inout procedure. This information is copied when the shipment is from a unique Sales Order.

UOM Type

Core development based on Feature Request 20203. New field added to Unit of Measure window to define the UOM Type. Available values are:

• Volume
• Area
• Length
• Weight
• Time

Core shipped base UOMs are updated to set the new types. Client's Information tab UOM fields are filtered based on this type.

New field is added to Product to set the Weight UOM when a weight is defined.

New Processes

Create new Freight (Price List)

Button in Carrier window that generates a new Freight based on an existing one with the ability to set a coefficient to modify the amounts.

Select Freight

Button in Sales Order window to select the desired Freight. This is a P&E window showing all available Freights that meet the conditions of the Sales Order: Delivery Location, Delivery Period, Delivery Charge type,... The cheapest option is selected by default.

The grid shows all freight definitions matching the conditions of the Sales Order. If they are not correctly configured they still appear in the grid. In these cases a warning is shown with the issue and user is not allowed to select them. There is an implicit filter by the Delivery Period in case the Order has one defined. This filter is hard-coded and cannot be modified by a template.

When a Freight is selected the Freight and Delivery Period of the header is filled. Depending on the Delivery Charges a new Order Line is created with the Is freight amount line flag checked and the selected Freight Definition. This new line uses the Product defined in the selected Carrier or the corresponding Fixed Cost Product in case Fixed Cost Delivery Charge is selected. The Freight Amount is inserted as a net or gross amount depending on the Sales Order's Price List's Is Tax Included flag.

Update Total Weight

Although it is automatically calculated by an Event Handler it is possible to modify the total weight manually by a button in the Sales Order window.