Billing Required Report

From UG

Revision as of 22:00, 7 December 2011 (edit) Tracie (Talk | contribs) (→SOW 3) ← Older edit		Current revision as of 17:15, 19 January 2015 (edit) (undo) Andrei (Talk | contribs) (→Summary of Hard coded conditions)
(25 intermediate revisions not shown)
Line 37:		Line 37:
	Include all shipments that:		Include all shipments that:
	* have a P/L of 0 or less AND		* have a P/L of 0 or less AND
-	* have an actual arrival date confirmed	+	* have an actual arrival date confirmed OR created more than 120 days ago
	''Section added: --[[User:Alex|Alex]] 18:24, 6 December 2011 (EST)''		''Section added: --[[User:Alex|Alex]] 18:24, 6 December 2011 (EST)''
Line 128:		Line 128:
	* '''0003203: (OpsRep): Billing Required Report (SOW 3)'''		* '''0003203: (OpsRep): Billing Required Report (SOW 3)'''
-	=== Action required reports ===	+	=== Glossary ===
-		+
		+	* [[P and L currency]]
	=== Mechanism to authorize a loss ===		=== Mechanism to authorize a loss ===
Line 148:		Line 148:
	==== UI Design ====		==== UI Design ====
-	[[File:Loss approval panel.JPG]]	+	[[File:Icom section.JPG]]
-	Add above to P/L tab.	+	Add the above to the ICom tab
-		+
-	Or	+
-		+
-	[[File:Icom section.JPG]]	+
-	add the above to the ICom tab	+
	==== Main Use case (story) ====		==== Main Use case (story) ====
Line 170:		Line 165:
	It is a new loss and new approval is required.		It is a new loss and new approval is required.
-	A history of these actions should be recorded.	+	A history of these actions should be recorded in Update Log.
-	==== Very small group of users should have access to this ====	+	==== Add this to Users Roles Admin ====
-	Requirement: Give access to "Authorize a loss" functionality to Simon only for now (nobody can add themselves). Very soon couple of other users could be added to this.	+	Ability to "Authorize a loss" should be added as an option to Users Roles Admin . It will be only granted to very small group of users.
		+	All other users should see this checkbox as read only.
-	Solution: (Alex) - for Sasha to review and approve or suggest alternative:	+	Note to QA and BA
-	* I suggest adding "Superuser" role.	+	-----------------
-	* Only superusers can manage "Users Roles Admin".	+	"Authorize a loss" item should be linked to "Super Management" role or "Authorize a loss" role.
-	* Users under this role could be added only by Sys Admin (Vlad).	+	Both roles do not exist now.
-	* We assume that there would be only 2-6 Superusers (small group).	+
-	* In this case:	+
-	** "Authorize a loss" item would be added to the access list	+
-	** above item would be linked to "Super Management" role or "Authorize a loss" role	+
	=== Global Loss vs Office specific Loss ===		=== Global Loss vs Office specific Loss ===
-	MO also wants to post CTs to this report that have GM > 0 but "GM per office" <= 0.	+	''' !!!! This requirement was removed by Simon '''
-	The loss amount of the individual office should NOT be added into the total loss amount displayed on dashboard.  Only total global loss should be added to this figure.	+	=== Loss in Main P and L currency vs Loss in Additional P and L currency ===
-	In order to display the loss by office, we will need to add 5 columns to the output.	+	See definitions here: [[P and L currency]]
-	*One column for global loss	+
-	*One column for each individuals office loss	+
-	Report should list each P/L 0.00 or less and leave any other cells empty.	+	If P/L in Additional P/L currency is defined and it is positive while corresponding P/L in Main P/L currency is negative or zero then do not consider that a Loss.
-		+
-	=== Loss in local currency vs Loss in USD ===	+
-		+
-	Total Profit/loss in "local" (non USD) currency then make decision about Loss based on GM in "local" currency.	+
-	*  This is because the conversion to USD is causing an artificial loss.	+
-		+
-	If there is more than 1 "local" currency, then show USD.	+
	==== Example of perceived loss ====		==== Example of perceived loss ====
Line 213:		Line 196:
-	=== Special date May 1 2010 ===	+	=== Billing Required Start Date ===
-		+
-	Any shipments created prior to 5/1/2010 should not be included on this report.	+
-	Alex:	+	Any shipments created prior to 5/1/2010 (Billing Required Start Date) should not be included on this report.
	* pls make it part of config file, do not hardcore.		* pls make it part of config file, do not hardcore.
-	* post note to report UI and output: " shipments created prior to 5/1/2010 are not included on this report"	+	* post note to report UI and output: " shipments created prior to [Billing Required Start Date] are not included on this report"
	== History ==		== History ==

---

Current revision as of 17:15, 19 January 2015

Contents 1 Info 1.1 Parent Mantis 1.2 Scope of this wiki 2 Version 1 2.1 SOW 1 2.1.1 Business requirements - Phase 1 2.1.1.1 Summary of Hard coded conditions 2.1.2 Filters 2.1.3 Output 2.1.3.1 Level One 2.1.3.2 Level Two 2.1.3.3 Level Three 2.1.3.3.1 Report Output Columns 2.1.4 Example of output 2.1.4.1 Level One Output 2.1.4.2 Level Two Output 2.1.4.3 Level Three Output 2.1.4.3.1 HTML Version 2.1.4.3.2 Excel Version 3 Version 2 3.1 SOW 2 3.1.1 Groupped CT case 4 SOW 2a 5 SOW 3 5.1 Glossary 5.2 Mechanism to authorize a loss 5.2.1 UI Design 5.2.2 Main Use case (story) 5.2.3 CT can re-appear on this report 5.2.4 Add this to Users Roles Admin 5.3 Global Loss vs Office specific Loss 5.4 Loss in Main P and L currency vs Loss in Additional P and L currency 5.4.1 Example of perceived loss 5.5 CT link to the Edit Not View 5.6 Billing Required Start Date 6 History 6.1 0003192: (OpsRep): Billing Required Report (ver 1) 6.2 0003237: (OpsRep):Billing Required Report-Bug:Report should display the group P/L amount for any record that is part of a group (ver2)) 7 User Guide 7.1 Config 7.2 Lev 1 and 2 7.3 Lev 3 7.4 Output 7.5 Business Logic 7.6 User Guide Status and SOW covered

[edit] Info

[edit] Parent Mantis

0003192: (OpsRep): Billing Required Report

[edit] Scope of this wiki

Covers one report.

[edit] Version 1

[edit] SOW 1

Operators are responsible to check the gross margin of each shipment. To assist with this, it is requested a dashboard report (or email option) be created that can alert operators of any shipments showing no profit or a negative profit.

[edit] Business requirements - Phase 1

Report should be added to the report scheduler - action required reports

Report should have email and dashboard option

Include all shipments that have a P/L of 0 or less

This should include:

• CT's with no sales invoices and no purchase invoices.
• CT's that the total sales invoices are lower then the total purchases invoices.
• CT's with purchases invoices and no sales invoices.
  • Basically the only shipments that should NOT be included on this report are shipments that the total sales invoices that are greater then the total purchase invoices.

Exclude any shipments that do not have an actual arrival date confirmed

[edit] Summary of Hard coded conditions

Include all shipments that:

• have a P/L of 0 or less AND
• have an actual arrival date confirmed OR created more than 120 days ago

Section added: --Alex 18:24, 6 December 2011 (EST)

[edit] Filters

Filters are to be defined in next phase

[edit] Output

[edit] Level One

Dashboard to display

• Report Name

• Counter = the total amount of loss in USD.
  • The number should be a hyperlink to the next level.

For example
If the report lists:
CT# 123456  P/L -123.00
CT# 234567  P/L    0.00
CT# 345678  P/L    0.00
CT# 456789  P/L  -22.00
CT# 567891  P/L    0.00
Total loss:     -145.00 
The dashboard should show:
Billing Required Report:  -145.00

[edit] Level Two

To be defined in next phase

[edit] Level Three

In first phase, clicking the hyperlink should open html report.

• This report should be downloadable to excel

[edit] Report Output Columns

• CT number
  • as a hyperlink to the CT record
• CT created on date
• E0. Client Company
• Origin Country
• Destination Country
• Mode Of Transport
• Actual Arrival date
• Total Profit/Loss amount

[edit] Example of output

[edit] Level One Output

[edit] Level Two Output

To be defined in next phase

[edit] Level Three Output

[edit] HTML Version

To be added

[edit] Excel Version

[edit] Version 2

[edit] SOW 2

[edit] Groupped CT case

This report should ONLY include the 1st or lowest CT record within the group. Not each of the CT numbers for the group.

Example:

GRP# 55763 CT# 123456 CT# 123457 CT# 123458 CT# 123459 CT# 123460

Report should show only CT# 123456

The P/L amount displayed on the report, should be the "group" P/L amount. The same amount that is displayed on the P/L tab in CT.

[edit] SOW 2a

This work was done under DR/KPI task: see DR_for_9_existing_Action_Required_internal_reports#One_more_AR_added_to_the_group

[edit] SOW 3

• 0003203: (OpsRep): Billing Required Report (SOW 3)

[edit] Glossary

• P and L currency

[edit] Mechanism to authorize a loss

Management would like the ability to be able to approve a loss on a specific CT or Group.

This "loss approval"" feature should be within the actual CT record, not part of the report.

MO has requested this be added in the ICOM section or P&L tab of the CT record.

• In the ICom tab the user approving this loss can read the explanation of loss if posted in this section and will also be able to add a comment into this section.

• In the P/L tab the user will view profit and loss history.

Once the loss is approved, the record should be removed from the report.

[edit] UI Design

Add the above to the ICom tab

[edit] Main Use case (story)

• Simon opens this report and clicks the CT hyperlink to see why this record has a loss. If he can not determine this by viewing P/L screen then he will read notes in ICom section to see if explanation is there.
• After that he might:
  • post ICom note requesting explanation
  • approve Loss

[edit] CT can re-appear on this report

In the case that a new purchase invoice is assigned against a record or group, that has already been approved for a loss, the approval should automatically be voided by the system and record should again be added to the report.

It is a new loss and new approval is required.

A history of these actions should be recorded in Update Log.

[edit] Add this to Users Roles Admin

Ability to "Authorize a loss" should be added as an option to Users Roles Admin . It will be only granted to very small group of users. All other users should see this checkbox as read only.

Note to QA and BA
-----------------
"Authorize a loss" item should be linked to "Super Management" role or "Authorize a loss" role.
Both roles do not exist now.

[edit] Global Loss vs Office specific Loss

 !!!! This requirement was removed by Simon

[edit] Loss in Main P and L currency vs Loss in Additional P and L currency

See definitions here: P and L currency

If P/L in Additional P/L currency is defined and it is positive while corresponding P/L in Main P/L currency is negative or zero then do not consider that a Loss.

[edit] Example of perceived loss

[edit] CT link to the Edit Not View

Hyperlinks in the Excel report should link to the “Edit” Not “View” visibility of a CT record.

[edit] Billing Required Start Date

Any shipments created prior to 5/1/2010 (Billing Required Start Date) should not be included on this report.

• pls make it part of config file, do not hardcore.
• post note to report UI and output: " shipments created prior to [Billing Required Start Date] are not included on this report"

[edit] History

[edit] 0003192: (OpsRep): Billing Required Report (ver 1)

[edit] 0003237: (OpsRep):Billing Required Report-Bug:Report should display the group P/L amount for any record that is part of a group (ver2))

[edit] User Guide

[edit] Config

[edit] Lev 1 and 2

[edit] Lev 3

[edit] Output

[edit] Business Logic

• #Summary of Hard coded conditions
• #Groupped CT case

[edit] User Guide Status and SOW covered

• Up to date=Y
• SOW covered: #SOW 1, #SOW 2, #SOW 2a