Charge Code Admin

From UG

Revision as of 21:29, 15 December 2009 (edit) Alex (Talk | contribs) ← Older edit		Current revision as of 05:29, 6 November 2013 (edit) (undo) Alex (Talk | contribs)
(37 intermediate revisions not shown)
Line 1:		Line 1:
	[[Category:Acc]]		[[Category:Acc]]
		+	== Info ==
-	== Mantis ==	+	Parent: 3122
-	[http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]	+	Category: Charge Codes
-	== Business Needs and Requirements ==	+	== Business Needs ==
-	== 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.
-	=== User Interface ===	+
-	=== Special Cases ===	+	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.
-	=== Figures ===	+
-	==== Figure: XXX ====	+	To better understand how CC influence the system read specs for CT2 components that use CC codes: TOC, PI, SI/II, P/L.
-	== History ==	+
-	== RFC ==	+	== Component Description ==
		+
		+	=== 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
		+
		+	'''Def CBV Type'''
		+	: ''meaning:''
		+	: ''type:'' single select, values = {Chargeable Weight, Gross Weight, Volume/CBM, CT Count}
		+	: ''constraints:''
		+	: ''using:'' in PI
		+
		+	=== Admin ===
		+
		+	* Acc -> Carge Codes
		+
		+	==== List ====
		+
		+	* HTML view of all items
		+
		+	==== Add ====
		+
		+	See below.
		+
		+	==== Edit ====
		+
		+	* 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
		+
		+	'''Def Quantity Field'''
		+	:''type/params:'' dropdown list
		+	:''required? / validation/valid type:'' Y / ???
		+	:''default:'' 1
		+
		+	'''Def CBV Type'''
		+	:''type/params:'' dropdown list
		+	:''required? / validation/valid type:'' Y / ???
		+	:''default:'' Chargeable Weight
		+
		+	==== Remove ====
		+
		+	'''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.
		+
		+	==== Download to Spreadsheet ====
		+
		+	* '''Download''' executes upon clicking on "Download to Excel" button.
		+
		+	* 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 HTML table

---

Current revision as of 05:29, 6 November 2013

Contents 1 Info 2 Business Needs 3 Component Description 3.1 Attributes 3.2 Admin 3.2.1 List 3.2.2 Add 3.2.3 Edit 3.2.4 Remove 3.2.5 Download to Spreadsheet

[edit] Info

Parent: 3122 Category: Charge Codes

[edit] Business Needs

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.

[edit] Component Description

[edit] 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

Def CBV Type

meaning:

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

constraints:

using: in PI

[edit] Admin

• Acc -> Carge Codes

[edit] List

• HTML view of all items

[edit] Add

See below.

[edit] Edit

• 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

Def Quantity Field

type/params: dropdown list

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

default: 1

Def CBV Type

type/params: dropdown list

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

default: Chargeable Weight

[edit] Remove

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.

[edit] Download to Spreadsheet

• Download executes upon clicking on "Download to Excel" button.

• 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 HTML table