256637: Difference between revisions

From CTMS
(New page: = 256637 PA-7KPHJ8 EFX Pop-Up box = Copyright OBS Logistics © 2008 The information contained herein is the property of OBS Logistics and is supplied without liability for errors or omi...)
 
No edit summary
 
(18 intermediate revisions by the same user not shown)
Line 2: Line 2:




Copyright OBS Logistics © 2008
Copyright OBS Logistics © 2009


The information contained herein is the property of OBS Logistics and is supplied without liability for errors or omissions. No part may be reproduced or used except as authorised by contract or other written permission. The copyright and foregoing restriction on reproduction and use extend to all media in which the information may be embodied  
The information contained herein is the property of OBS Logistics and is supplied without liability for errors or omissions. No part may be reproduced or used except as authorised by contract or other written permission. The copyright and foregoing restriction on reproduction and use extend to all media in which the information may be embodied




= FUNCTIONAL OVERVIEW =
= Functional Overview =
 


== Client Requirement ==
== Client Requirement ==
MTS planning - EFX Pop-Up box - Hide or grey-out 'Trip Cost Man' as a fixed selection, and Hide or grey-out 'Forecast' as a fixed selection
MTS planning - EFX Pop-Up box - Hide or grey-out 'Trip Cost Man' as a fixed selection, and Hide or grey-out 'Forecast' as a fixed selection


1: When allocating a Trip to EFX the Pop-up box offers several options for Cost - hardcode the cost option as 'Trip Cost Man' and hide or grey-out the selection also hardcode 'Forecast' as the status type again hide or grey-out the selection. This leaves 3 boxes for input - Deadline Date, Deadline Time and Rate  
*When allocating a Trip to EFX the Pop-up box offers several options for Cost - hardcode the cost option as 'Trip Cost Man' and hide or grey-out the selection also hardcode 'Forecast' as the status type again hide or grey-out the selection. This leaves 3 boxes for input - Deadline Date, Deadline Time and Rate  


2: re-adjust the 'Tabbing' sequence to navigate from 'deadline Date' to 'deadline time' to 'rate'
*re-adjust the 'Tabbing' sequence to navigate from 'deadline Date' to 'deadline time' to 'rate'


Added by SS 24.10.08 - It may be beneficial to have these controlled by parameters within MTS.
Added by SS 24.10.08 - It may be beneficial to have these controlled by parameters within MTS.
Line 24: Line 25:
Current functionality in TRIP_SUM and TRIP_PLAN, for EFX Payment Details, are as follows:  
Current functionality in TRIP_SUM and TRIP_PLAN, for EFX Payment Details, are as follows:  


The EFX Pop Up Box, named ‘Payment Details’ in the Trip Screens is only displayed when the checkbox next to ‘EFX Ref.’ is selected and the current Trip has a Carrier of ‘EFX’
*The EFX Pop Up Box, named ‘Payment Details’ in the Trip Screens is only displayed when the checkbox next to ‘EFX Ref.’ is selected and the current Trip has a Carrier of ‘EFX’
This ‘Payment Details’ box is pre-populated with Event Ref (Sched_Name || ‘-‘ || Trip_Id), Debit Account (Cost Centre) and Credit Account (Carrier_Id), which are greyed out and not editable.
 
The user is able to enter a Payment Type and Status, selectable from the drop-down lists
*This ‘Payment Details’ box is pre-populated with Event Ref (Sched_Name || ‘-‘ || Trip_Id), Debit Account (Cost Centre) and Credit Account (Carrier_Id), which are greyed out and not editable.
The user is able to input an Expiry Date, Time and Amount
 
When saved table ACC_PAYMENT is updated with the info in the ‘Payment Details’ box
*The user is able to enter a Payment Type and Status, selectable from the drop-down lists
 
 
*The user is able to input an Expiry Date, Time and Amount
 
 
*When saved table ACC_PAYMENT is updated with the info in the ‘Payment Details’ box
 


The Payment Type drop-down list currently contains the following:
The Payment Type drop-down list currently contains the following:
Line 36: Line 44:
Forecast, Actual, Provisional
Forecast, Actual, Provisional


Part 1 – EFX Pop-Up Box Input Fields
'''Part 1''' – EFX Pop-Up Box Input Fields
The EFX Pop Up Box will be amended so that when it is displayed, the following items are greyed out and not editable:
The EFX Pop Up Box will be amended so that when it is displayed, the following items are greyed out and not editable:
Event Ref which relates to ‘Sched_Name || ‘-‘ || Trip_Id e.g. ‘081027-MAN-00234567’
Event Ref which relates to ‘Sched_Name || ‘-‘ || Trip_Id e.g. ‘081027-MAN-00234567’
Line 54: Line 62:




Part 2 – Tabbing Issue
'''Part 2''' – Tabbing Issue
When the EFX Pop Up Box is displayed, the tab sequence between fields will be as follows;
When the EFX Pop Up Box is displayed, the tab sequence between fields will be as follows;


Line 62: Line 70:
Type – Status – Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning)
Type – Status – Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning)


== Scope ==
This change will be applied to system version 10.6 on CONTST and once approved CONPRD.




== Data ==
A new function needs to be created in table ADM_FUNCTION, called ACC_DIFF_EFX_PAYMENT. The only situation, where the Type and Status are not hard-coded and greyed out will be governed by a User Group having the function ACC_DIFF_EFX_PAYMENT promoted to their Group. If a user is in a particular group with this function promoted, then they will have the ability to select the Type and Status from the drop-down lists. Table ADM_FUNCTION will be updated to include the new function as follows


== 1.3 Scope ==
=Functional Description=
This change will be applied to system version 10.6 on CONTST and once approved CONPRD.
 


= FUNCTIONAL DESCRIPTION =
'''Sample Layout'''


== Sample Layout ==
Below is a screenshot of how the ‘Functions’ tab within the Group Maintenance form will display when the new function has been created, and is ready to be promoted:
Below is a screenshot of how the ‘Functions’ tab within the Group Maintenance form will display when the new function has been created, and is ready to be promoted:


[[Image:256637_1.png]]
IMAGE


Below is an example of how the EFX pop-up will be displayed without the promotion of the new function:  
Below is an example of how the EFX pop-up will be displayed without the promotion of the new function:  


   
   
IMAGE
[[Image:256637_2.png]]
 
 
 




Below is how the EFX Pop-Up Box will be displayed when the user has the new function ACC_DIFF_EFX_Payment promoted to their user group:
Below is how the EFX Pop-Up Box will be displayed when the user has the new function ACC_DIFF_EFX_Payment promoted to their user group:


IMAGE
[[Image:256637_3.png]]




Line 101: Line 106:
This is achieved by setting the ‘Next Navigation Item’ property within the Property Palette for each field in the Pop-Up. Below you can see that the Next Navigable item from the ‘Expiry Date’ will be ‘Expiry Time’:
This is achieved by setting the ‘Next Navigation Item’ property within the Property Palette for each field in the Pop-Up. Below you can see that the Next Navigable item from the ‘Expiry Date’ will be ‘Expiry Time’:
   
   
IMAGE
[[Image:256637_4.png]]




== Code Amendments ==
== Code Amendments ==
Below is a preliminary outline of the code required to set up the EFX Pop-Up box either with the Payment Type and Status hard-coded or else selectable from drop-down lists depending on the new function.  
Code is required to set up the EFX Pop-Up box either with the Payment Type and Status hard-coded or else selectable from drop-down lists depending on the new function.  
 
BEGIN
 
IF :TRIP_DTL.EFX_SEND_FLAG = 'Y' THEN
    IF :trip_dtl.carrier_id = 'EFX' THEN --Only proceed if carrier is EFX
      F_POP_PAYMENT_TYPES;
    Go_Block( 'PAYMENT_DETAIL' );
    :PAYMENT_DETAIL.EVENT_REF := :TRIP_DTL.SCHED_NAME || '-' || :TRIP_DTL.TRIP_ID;
      :PAYMENT_DETAIL.Debit_Acc  := :TRIP_DTL.COST_CENTRE;
      :PAYMENT_DETAIL.Credit_Acc := :TRIP_DTL.CARRIER_ID;
      :PAYMENT_DETAIL.entered_date := SYSDATE;
      :PAYMENT_DETAIL.revenue_date := TRUNC( SYSDATE );
      :PAYMENT_DETAIL.narrative_1  := :PAYMENT_DETAIL.event_ref;
 
    SELECT COUNT(*) INTO counter
      FROM acc_payment ap
    WHERE ap.event_ref = :TRIP_DTL.SCHED_NAME || '-' || :TRIP_DTL.TRIP_ID
      AND UPPER(PAYMENT_TYPE) = 'TRIP HAUL MA’
      AND ap.parent_payment IS NOT NULL;
 
    IF NOT ADM.FN_ACCESS ('ACC_Diff_EFX_Payment', NULL, NULL) THEN
     
    IF counter <> 0 THEN
SELECT payment_type, amount, status
INTO :PAYMENT_DETAIL.payment_type, :PAYMENT_DETAIL.amount, :PAYMENT_DETAIL.status
  FROM acc_payment ap
WHERE ap.event_ref = :TRIP_DTL.SCHED_NAME || '-' || :TRIP_DTL.TRIP_ID
  AND UPPER(PAYMENT_TYPE) = 'TRIP HAUL MA'
AND ap.parent_payment IS NOT NULL;
    ELSE
      :PAYMENT_DETAIL.payment_type := 'Trip Haul Ma';
      :PAYMENT_DETAIL.amount := NULL;
      :PAYMENT_DETAIL.status := 'Forecast';
    END IF;
     
    SET_ITEM_PROPERTY ('PAYMENT_DETAIL.PAYMENT_TYPE', ENABLED, PROPERTY_FALSE);
      SET_ITEM_PROPERTY ('PAYMENT_DETAIL.PAYMENT_TYPE', NAVIGABLE,
PROPERTY_FALSE);
      SET_ITEM_PROPERTY ('PAYMENT_DETAIL.STATUS', ENABLED, PROPERTY_FALSE);
      SET_ITEM_PROPERTY ('PAYMENT_DETAIL.STATUS', NAVIGABLE, PROPERTY_FALSE);
     
     
      ELSE
      IF counter <> 0 THEN  
SELECT payment_type, amount, status
INTO :PAYMENT_DETAIL.payment_type, :PAYMENT_DETAIL.amount, :PAYMENT_DETAIL.status
  FROM acc_payment ap
WHERE ap.event_ref = :TRIP_DTL.SCHED_NAME || '-' || :TRIP_DTL.TRIP_ID
  AND UPPER(PAYMENT_TYPE) = 'TRIP HAUL MA'
AND ap.parent_payment IS NOT NULL;
      ELSE
      :PAYMENT_DETAIL.payment_type := NULL;
      :PAYMENT_DETAIL.amount := NULL;
      :PAYMENT_DETAIL.status := NULL;
      END IF;
  END IF;
     
  UPDATE sch_trip
  SET EFX_SEND_FLAG = 'Y'
  WHERE sched_name = :TRIP_DTL.sched_name
  AND trip_id    = :TRIP_DTL.trip_id;
 
  FC_Commit.Do_Enable;
ELSE
 
:trip_dtl.efx_send_flag := 'N';
Set_Alert_Property( 'ERR_MSG', ALERT_MESSAGE_TEXT, 'To use this option Carrier must be EFX ');
  v_Retnum := Show_Alert( 'ERR_MSG' );
  RETURN;
END IF;
END IF;
 
END;
 
 
 
 
 
 
 
 
The following sql script will need to be run against the test and live databases to insert the new function into table ADM_FUNCTION this is to allow the promotion to user groups if desired in the future:
 
INSERT INTO ADM_FUNCTION (fn_name, description, active)
VALUES (‘ACC_Diff_EFX_Payment’,‘Ability to amend Payment Type and Status for a Trip with a Carrier Id of EFX, in the TRIP screens’,’Y’);


IMAGE


A sql script will need to be run against the test and live databases to insert the new function into table ADM_FUNCTION this is to allow the promotion to user groups if desired in the future:


== References ==
= References =


IMAGE
{| Border="1"
| <center>'''Ref No'''</center>
| <center>'''Document Title & ID'''</center>
| <center>'''Version'''</center>
| <center>'''Date'''</center>


|-
| <center>1</center>
| EFX Trip haul.doc
| <center>0</center>
| <center>0</center>


== Glossary ==
|-
| <center>2</center>
| EST-256637 PA-7KPHJ8 EFX Pop-Up box v1.doc
| <center>1</center>
| <center>30/10/08</center>
|}


IMAGE
= Glossary =


Not Available


== Document History ==
= Document History =
{| Border="1"
| <center>'''Version'''</center>
| <center>'''Date'''</center>
| <center>'''Status'''</center>
| <center>'''Reason'''</center>
| <center>'''Initials'''</center>


IMAGE
|-
| <center>1a</center>
| <center>13/11/08</center>
| <center>Draft</center>
| Initial version
| <center>LAD</center>


|-
| <center>1</center>
| <center>13/11/08</center>
| <center>Issued</center>
| Reviewed and Issued
| <center>MJC</center>
|}


== Authorised By ==
= Authorised By =
{| Border="1"
| '''''Matt Crisford'''''
| Development Manager
|


|-
| '''''Suk Sandhu'''''
| TMSCC MTS Product Manager
|


IMAGE
|}

Latest revision as of 14:42, 13 October 2009

256637 PA-7KPHJ8 EFX Pop-Up box

Copyright OBS Logistics © 2009

The information contained herein is the property of OBS Logistics and is supplied without liability for errors or omissions. No part may be reproduced or used except as authorised by contract or other written permission. The copyright and foregoing restriction on reproduction and use extend to all media in which the information may be embodied


Functional Overview

Client Requirement

MTS planning - EFX Pop-Up box - Hide or grey-out 'Trip Cost Man' as a fixed selection, and Hide or grey-out 'Forecast' as a fixed selection

  • When allocating a Trip to EFX the Pop-up box offers several options for Cost - hardcode the cost option as 'Trip Cost Man' and hide or grey-out the selection also hardcode 'Forecast' as the status type again hide or grey-out the selection. This leaves 3 boxes for input - Deadline Date, Deadline Time and Rate
  • re-adjust the 'Tabbing' sequence to navigate from 'deadline Date' to 'deadline time' to 'rate'

Added by SS 24.10.08 - It may be beneficial to have these controlled by parameters within MTS.

Quicker input of data when the various options are not relevant in this situation


Solution

Current functionality in TRIP_SUM and TRIP_PLAN, for EFX Payment Details, are as follows:

  • The EFX Pop Up Box, named ‘Payment Details’ in the Trip Screens is only displayed when the checkbox next to ‘EFX Ref.’ is selected and the current Trip has a Carrier of ‘EFX’
  • This ‘Payment Details’ box is pre-populated with Event Ref (Sched_Name || ‘-‘ || Trip_Id), Debit Account (Cost Centre) and Credit Account (Carrier_Id), which are greyed out and not editable.
  • The user is able to enter a Payment Type and Status, selectable from the drop-down lists


  • The user is able to input an Expiry Date, Time and Amount


  • When saved table ACC_PAYMENT is updated with the info in the ‘Payment Details’ box


The Payment Type drop-down list currently contains the following: AM Deliv AL, Demurrage, Extra Drops, FUELSurch, Fuel Surch, Fuel Surchrg, Premium, Returns, Timed AL, Trip Haul Al, Trip Haul Ma, Trip Haulage

The Payment Status drop-down list currently contains the following: Forecast, Actual, Provisional

Part 1 – EFX Pop-Up Box Input Fields The EFX Pop Up Box will be amended so that when it is displayed, the following items are greyed out and not editable: Event Ref which relates to ‘Sched_Name || ‘-‘ || Trip_Id e.g. ‘081027-MAN-00234567’ Debit Account which relates to the Cost Centre of the Trip Credit Account which relates to the Carrier_Id assigned to the Trip Type will be hard coded as ‘Trip Haul Ma’ Status will be hard coded as ‘Forecast’

Therefore, the only fields that will be editable are: Amount, Expiry Date, Expiry Time

The only situation, where the Type and Status are not hard-coded and greyed out will be governed by a User Group having the function ACC_DIFF_EFX_PAYMENT promoted to their Group. If a user is in a particular group with this function promoted, then they will have the ability to select the Type and Status from the drop-down lists.

This therefore requires a new function to be included in table ADM_FUNCTION, with FN_NAME of ‘ACC_DIFF_EFX_PAYMENT’ and DESCRIPTION of ‘Ability to amend Payment Type and Status for a Trip with a Carrier Id of EFX, in the TRIP screens’.

This function will then be available in the ‘Functions’ tab of the Group Maintenance screen for promoting.


Part 2 – Tabbing Issue When the EFX Pop Up Box is displayed, the tab sequence between fields will be as follows;

When Type and Status Hard-coded: Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning) When Type and Status Editable: Type – Status – Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning)

Scope

This change will be applied to system version 10.6 on CONTST and once approved CONPRD.


Data

A new function needs to be created in table ADM_FUNCTION, called ACC_DIFF_EFX_PAYMENT. The only situation, where the Type and Status are not hard-coded and greyed out will be governed by a User Group having the function ACC_DIFF_EFX_PAYMENT promoted to their Group. If a user is in a particular group with this function promoted, then they will have the ability to select the Type and Status from the drop-down lists. Table ADM_FUNCTION will be updated to include the new function as follows

Functional Description

Sample Layout

Below is a screenshot of how the ‘Functions’ tab within the Group Maintenance form will display when the new function has been created, and is ready to be promoted:

256637 1.png

Below is an example of how the EFX pop-up will be displayed without the promotion of the new function:


256637 2.png


Below is how the EFX Pop-Up Box will be displayed when the user has the new function ACC_DIFF_EFX_Payment promoted to their user group:

256637 3.png


The tabbing sequence between fields within the EFX Pop-Up Box will be as follows:

When Type and Status Hard-coded: Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning)

When Type and Status Editable: Type – Status – Expiry Date – Expiry Time – Amount – OK – Cancel (Back to Expiry Date at Beginning)

This is achieved by setting the ‘Next Navigation Item’ property within the Property Palette for each field in the Pop-Up. Below you can see that the Next Navigable item from the ‘Expiry Date’ will be ‘Expiry Time’:

256637 4.png


Code Amendments

Code is required to set up the EFX Pop-Up box either with the Payment Type and Status hard-coded or else selectable from drop-down lists depending on the new function.


A sql script will need to be run against the test and live databases to insert the new function into table ADM_FUNCTION this is to allow the promotion to user groups if desired in the future:

References

Ref No
Document Title & ID
Version
Date
1
EFX Trip haul.doc
0
0
2
EST-256637 PA-7KPHJ8 EFX Pop-Up box v1.doc
1
30/10/08

Glossary

Not Available

Document History

Version
Date
Status
Reason
Initials
1a
13/11/08
Draft
Initial version
LAD
1
13/11/08
Issued
Reviewed and Issued
MJC

Authorised By

Matt Crisford Development Manager
Suk Sandhu TMSCC MTS Product Manager