Addressbook (component)

From UG

Revision as of 00:27, 31 January 2010 (edit) Alex (Talk | contribs) ← Older edit		Current revision as of 10:48, 13 October 2015 (edit) (undo) Andrei (Talk | contribs) (→Transportation Address Types)
(61 intermediate revisions not shown)
Line 5:		Line 5:
	* Classified As: (small) (large) [[component]] / common [[feature]] / [[misc]]		* Classified As: (small) (large) [[component]] / common [[feature]] / [[misc]]
-	* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]	+	* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=706 706]
-	* Prerequisites: ''any articles that must be read before to understand this?''	+
	=== Scope ===		=== Scope ===
-	* ''List what it covers and what it does not''	+	This is a [[CRUD]] component for CT2 Address Book describing visual representation of [[Address bo]]
		+
		+	=== Related articles ===
		+
		+	* [[Address bo]] - wiki describing Address Business Object itself (independent of UI implemntation - this article); it has links to current DB implementation
	== Business Requirements ==		== Business Requirements ==
-	* ''This section is defined by [[Business Analyst]]''
-	* '' In this section this component/feature is defined from the business standpoint. All important points are listed. It could include some design details if business insists on specific design.''
-	== Notes from Systems Architect ==	+	Need an area where all shipping related addresses can be managed. Each ID should be unique and allow for different address locations that share the same Company Name.
-	* ''This section is defined by [[Systems Architect]]. It is written after [[#Business Requirements]] are defined.''	+
-	* ''The purpose of this section is to give direction to System Analysts who will write detailed specification.''	+
-	== Rapid Design ==	+	The following is a list of types of shipping addresses:
-	* '' In some cases (component is non standard) we need to do ''preliminary'' not so detailed design before detailed final. And maybe even code it to create [[Prototype]]''	+
-	* ''This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.''	+
-	== Detailed Design ==	+	*Shippers
-	* ''This section is defined by [[Systems Analyst]]. ''	+	*Consignees
-	* ''It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.''	+	*Notify Parties
		+	*Pickup Locations
		+	*Delivery Locations
		+	*Receiving Agents
		+	*Bill to Parties
		+	*Trucking Companies
		+	*Cargo Locations
		+	*Warehouses
		+	*Piers
		+	*Customs Brokers
		+	*Customs Inspection Facility
		+	*Jaguar offices
		+	*Overseas Agents
-	=== Summary ===	+	Fields needed:
-	=== User Interface ===	+	*Street address, multiple lines
		+	*City name
		+	*State and/or providence
		+	*Contact names
		+	*Telephone #
		+	*Fax #
		+	*VAT Number
-	=== Functionality / Use Cases ===	+	== Design ==
-	* '' This section you could spit into two. But often it is hard to do since often most of functionality is UI related''	+
-	=== Special Cases and Misc ===	+	=== Address Profile Fields ===
-	* '' If any exist''	+
-	== QA ==	+	==== Company ====
-	''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].	+	==== Company City ====
-	=== Test Cases ===	+	==== Company City Note ====
-	* '' List unusual scenarios - things that user most of the time would not do but system must handle well ''	+
-	* '' Do not list [[Common Test Cases]] - link to them	+
-	== Look and Feel ==	+	====  Remark ====
-	* ''This section is to be written / defined by [[Graphic Designer]] and [[UI Designer]].	+	==== Address 1  ====
-	* '' This includes: final graphics, final layout''	+
-	* '' Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in [[#User Interface and Functionality]] section above''	+	====  Address 2 ====
		+
		+	====  Address 3 ====
		+
		+	====  City ====
		+
		+	====  Zip ====
		+
		+	====  Country ====
		+
		+	====  State ====
		+
		+	====  Contact Person ====
		+
		+	====  Tel ====
		+
		+	==== Fax ====
		+
		+	=== Transportation Address Types ===
		+
		+	This is a list of the types of address can be found under the Transportation Tab.  All of these fields/addresses are used inside of both the CT record and Ocean, Air & Trucking Masters.  As well, most of these fields are shared throughout all MOT, while just a few are MOT specific.  It is also possible that the same address can be found on all 3 Address Type tabs (Transportation,Vendors, Bill to Parties).
		+
		+	*T1: Shipper
		+	*T2: Consignee
		+	*T3: Notify
		+	*T4: Export Pick-up Location
		+	*T5: Export Delivery Location
		+	*T6: Import Pick-up Location
		+	*T7: Import Delivery Location
		+	*T8: Destination Receiving Agent
		+	*T9: Master Pick-Up
		+	*T10: Master Delivery Address
		+	*T11: Master Shipper
		+	*T12: Master Consignee
		+	*T13: Master Notify
		+	*T14: Pool Point
		+	*T15: Yard ''(will be added in mantis #5036)''
		+	*T16: Carrier Yard ''(will be added in mantis #5036)''
		+
		+	=== Vendor Address Types ===
		+
		+	This is a list of the types of address can be found under the Vendor Tab.  All of these fields/addresses are used inside of both the CT record and Ocean, Air & Trucking Masters.  As well, most of these fields are shared throughout all MOT, while just a few are MOT specific.  It is also possible that the same address can be found on all 3 Address Type tabs (Transportation,Vendors, Bill to Parties).
		+
		+	*Trucking Companies(V3)
		+	*Customs Brokers(V4)
		+	*Co-Loaders-Ocean(V5)
		+	*Co-Loaders-Air(V6)
		+	*Cargo Location / CFS(V7)
		+	*Consolidation Warehouse(V8)
		+	*Customs Inspection Facility(V9)
		+	*Jaguar offices(V10)
		+	*Overseas Agent(V11)
		+
		+	=== Bill to Party Address Types ===
		+
		+	See [[Bill To Party]]
		+
		+	== Version 1 ==
		+
		+	In this version address can belong to only ONE of the following categories at once:
		+
		+	* Transportation or
		+	* Vendor or
		+	* Bill To
		+
		+	See [[#Figure_1b]] and [[#Figure_2b]] and [[#Figure_3b]]
		+
		+	== Version 2b ==
		+
		+	'''Note, Version 2a was never implemented & I moved the concept w/ pictures into the history on this article'''
		+
		+	Add VAT number section in Admin > Address Book > Bill To Parties to make this be a part of the address.  See [[#Figure_3]]
		+	*VAT Numbers are 11 Characters.
		+
		+	Add VAT Number on the Sales Invoice under the bill to address.  See [[#Figure_4]]
		+	*The VAT Number needs to print under the address and it should display the words "VAT Number" before the number.
		+	*If no VAT Number is entered in the address book, then the words "VAT Number" should not display on the sales invoice.
	== Figures ==		== Figures ==
-	=== Figure 1:   ===	+	=== Figure 1b ===
-		+	[[File:Tabbed List.JPG]]
-	== Misc ==	+
		+	=== Figure 2b ===
		+	[[File:Trans Edit Add address.JPG]]
		+
		+	=== Figure 3 ===
		+	[[File:VAT No 1.JPG]]
		+
		+	=== Figure 4 ===
		+	[[File:Inv with VAT.JPG]]
		+
		+	== History ==
		+
		+	=== m901 ===
-	=== Link to User Guide ===	+	* [http://mantis.jaguarfreight.com/mantis/view.php?id=901 (*ph1)(Admin AddrBook) Re-design: Address Profile should include all categories: Transportation, Vendors, Bill To]
		+	* see [[#Version 2a]]
-	=== Questions  ===	+	== Version 2a ==
-	=== Request For Comments (Suggestions and Ideas) ===	+	'''This was never implemented as above/below, please refer to current [[#Version_1]] as above for the correct implementation.'''
-	=== Known Non Critical Bugs ===	+	In this version any address may be classified under any Transportation or Vendor or Bill To category.
-	* ''Critical bugs must be posted into Mantis''	+	See [[#Figure_1a]] and [[#Figure_2a]] for Version 2a, where the top 3 category tabs are merged into one.
-	=== Implementation: Link To DB ===	+	=== Filter by category ===
-	=== Implementation: Link To Front End Code ===	+
-	=== Implementation: Link To Back End Code ===	+
-	== History of Updates ==	+	Contains:
-	=== Links to Archived / Old specs ===	+	* [Any]
		+	* [Transportation]
		+	* [Vendors]
		+	* [Bill To]
		+	* T1
		+	* T2
		+	* ... all T- cats
		+	* V3
		+	* V4
		+	* ... all V- cats
-	=== <Update type>:<Update Summary> ===	+	=== Data Migration ===
-	==== Update General Info ====	+
-	* mantis: <link> ''if applicable''	+
-	* [[#Business Requirements]] - Y/N;  [[:Category:BR TBU]]	+	All existing data must be of course migrated into this new format.
-	* [[#Detailed Design]] - Y/N;        [[:Category:DD TBU]]	+
-	* [[#QA]] - Y/N                      [[:Category:QA TBU]]	+
-	* ''Update types: [[Re-design]] / [[Tweak]] / Etc ''	+	=== Figure 1a ===
-	* ''Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to [[:Category:Spec TBU]]. This would list spec as To Be Updated ([[TBU]]) in related category. See below.''	+	[[File:Addrbook v2.JPG]]
-	* If [[#Business Requirements]] (BR) is not updated then add this wiki to [[:Category:BR TBU]]; if [[#Detailed Design]] (DD) ... [[:Category:DD TBU]]; if [[#QA]] (QA) ... [[:Category:QA TBU]]	+	=== Figure 2a ===
		+	[[File:Addrbook v2 combined profile.JPG]]
-	==== Update Description ====	+	=== 0003093 Address book. Add an area to enter a VAT number into the address book ===
-	* ''Briefly explain what was done and list links to updated sections.''	+	Wiki Updated? Y

---

Current revision as of 10:48, 13 October 2015

Contents 1 General Info and Scope 1.1 Scope 1.2 Related articles 2 Business Requirements 3 Design 3.1 Address Profile Fields 3.1.1 Company 3.1.2 Company City 3.1.3 Company City Note 3.1.4 Remark 3.1.5 Address 1 3.1.6 Address 2 3.1.7 Address 3 3.1.8 City 3.1.9 Zip 3.1.10 Country 3.1.11 State 3.1.12 Contact Person 3.1.13 Tel 3.1.14 Fax 3.2 Transportation Address Types 3.3 Vendor Address Types 3.4 Bill to Party Address Types 4 Version 1 5 Version 2b 6 Figures 6.1 Figure 1b 6.2 Figure 2b 6.3 Figure 3 6.4 Figure 4 7 History 7.1 m901 8 Version 2a 8.1 Filter by category 8.2 Data Migration 8.3 Figure 1a 8.4 Figure 2a 8.5 0003093 Address book. Add an area to enter a VAT number into the address book

[edit] General Info and Scope

• Classified As: (small) (large) component / common feature / misc
• Parent Mantis: 706

[edit] Scope

This is a CRUD component for CT2 Address Book describing visual representation of Address bo

[edit] Related articles

• Address bo - wiki describing Address Business Object itself (independent of UI implemntation - this article); it has links to current DB implementation

[edit] Business Requirements

Need an area where all shipping related addresses can be managed. Each ID should be unique and allow for different address locations that share the same Company Name.

The following is a list of types of shipping addresses:

• Shippers
• Consignees
• Notify Parties
• Pickup Locations
• Delivery Locations
• Receiving Agents
• Bill to Parties
• Trucking Companies
• Cargo Locations
• Warehouses
• Piers
• Customs Brokers
• Customs Inspection Facility
• Jaguar offices
• Overseas Agents

Fields needed:

• Street address, multiple lines
• City name
• State and/or providence
• Contact names
• Telephone #
• Fax #
• VAT Number

[edit] Design

[edit] Address Profile Fields

[edit] Company

[edit] Company City

[edit] Company City Note

[edit] Remark

[edit] Address 1

[edit] Address 2

[edit] Address 3

[edit] City

[edit] Zip

[edit] Country

[edit] State

[edit] Contact Person

[edit] Tel

[edit] Fax

[edit] Transportation Address Types

This is a list of the types of address can be found under the Transportation Tab. All of these fields/addresses are used inside of both the CT record and Ocean, Air & Trucking Masters. As well, most of these fields are shared throughout all MOT, while just a few are MOT specific. It is also possible that the same address can be found on all 3 Address Type tabs (Transportation,Vendors, Bill to Parties).

• T1: Shipper
• T2: Consignee
• T3: Notify
• T4: Export Pick-up Location
• T5: Export Delivery Location
• T6: Import Pick-up Location
• T7: Import Delivery Location
• T8: Destination Receiving Agent
• T9: Master Pick-Up
• T10: Master Delivery Address
• T11: Master Shipper
• T12: Master Consignee
• T13: Master Notify
• T14: Pool Point
• T15: Yard (will be added in mantis #5036)
• T16: Carrier Yard (will be added in mantis #5036)

[edit] Vendor Address Types

This is a list of the types of address can be found under the Vendor Tab. All of these fields/addresses are used inside of both the CT record and Ocean, Air & Trucking Masters. As well, most of these fields are shared throughout all MOT, while just a few are MOT specific. It is also possible that the same address can be found on all 3 Address Type tabs (Transportation,Vendors, Bill to Parties).

• Trucking Companies(V3)
• Customs Brokers(V4)
• Co-Loaders-Ocean(V5)
• Co-Loaders-Air(V6)
• Cargo Location / CFS(V7)
• Consolidation Warehouse(V8)
• Customs Inspection Facility(V9)
• Jaguar offices(V10)
• Overseas Agent(V11)

[edit] Bill to Party Address Types

See Bill To Party

[edit] Version 1

In this version address can belong to only ONE of the following categories at once:

• Transportation or
• Vendor or
• Bill To

See #Figure_1b and #Figure_2b and #Figure_3b

[edit] Version 2b

Note, Version 2a was never implemented & I moved the concept w/ pictures into the history on this article

Add VAT number section in Admin > Address Book > Bill To Parties to make this be a part of the address. See #Figure_3

• VAT Numbers are 11 Characters.

Add VAT Number on the Sales Invoice under the bill to address. See #Figure_4

• The VAT Number needs to print under the address and it should display the words "VAT Number" before the number.
• If no VAT Number is entered in the address book, then the words "VAT Number" should not display on the sales invoice.

[edit] Figures

[edit] Figure 1b

[edit] Figure 2b

[edit] Figure 3

[edit] Figure 4

[edit] History

[edit] m901

• (*ph1)(Admin AddrBook) Re-design: Address Profile should include all categories: Transportation, Vendors, Bill To
• see #Version 2a

[edit] Version 2a

This was never implemented as above/below, please refer to current #Version_1 as above for the correct implementation.

In this version any address may be classified under any Transportation or Vendor or Bill To category.

See #Figure_1a and #Figure_2a for Version 2a, where the top 3 category tabs are merged into one.

[edit] Filter by category

Contains:

• [Any]
• [Transportation]
• [Vendors]
• [Bill To]
• T1
• T2
• ... all T- cats
• V3
• V4
• ... all V- cats

[edit] Data Migration

All existing data must be of course migrated into this new format.

[edit] Figure 1a

[edit] Figure 2a

[edit] 0003093 Address book. Add an area to enter a VAT number into the address book

Wiki Updated? Y