Charge Code Admin

From UG

(Difference between revisions)
Jump to: navigation, search
(→UI and UI based functionality: added MenuAccChargeCodes.gif)
 
(12 intermediate revisions not shown)
Line 1: Line 1:
-
[[Category:Acc Basics]]
+
[[Category:Acc]]
 +
== Info ==
-
== Mantis ==
+
Parent: 3122
-
[http://mantis.jaguarfreight.com/mantis/view.php?id=837 0000837]
+
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.
-
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.
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.
Line 13: Line 13:
To better understand how CC influence the system read specs for CT2 components that use CC codes: TOC, PI, SI/II, P/L.
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.
+
== Component Description ==
-
 
+
-
=== 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 ===
'''CC#'''
'''CC#'''
Line 50: Line 47:
: ''using:'' in SI/II  
: ''using:'' in SI/II  
-
'''CBV'''
+
'''Def CBV Type'''
: ''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}
Line 56: Line 53:
: ''using:'' in PI
: ''using:'' in PI
-
==== Relationships ====
+
=== Admin ===
-
=== UI and UI based functionality ===
+
* Acc -> Carge Codes
-
* Path: Acc > CC Admin
+
-
[[File:MenuAccChargeCodes.gif]]
+
-
* 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 ====
-
* See [[#Figure 1. Table of Charge Codes | Figure 1]]
 
-
==== Add / Edit ====
+
* HTML view of all items
-
* See [[#Figure 2. Edit Charge Code window | Figure 2]]
+
 
 +
==== Add ====
 +
 
 +
See below.
 +
 
 +
==== Edit ====
 +
 
* This is a typical CT2 style pop-up form.
* This is a typical CT2 style pop-up form.
Line 102: Line 101:
:''default:'' Chargeable Weight
:''default:'' Chargeable Weight
-
==== Remove / Archive ====
+
==== 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.
'''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 ====
 
* '''Download''' executes upon clicking on "Download to Excel" button.
* '''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 ===
 
-
 
-
=== 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 ==
 
-
* See [[Acc Admin ChargeCodes]]
 
-
 
-
== RFC ==
 
-
== DB ==
+
* 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
-
[[Tbl Charge Code]]
+
* Body of the table completely reflects all lines of the HTML table

Current revision as of 05:29, 6 November 2013

Contents

[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
Retrieved from "https://wiki.jaguarfreight.com/Charge_Code_Admin"
Personal tools