Exchange Rates

From UG

Revision as of 20:23, 18 June 2012 (edit) Andrei (Talk | contribs) (→SOW 2) ← Older edit		Revision as of 21:02, 18 June 2012 (edit) (undo) Andrei (Talk | contribs) (→SOW 1) Newer edit →
Line 14:		Line 14:
	== SOW 1 ==		== SOW 1 ==
-	'''0002812: bugs/changes:''' 1) bug: Two GBP currencies listed in the system '''2) add archive feature for currencies'''	+	'''[http://ct.jaguarfreight.com/mantis/view.php?id=2812 0002812]: bugs/changes:''' <span style="text-decoration:line-through">1) bug: Two GBP currencies listed in the system</span> '''2) add archive feature for currencies'''
	=== Core Requirements ===		=== Core Requirements ===

---

Revision as of 21:02, 18 June 2012

Contents 1 Info 2 Business Needs and Requirements 3 SOW 0 4 SOW 1 4.1 Core Requirements 4.2 Related Functionality 5 SOW 2 5.1 Core Requirements 5.2 Solution 5.3 Related Functionality 6 Solution 6.1 Office specific or Global? 7 Currencies 7.1 Summary 7.2 User Interface and Functionality 7.3 View All Table 7.4 Add 7.5 Edit 7.6 Remove 7.7 Entities and Attributes 7.8 Special Cases and Misc 7.9 Look And Feel 7.10 Figures 7.10.1 Figure 1: Manage Currencies. View and Edit. 7.11 DB 8 Exchange Rates and View Exchange Rates 8.1 Summary 8.2 User Interface and Functionality 8.2.1 View 8.2.2 Edit 8.3 Entities and Attributes 8.4 Special Cases and Misc 8.5 Look And Feel 8.6 Figures 8.6.1 Figure 1: View Exchange Rates. 8.6.2 Figure 2: Manage Exchange Rates. 8.7 DB 9 Exchange Rates History 9.1 Info 9.2 Business Needs and Requirements 9.3 Technical Specification 9.3.1 Summary 9.3.2 User Interface and Functionality 9.3.3 Entities and Attributes 9.3.4 Special Cases and Misc 9.3.5 Look And Feel 9.3.6 Figures 9.3.6.1 Figure 1: Exchange Rates History. 9.4 History 9.5 Non Critical Bugs and RFC 9.6 DB 10 Client Company Exchange Rates 10.1 Info 10.2 Business Needs and Requirements 10.3 Technical Specification 10.3.1 Summary 10.3.2 User Interface and Functionality 10.3.2.1 View 10.3.2.2 Add 10.3.2.3 Edit 10.3.2.4 Remove 10.3.3 Entities and Attributes 10.3.4 Special Cases and Misc 10.3.5 Look And Feel 10.3.6 Figures 10.3.6.1 Figure 1: Manage Client Company Exchange Rates. 10.4 History 10.5 Non Critical Bugs and RFC 10.6 DB

Info

• parent mantis - http://ct.jaguarfreight.com/mantis/view.php?id=837

Scope:

This covers "Currencies and Exchange Rates" admin part of Accounting component.

Business Needs and Requirements

SOW 0

See #Solution and next.

SOW 1

0002812: bugs/changes: 1) bug: Two GBP currencies listed in the system 2) add archive feature for currencies

Core Requirements

Archiving feature has the following on Currencies Tab:

• add Archive/Restore and Replace buttons and "Hide archived" checkbox with appropriate functionality for new 2012 standard
  • "Archive" button: get user confirm, mark as archived with image
  • "Restore" button: get user confirm, remove "archived" mark
  • "Replace" button: get user confirm, "merge" two items into one
  • "Hide archived" checkbox:
    • if checked then don't display archived Currencies in table,
    • if unchecked then display all
• add column with a garbage can to mark archived items in table of Currencies

Related Functionality

• Provide recording (and displaying) of all archive-related actions with Currencies in System Log
• For every place in the system where currency is appearing:
  • if currency is tagged as archived then it should not appear on the list

SOW 2

0003577: add Currency Code validation to prevent duplication of Currencies

Core Requirements

We need some sort of validation of what user enters to make sure it's not a duplicate.

• Example: gbp (in lower case) & GBP (in upper case) are the same so the system should not allow it to be saved because its a duplicate.

Solution

• Every Currency Abbreviation should be unique in CT2.
• System should provide entering of Currency Abbreviation in CAPITAL letters only.
• Validation should work upon creating and editing of Currency (in Add/Edit Currency window).
• Comparison should include archived Currencies also.

Related Functionality

• Archive feature for Currencies will be done under mantis 2812

---

Solution

See interface on Fig below.

Location: Acc > Currencies and Exchange Rates

Office specific or Global?

• These components (except Manage Currencies!) are office specific - see an "Office" dropdown

Currencies

Summary

Here is a table of currencies that can be used for calculations in the CT2. This table is shared by all Jaguar offices.

User Interface and Functionality

• See example on Figure 1
• Typical CT2 interface.

View All Table

• attributes listed:

all, see Entities and Attributes

• sort by:

name

• paging:

none

Add

• Click "Add".
• Form in Pop-up will appear
• All fields are blank

Edit

• Select one item on the list and click "Edit"
• Form in Pop-up will appear.

Remove

• Select one item on the list and click "Remove"
• System presents message:

"Are you sure you want to delete all selected Currencies? [Y, N]"

• If currency is already in use then System presents message:

"You cannot delete this Currency as it is used in the system. [OK]"

Entities and Attributes

Currency entity has the following attributes:

• Abbreviation

- meaning: currency code, this will show up on invoices, etc

- format: 3 chars, caps, letters only

- example: USD

- unique

• Name

- meaning: full currency name

- format: 0 to 50 chars, mixed case

- example: US Dollars

Special Cases and Misc

Look And Feel

Figures

Figure 1: Manage Currencies. View and Edit.

DB

Tbl Currency

Exchange Rates and View Exchange Rates

Summary

Exchange Rate is a number assigned to an ordered pair of currencies (Currency1, Currency2). Example: (USD, GBP, 0.63).

In finance, the exchange rates between two currencies specifies how much one currency is worth in terms of the other (wiki).

Each Jaguar Office has its own Exchange Rates.

User Interface and Functionality

CT2 User can view and edit the Exchange Rates on the separate tabs of Currencies And Exchange Rates Home:

• View - on View Exchange Rates tab
• Edit - on Exchange Rates tab

View

• For each currency X in the system displays all pairs (currency Y, exchange rate from X to Y ) for current office. See Figure 1
• columns:
  • Currency From (X)
  • Currency To (Y)
  • Exchange Rate

Edit

• see Figure 2
• steps:

• select "Currency From:" from the dropdown list

• edit whole and decimal parts for required Currency To

• click "Save All Changes"

• (re)defining exchange rate from X to Y would automatically (re)define exchange rate from Y to X

(In other words, if X is set then Y will be automatically re-calculated as Y=1/X. And vice versa).

Entities and Attributes

• Currency From

available currencies in the system

• Currency To

available currencies in the system

• whole part of exchange rate

integer from 0 to 9999999

• decimal part of exchange rate

integer from 0 to 99

Special Cases and Misc

Look And Feel

Figures

Figure 1: View Exchange Rates.

Figure 2: Manage Exchange Rates.

DB

See Tbl Currency Exchange Rate

Exchange Rates History

Info

tbd

Business Needs and Requirements

Technical Specification

Summary

Exchange Rates History is the report that contains all changes of Exchange Rates.

User Interface and Functionality

• See example on Figure 1
• Typical CT2 interface:

- Output HTML table uses standart ZK Paging feature. Each page contains 20 lines.

- Sorting of table proceeds by "Date and Time" column, in ascending order.

Entities and Attributes

Exchange Rates History entity has the following attributes:

• Operator Name

- meaning: Name of CT2 User who made the change of Exchange Rate

- format: First Name + Last Name

- example: Marc Selter

• Date and Time

- meaning: Date and Time of change

- format: datetime stamp (with Time Zone)

- example: 10-Aug-2010 09:35 AM

• Client Company

- meaning: The name of the Client Company for which made this change

- format: string

- example: ABA Packaging

• Currency From

- meaning: name of base currency

- format: abbreviated currency code

- example: GBP

• Currency To

- meaning: name of calculated currency

- format: abbreviated currency code

- example: USD

• Old Rate

- meaning: Exchange Rate value before changing

- format: real number with 2 decimal places

- example: 2.00

• New Rate

- meaning: Exchange Rate value after changing

- format: real number with 2 decimal places

- example: 1.50

Special Cases and Misc

Look And Feel

Figures

Figure 1: Exchange Rates History.

History

Non Critical Bugs and RFC

DB

Client Company Exchange Rates

Info

tbd

Business Needs and Requirements

Technical Specification

Summary

Client Exchange Rate is a number assigned to an ordered triple of (Client Company, Currency1, Currency2). Example: (Coty, USD, GBP, 0.63).

Each Jaguar Office has its own Client Exchange Rates.

User Interface and Functionality

CT2 User can manage the Client Exchange Rates on the special tab of Currencies And Exchange Rates Home - Client Company Exchange Rates. See Figure 1.

View

• attributes listed:

all, see Entities and Attributes

• sort by:

Client Company

• paging:

none

Add

• Click "Add".
• Form in Pop-up will appear
• All fields are blank by default

Edit

• Select one item on the list and click "Edit"
• Form in Pop-up will appear.

NOTE: Unlike the general Exchange Rates, (re)defining exchange rate from X to Y wouldn't automatically (re)define exchange rate from Y to X. It means that setting (Client Company, Currency1, Currency2) will not automatically set (Client Company, Currency2, Currency1).

Remove

• Select one or more items on the list and click "Remove"
• System presents message:

"Are you sure you want to delete all selected Client Company Exchange Rates?"

• Clicking of the "OK" button confirms the removing of selected Rates. Clicking of the "Cancel" button cancels the removing.

Entities and Attributes

• Client Company

available Client Companies in the system

• Currency From

available Currencies in the system

• Currency To

available Currencies in the system

• Rate

real number with 2 decimal places

Special Cases and Misc

Look And Feel

Figures

Figure 1: Manage Client Company Exchange Rates.

History

Non Critical Bugs and RFC

DB