286484
DHL MTS
Ethos - Metres Squared
FUNCTIONAL SPECIFICATION - 10.6
- 1.1
Reference: 286484 FS-8EEKXV
Client Requirement
Change Request Summary:
Metres Squared (M2) Field - The operation require to see the M2 information. New field required within the order details to show the M2 information which will be imported from the EcoTherm file.
Change Request Details:
Metres Squared (M2) Field - The operation require to see the M2 information. New field required within the order details to show the M2 information which will be imported from the EcoTherm file.
Benefits identified as a result of the change:
M2 information will be captured to allow reporting of metres squared information in the future.
Solution
A new field will be added to the ‘SCH_ORDER_LINE’ table called ‘FOOTPRINT’. This will be a numeric field and will be displayed on the ‘ORDER’ screen as part of the line detail on the main detail tab. A new field will also be added to the ‘SCH_ORD’ table called ‘TOTAL_FOOTPRINT’. This will be a summary field and will store the total footprint for the order.
The ‘Footprint’ field will be an alternative to the planned ‘Volume’ field on the order screen and the ‘TOTAL_FOOTPRINT’ field will be displayed under the ‘FOOTPRINT’ field as a total. As Ecotherm will not be debriefing, actual footprint fields will not be required.
The order total fields are currently calculated in the procedure ‘OMS.UPDATE_ORDER_TOTALS’. Code will be added to this procedure to include the population of the ‘TOTAL_FOOTPRINT’ field. The procedure is run as part of ‘VALIDATE_ORDER’, so the ‘TOTAL_FOOTPRINT’ field will be recalculated each time the order is saved.
The ‘TOTAL_FOOTPRINT’ and ‘TOTAL_VOLUME’ fields will be required to be added to a copy of the ‘CN_TRIP_AND_ORDER’ extract. To achieve this, a new version of the ‘CN_TRIP_AND_ORDER’ extract will be created called ‘IND_TRIP_AND_ORDER’ extract. The two fields will be added to the end of the extract. The ‘CN TRIP AND ORDER’ extract was developed for Consumer, to customise the extract for Industrial we will create an Industrial version.
Scope
This change will be applied to system version 10.6
Set-up
Pre-requisites
- A new column called ‘TOTAL_FOOTPRINT; will be added to the table ‘SCH_ORD’.
- A new column called ‘FOOTPRINT’ will be added to the table ‘SCH_ORD_LINE’.
- A new extract called ‘IND Trip and Order Detail’ will be made available.
Menu Structure
‘Unchanged’
Data
The parameters will be created for the new extract ‘IND_TRIP_ORDER_DETAIL_EXTRACT’ using the scripts in Appendix A.
Functional Description
‘Orders’ Screen (ORDER.fmx)
The ‘Order Details’ screen will be changed to display the ‘Footprint’ of the order line and the ‘Total Footprint’ of the order.
An example of the existing layout of the screen is shown below:
A new right-click option will be added to the planned ‘Volume’ column which will allow the toggling of the display as the ‘Footprint’ or ‘Volume’.
The ‘Footprint’ column will display the value of the column ‘FOOTPRINT’ on the table ‘SCH_ORDER_LINE’ for the order line and the value may be amended should the user be editing the order.
If the footprint or the volume data is changed then the user will be prompted to either save or reject the changes before the toggle may be performed.
If the footprint of the order line is changed or entered then the total footprint should be calculated automatically when the user updates the changes made. See section 3.2 for more details.
There will be a corresponding column directly beneath the ‘Footprint’ column, when it is displayed by the toggle, for the total footprint of the order (i.e. on the line beginning with the text ‘Original Date’). This item will display the value in the column ‘TOTAL_FOOTPRINT’ on the table ‘SCH_ORD’ for the order and may not be amended.
‘OMS’ Package
The procedure called ‘UPDATE_ORDER_TOTALS’ in the package ‘OMS’ will be changed to calculate the total footprint of the order when the order is updated.
The column ‘TOTAL_FOOTPRINT’ on table ‘SCH_ORD’ will be recalculated as the total of the columns called ‘FOOTPRINT’ on table ‘SCH_ORDER_LINE’ for the lines on the order.
The cursor ‘c_upd_line’ will be changed to include the line below:
sum( sol.footprint ) footprint
The update of the table ‘SCH_ORD’ will then use this ‘footprint’ value to update the column ‘TOTAL_FOOTPRINT’.
The total footprint of the order will therefore be recalculated each time that the order is updated regardless of where the changes were made.
‘DP_CSV2’ Package
A new extract called ‘IND Trip and Order Detail’ will be created based on the existing extract called ‘CN Trip and Order Detail’.
For example:
The new extract will use the same parameters and values for selection but will display extra items for the orders under the following headings:
- ‘Total Footprint’
- ‘Total Volume’
‘Total Footprint’ will display the item ‘SCH_ORD.TOTAL_FOOTPRINT’ and ‘Total Volume’ will display the item ‘SCH_ORD.TOTAL_VOLUME’.
A new procedure called ‘IND_TRIP_ORDER_DETAIL_EXTRACT’ will be created in package ‘DP_CSV2’ based on the procedure ‘CN_TRIP_ORDER_DETAIL_EXTRACT’; this procedure will call procedure ‘WRITE_IND_TRIP_ORDER_DETAIL’.
‘WRITE_IND_TRIP_ORDER_DETAIL’ will include the extra items at the end of the extract.
The extra items will be selected in cursor ’c_trip_order’ as ‘ord_total_footprint’ and ‘ord_total_volume’ from ‘total_footprint’ and ‘total_volume’ respectively on table ‘ord’;
They will be added to temporary variable ‘v_file_rec’ as headings ‘Total Footprint’ and ‘Total Volume’ after ‘Actual Distance’ and then as values in the ‘cr_trip_order’ loop.
Generic EDI
The generic EDI processing will be altered to populate the new column ‘FOOTPRINT’ on table ‘SCH_ORDER_LINE’, and calculate the total footprint of the order, based on the value held within the <FOOTPRINT> tag under the <ORDER_DETAIL> segment of the inbound order message.
Table Updates Required
The tables ‘SCH_ORD’ and ‘SCH_ORDER_LINE’ will be changed to include a new column. The parameters for the new extract ‘IND Trip and Order Detail’ will be created.
References
| EST-286484 FS-8EEKXV Ethos – Metres Squared v1.0.doc | |||
Document History
| Initial version | ||||
| Missing functionality | ||||
| Included EDI changes and Order Form Toggle | ||||
| Reviewed & Issued | ||||
| Updated to use package ‘DP_CSV2’ not ‘DP_CSV’ |
AUTHORISED BY
| Matt Crisford | Development Manager | |
| Peter Greer | TMSCC MTS Product Manager |
