Charge Code Admin

From UG

(Difference between revisions)
Jump to: navigation, search
(Figures: added Figure 3. Table of Charge Codes (XLS))
(added info from Acc Admin ChargeCodes (AccOld))
Line 7: Line 7:
== Technical Specification ==
== Technical Specification ==
=== Summary ===
=== 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.
 +
 +
[[#Figure 1. Table of Charge Codes | CC admin table]] provides management of CC in the system.
=== Charge Code as Entity ===  
=== 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 ====
==== Attributes ====
Line 14: Line 22:
'''CC#'''
'''CC#'''
: ''meaning:'' unique short number to identify CC
: ''meaning:'' unique short number to identify CC
-
:''type:'' number
+
: ''type:'' number
-
:''constraints:'' 4 digits, must be unique
+
: ''constraints:'' 4 digits, must be unique
 +
: ''using:''
'''Descr'''
'''Descr'''
: ''meaning:'' human readable one line CC description
: ''meaning:'' human readable one line CC description
-
:''type:'' string
+
: ''type:'' string
-
:''constraints:'' 0 to 30 chars  
+
: ''constraints:'' 0 to 30 chars  
 +
: ''using:''
'''M/I'''
'''M/I'''
: ''meaning:'' CC associated with Master or Individual CT?
: ''meaning:'' CC associated with Master or Individual CT?
-
:''type:'' values = {M, I}
+
: ''type:'' values = {M, I}
-
:''constraints:''
+
: ''constraints:''
 +
: ''using:'' in PI
'''CC class'''
'''CC class'''
-
:''type:''  
+
: ''meaning:''  
-
:''constraints:''
+
: ''type:'' single select, values =  {QxR, %}
-
:single selectt, values =  {QxR, %}; used in SI/II  
+
: ''constraints:''
 +
: ''using:'' in SI/II  
'''Def Quantity Field'''
'''Def Quantity Field'''
-
:single select, values =  {1, GrossWeight, ChargableWeight, cbm}; used in SI/II  
+
: ''meaning:''
 +
: ''type:'' single select, values =  {1, GrossWeight, ChargableWeight, cbm}
 +
: ''constraints:''
 +
: ''using:'' in SI/II  
'''CBV'''
'''CBV'''
-
:single select, values =  {chargeable_weight, gross_weight, volume/cbm, CT_count}; used in PI
+
: ''meaning:''
 +
: ''type:'' single select, values =  {chargeable_weight, gross_weight, volume/cbm, CT_count}
 +
: ''constraints:''
 +
: ''using:'' in PI
==== Relationships ====
==== Relationships ====
-
 
=== 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 1,2,3
-
 
==== List ====
==== List ====
-
* See Figure 1
+
* See [[#Figure 1. Table of Charge Codes | Figure 1]]
==== Add / Edit ====
==== Add / Edit ====

Revision as of 15:02, 8 August 2010


Contents

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, GrossWeight, ChargableWeight, cbm}
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

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

Remove / Archive

TBD

Download to Spreadsheet

  • See Figure 3
  • ....

Non UI functionality

Special Cases and Misc

Figures

Figure 1. Table of Charge Codes

File:ChargeCodes.gif

Figure 2. Edit Charge Code window

File:EditChargeCodeWindow.gif

Figure 3. Table of Charge Codes (XLS)

File:ChargeCodesXLS.gif

History

RFC

DB

Tbl Charge Code

Personal tools