Charge Code Admin

From UG

Revision as of 15:02, 8 August 2010 (edit) Andrei (Talk | contribs) (added info from Acc Admin ChargeCodes (AccOld)) ← Older edit		Revision as of 16:20, 8 August 2010 (edit) (undo) Andrei (Talk | contribs) (changed "Remove / Archive" and "Download to Spreadsheet" sections) Newer edit →
Line 46:		Line 46:
	'''Def Quantity Field'''		'''Def Quantity Field'''
	: ''meaning:''		: ''meaning:''
-	: ''type:'' single select, values =  {1, GrossWeight, ChargableWeight, cbm}	+	: ''type:'' single select, values =  {1, Total Gross Kg, Total in cbm, ChargableWeight}
	: ''constraints:''		: ''constraints:''
	: ''using:'' in SI/II		: ''using:'' in SI/II
Line 52:		Line 52:
	'''CBV'''		'''CBV'''
	: ''meaning:''		: ''meaning:''
-	: ''type:'' single select, values =  {chargeable_weight, gross_weight, volume/cbm, CT_count}	+	: ''type:'' single select, values =  {Chargeable Weight, Gross Weight, Volume/CBM, CT Count}
	: ''constraints:''		: ''constraints:''
	: ''using:'' in PI		: ''using:'' in PI
Line 60:		Line 60:
	=== UI and UI based functionality ===		=== UI and UI based functionality ===
	* Path: Acc > CC Admin		* Path: Acc > CC Admin
-	* See Figures 1,2,3	+	* See Figures [[#Figure 1. Table of Charge Codes | 1]],[[#Figure 2. Edit Charge Code window | 2]],[[#Figure 3. Table of Charge Codes (XLS) | 3]]
	==== List ====		==== List ====
Line 66:		Line 66:
	==== Add / Edit ====		==== Add / Edit ====
-	* See Figure 2	+	* See [[#Figure 2. Edit Charge Code window | Figure 2]]
	* This is a typical CT2 style pop-up form.		* This is a typical CT2 style pop-up form.
Line 85:		Line 85:
	:''required? / validation/valid type:'' Y / ???		:''required? / validation/valid type:'' Y / ???
	:''default:'' I		:''default:'' I
		+
		+	'''CC Class'''
		+	:''type/params:'' radio button
		+	:''required? / validation/valid type:'' Y / ???
		+	:''default:'' QxR
	==== Remove / Archive ====		==== Remove / Archive ====
-	TBD	+	'''Remove''' executes upon clicking on "Remove" button. This action requires a user's confirm. The pop-up window of confirm contains warning message ''"Are you sure you want to delete this Charge Code?"'' and action buttons "OK" and "Cancel". A clicking of "OK" confirms the removing of selected Charge Code, in turn a clicking of "Cancel" rejects it.
		+
		+	'''Archive''' feature is not required for the Charge Codes.
	==== Download to Spreadsheet ====		==== Download to Spreadsheet ====
-	* See Figure 3	+	* '''Download''' executes upon clicking on "Download to Excel" button.
-	* ....	+	* The downloaded file looks like on [[#Figure 3. Table of Charge Codes (XLS) | Figure 3]].
		+	* Header of the downloaded table contains a bolded string "Charge Codes" as the title of table. In the next line is printed a timestamp of the time of generating of the table.
		+	* Body of the table completely reflects all lines of the table on [[#Figure 1. Table of Charge Codes | Figure 1]].
	=== Non UI functionality ===		=== Non UI functionality ===
-
	=== Special Cases and Misc ===		=== Special Cases and Misc ===

---

Revision as of 16:20, 8 August 2010

Contents 1 Mantis 2 Business Needs and Requirements 3 Technical Specification 3.1 Summary 3.2 Charge Code as Entity 3.2.1 Attributes 3.2.2 Relationships 3.3 UI and UI based functionality 3.3.1 List 3.3.2 Add / Edit 3.3.3 Remove / Archive 3.3.4 Download to Spreadsheet 3.4 Non UI functionality 3.5 Special Cases and Misc 3.6 Figures 3.6.1 Figure 1. Table of Charge Codes 3.6.2 Figure 2. Edit Charge Code window 3.6.3 Figure 3. Table of Charge Codes (XLS) 4 History 5 RFC 6 DB

Mantis

tbd

Business Needs and Requirements

Technical Specification

Summary

Charge Codes are introduced into accounting part of the system to help categorize different kinds of charges for shipment. Final amount that Jaguar would charge client for servicing one shipment consists of several parts each corresponding to the type of service provided.

For example, typical shipment would include separate fee for delivery from door to port, fee for crossing the ocean, delivery from port to door, customs fees, etc. In CT2 system each such fee would have unique numbers and properties. This would allow for special reporting and other features.

To better understand how CC influence the system read specs for CT2 components that use CC codes: TOC, PI, SI/II, P/L.

CC admin table provides management of CC in the system.

Charge Code as Entity

Each CC object has 6 required fields (attributes): CC #, Description, M/I, CC Class, Def Quantity Field, Def CBV Type.

Attributes

CC#

meaning: unique short number to identify CC

type: number

constraints: 4 digits, must be unique

using:

Descr

meaning: human readable one line CC description

type: string

constraints: 0 to 30 chars

using:

M/I

meaning: CC associated with Master or Individual CT?

type: values = {M, I}

constraints:

using: in PI

CC class

meaning:

type: single select, values = {QxR, %}

constraints:

using: in SI/II

Def Quantity Field

meaning:

type: single select, values = {1, Total Gross Kg, Total in cbm, ChargableWeight}

constraints:

using: in SI/II

CBV

meaning:

type: single select, values = {Chargeable Weight, Gross Weight, Volume/CBM, CT Count}

constraints:

using: in PI

Relationships

UI and UI based functionality

• Path: Acc > CC Admin
• See Figures 1, 2, 3

List

• See Figure 1

Add / Edit

• See Figure 2
• This is a typical CT2 style pop-up form.

UI Controls on the form:

CC#

type/params: textbox, max 4 chars, visible 4 chars

required? / validation / valid type: Y / all entity constraints / instant

default: empty

Description

type/params: textbox, max ??? chars, visible ??? chars

required? / validation/valid type: Y / ???

default: empty

M/I

type/params: radio button

required? / validation/valid type: Y / ???

default: I

CC Class

type/params: radio button

required? / validation/valid type: Y / ???

default: QxR

Remove / Archive

Remove executes upon clicking on "Remove" button. This action requires a user's confirm. The pop-up window of confirm contains warning message "Are you sure you want to delete this Charge Code?" and action buttons "OK" and "Cancel". A clicking of "OK" confirms the removing of selected Charge Code, in turn a clicking of "Cancel" rejects it.

Archive feature is not required for the Charge Codes.

Download to Spreadsheet

• Download executes upon clicking on "Download to Excel" button.
• The downloaded file looks like on Figure 3.
• Header of the downloaded table contains a bolded string "Charge Codes" as the title of table. In the next line is printed a timestamp of the time of generating of the table.
• Body of the table completely reflects all lines of the table on Figure 1.

Non UI functionality

Special Cases and Misc

Figures

Figure 1. Table of Charge Codes

Figure 2. Edit Charge Code window

Figure 3. Table of Charge Codes (XLS)

History

• See Acc Admin ChargeCodes

RFC

DB

Tbl Charge Code