Addressbook (component)

From UG

(Difference between revisions)

Jump to: navigation, search

Current revision as of 10:48, 13 October 2015

[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

[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

@@ Line 1: / Line 1: @@
-[[Category:OpsAdmin]]
+[[Category:Addressbook]]
@@ Line 5: / Line 5: @@
 * 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 ===
-* ''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 ==
-* ''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.''
+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
 == Design ==
 === Address Profile Fields ===
+==== Company ====
 ==== Company City ====
+==== Company City Note ====
 ====  Remark ====
@@ Line 47: / Line 78: @@
 ==== Fax ====
-== Version 2 ==
+=== Transportation Address Types ===
-In this version any address may be classified under any Transportation or Vendor or Bill To category.
+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).
-See [[#Figure1]] and [[#Figure2]].
+*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 ==
+=== Figure 1b ===
+[[File:Tabbed List.JPG]]
+=== Figure 2b ===
+[[File:Trans Edit Add address.JPG]]
+=== Figure 3 ===
+[[File:VAT No 1.JPG]]
+=== Figure 4 ===
+[[File:Inv with VAT.JPG]]
+== History ==
+=== m901 ===
+* [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]]
+== 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.
-top category tabs are merged into one.
+See [[#Figure_1a]] and [[#Figure_2a]] for Version 2a, where the top 3 category tabs are merged into one.
 === Filter by category ===
@@ Line 70: / Line 181: @@
 * ... all V- cats
-== Figures ==
+=== Data Migration ===
-=== Figure 1 ===
+All existing data must be of course migrated into this new format.
+=== Figure 1a ===
 [[File:Addrbook v2.JPG]]
-=== Figure 2 ===
+=== Figure 2a ===
 [[File:Addrbook v2 combined profile.JPG]]
-== History ==
+=== 0003093 Address book. Add an area to enter a VAT number into the address book ===
+Wiki Updated? Y
-=== m901 ===
-* [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 2]]