johnkuefler/javainvoicemapper

An educational application meant to mimic an evolving/legacy business app

Invoice Mapper

This is an educational "Legacy" Java app, based on a real world business scenario. It has purposefully been created in a messy state in order to provide students an opportunity to refactor and fix bugs in an existing "Legacy" codebase.

About the Invoice Mapper

The first purpose of this application is to map invoice in a variety of formats into a standardized sales database. The second purpose of this application is to calculate commissions to be paid per sale to salespersons who are also stored in the database. The end goal is to have an automatic process, for multiple formats, for multiple clients, for multiple agents with different commission rates per client.

Business Entities

• Client: A client is a business that we have salespersons (agents) selling products on behalf of.

• Invoice: An invoice is an excel spreadsheet (csv format) of data sent to us each week that has all the raw data bout the sales our agents made this week. Along with each invoice, we also get the amount of money we've been paid by a client for the sales our agents have made.

• Agent:: An agent is a person who sells products on behalf of a client. Agents are paid commissions per successful sale. Commission rates vary by client.

• Sale:: A sale is a record of a product that was sold to a customer. Sales have several statues:

  • Payable: The sale is a good sale, the agent will make a commission on it
  • Non payable: The sale fell through, the agent will make no commission on it
  • Chargeback: The sale was payable at one time, but resulted in a return of some kind, the agent owes us their original commission back.

• FormatMap: A format map tells us what columns from the invoice spreadsheet we will import into which fields of a sale. The format map also tells us What commission rate (e.g. 0.05 - 5%) we will pay on each sale that is brought in.

Key concepts:

• Invoice Revenue: As stated above, each invoice comes with a certain amount of money that we have been paid by the client for thes sales made. Our total revenue for that invoice is that amount - the commissions paid to agents for the sales on the invoice.

• Commission Rates: Commission rates are set per client in the format map. Commission rates are stored as decimals, e.g. 0.05 = 5% commission. See below for some commission scenarios:

  • if a $50 sale is payable at 5% commission rate, commission = $2.50
  • if a $50 sale is non payable at 5% commission rate, commission = $0
  • if a $50 sale is charged back at 5% commission rate, commission = -$2.50

Project Structure

• Root: primarily business logic classes
  • dal: Data access layer classes
  • lib: Core business entities
  • ui: Swing interfaces

Connecting to database

Before you can run the project, you have to connect to add a config file to be able to connect to the db:

• Create a "app.properties" file in InvoiceMapper/src/main/resources
• File should have the following format (you will receive the values of these items in class):

db.host=xxx
db.name=xxx
db.user=xxx
db.password=xxx

javainvoicemapper's Issues

Totals should be cleared when you switch between clients on agent sales report

Add exception logger to method in Client.Java

The setName in Client.Java needs an exception logger added to it for when the user enters invalid inputs. The logger should keep record of when the error occurred, and what was entered to cause the error.

Create a global logger

We should have a global logger that can log to either the console or a text file. Implement this logger where it makes sense.

Add sample app.properties file

Create sales csv report generator

Add the ability to export all sales from the system into a CSV (comma separated values) file when a button is clicked. There is a button on the main page of the app that does nothing that could be used for this.

Update name label on Manage Clients Page

Change this text to "New Client Name:" to be more descriptive

Add more choices to Utilities.ParseBool

Right now the Utilities.ParseBool function turns "Yes" or "yes" into true, and everything else into false. It should be updated to be more specific, error proof, and take more options.

It should have a spsecific else check for "No","no", and then throw an exception if the value is something we don't understand as convertable to a bool.

Also, we should check fore more "bool" values like "true", "false", "1", "0", etc.

Totals should be cleared when you switch between clients on invoice report

Manage agents - change client clear fields

Agent fields should be cleared when client is changed on manage agents page

Add validation for 50 character limit on client names

Total commissions should be formatted as money on the agents sales report

Create ERD for database

Set up the agent listbox to use a better model

On the agents manage page, set up the listbox of agents for the selected client to use a model instead of having to split on - to get the agent id to look the agent up.

Implement better error handling on Invoice Import page

Implement better error handling on the agent sales report page

Add nbactions.xml to .gitignore

Mange agents - id update

Agent id field should not be updatable if updating an agent - only first and last name.

Implement better error handling in Manage Formats Page

Total commissions should be formatted as money on the invoice report

Invoice Format Mapping Revert Changes Button

The end of the revert changes button text gets cut off and is not readable. The button needs to be resized to fit the full text.

Create client - clear name

When a new client is created - name field should be cleared.

Make all sizes and window placements consistent

Going from window to window, things jump all over the place. There should be consistent window sizing and placement.

Manage Client: Creating a client doesn't update the client list.

While in the manage client section when a user attempts to create a client, after hitting create client, the list of clients does not update. The client list only updates after exiting and reentering the manage client section.

After successful invoice import, clear fields

All fields on the invoice import page should be cleared after successful invoice import.

Allow agent sales report to be broken down by invoice

Add better handling on import if an agent isn't found

Add loading indicators during database operations

Implement better error handling on the invoice report page

The title on manage agents page should be centered

Go to manage agents page.
Move "Manage agents" in the middle.

Remove selected client bug

Remove selected client should show an error alert if no client is selected when it is clicked

Redesign main ui

main ui is a mess - needs redesign to look cleaner. All pages should be the same size as well.

Add validation to invoice import

Add validation to invoice import

Implement better error handling in DataService base

Add badges for codacy and travis to readme

Invoice format mapping - validate commission rate

Before saving an invoice format mapping, commission rate should be validated - must be a valid decimal and less than 1 (a % basically)

Better excel date parsing

If the invoice date comes in as an excel date format instead of text, e.g. "12321" or something like that, invoice will not import. It would be nice to be able to import these dates.

Add a dedicated exit button to main page

Import invoices - better date selection

It would be great to implement some kind of swing date picker control here, or to allow for more date formats at lest.

Invoice format mapping - validate columns

Add validation on invoice format mapping screen. All columns should be valid whole numbers, no negatives or decimals allowed.

Add an icon to app

Add an icon for the app instead of the standard java icon

Add formatter to mappings

Work with instructor to add a "formatter" column to mappings table, and then implement it on the invoice mappings screen

View Sales button on main menu does not work

The view sales button on the main.ui does not function when clicked; Should open sales overview.

Better validation and error handling in invoice mapping process

Should not allow same values to be mapped for a spreadsheet (e.g. cant map agent name and agent id both to column 0 for example). Also should not allow column numbers above 999 and below -1

Add validation to create agents page

first and last names can be 50 characters,

agent id can only be up to 10 characters

You can create agents with null properties

This should throw some kind of exception and be rejected by the database

Implement better error handling on Manage Agents page

Clear invoice import fields after import

On the invoice import screen - clear the fields after a successful import.

Move a button over on the main page

Add unit tests for commission calculator

Implement better error handling in Manage Clients Page