PAS by DTLakmal

VIEWS: 26 PAGES: 28

									Technical Document for PAS distributors system




Institute of Java & Software Engineering
Associate Java Developer Final Project Documentation


Technical Document for
PAS distributors system
Version 1.0

Prepared by :S.H.Vinu Ramal Fernando.


2012-03-06.




                                                                                          1|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


                                    Table of Content
1. Introduction to Business
        1.1 Project Supervisor Details                                         <Page number>
        1.2 Summery of the Business                                            <Page number>
        1.3 Location of the Business                                           <Page number>
        1.4 Project Scope                                                      <Page number>
        1.5 Reference                                                          <Page number>

2. Architectural View
        2.1 Business Process Diagram                                           <Page number>
        2.2 Project Architecture                                               <Page number>
        2.3 Usecase Diagram                                                    <Page number>
        2.4 Actors and Job roles                                               <Page number>
3. Data Analyzing
        3.1 ER- Diagram                                                        <Page number>
        3.2 Assumption of ERD                                                  <Page number>
        3.3 Normalization                                                      <Page number>
        3.4 Relational Schema                                                  <Page number>
        3.5 Data Format and Models                                             <Page number>

4. Functional Level Design
        4.1 User Interfaces                                                    <Page number>
        4.2 Hardware Interfaces                                                <Page number>
        4.3 Operation Environment                                              <Page number>
        4.4 Development Environment                                            <Page number>

5. Dynamic Views
       5.1 Reports                                                             <Page number>

6. Nonfunctional Level
       6.1 Configuration Settings                                              <Page number>
       6.2 Hardware Requirements                                               <Page number>
       6.3 Software Requirements                                               <Page number>
       6.4 Backup System and Configuration


Glossary




                                                                                           2|Page
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


1.1 Project Supervisor Details


            Name of the Supervisor : Mr.Gayan Dinushka.


            Student Name : S.H.Vinu Ranal Fernando.




....................................................                             ...................................................

Supervisor signature                                                             Student signature




Approval for the final project presentation and viva




.....................................................                            ...................................................

Dr.Niroth Samarawickrama                                                         Mr.Prasad Waduge

Director Training                                                                Project Cordinator



Date :




                                                                                                                   3|Page
                         Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




1.2 Summery of the Bussiness
              Owner                  :        Mr. Sanjeeva Priyashantha

              Main Process            :       Distributing CBL products

              Business Processes      :       Distributing CBL products
                                              Selling CBL products

              Gross Income            :       Rs.60000/=
              (Per month)

              Market Rankings         :       Top Level Ranking in distributing



      Business Scope

              No of Employees         :       15

              No of Actors            :       1
               (Software Users)

              No of Buildings         :       1




                                                                                          4|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


1.3 Location of the Business




                                              Atalugama road
                                                               PAS Distributors

              Horana road




                                                      Bank of ceylon



                                              Kaluthara road
       Bandaragama Town




                                                                                          5|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


1.4 Project Scope

       Pas distributors system is specified to manage the customer’s stock
       information
       Such as,

              Update items
              Add items
              View items

       And also the customer information can be have at the same time.

       Main benifit for the client is ,When adding a order client doesn’t have to
       worry about to update current items and details. Software it self updating
       the current stock uptodate.

       The main goal of the software is to handle customers,items and orders at
       the same time.




1.5 References




                                                                                          6|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


2. Architectural Views
      2.1 Business Process Diagram


Customer



           Place Order




           Process Order                      Deliver goods




                                                 Delivey
                                                                    No               Refund
                                                 Success?



                                                      Yes




                                             Comlpete Order




                                                                                          7|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


4. Functional Level Design

       4.1 User Interfaces

       <Log In Screen>




       Purpose- to enter the software you need to provide a password.

       This is to prevent unathorized access

      Field discribe                   Maximum length                      constrint
User Name TextField                    100                           Not null(char,numbers)
PassWord Field                         100                           Not null(char,numbers)
Log_In_Button

Log_in_Button_Action_performed

1.log into the system



                                                                                          8|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




Exit_Button_Action_Performed,

       1.exit from the system tray



<Home Screen>




       Add_Customer_Button_ActionPerformed

              1.To Visible the Add customer form

       Search_Customer_Button_Action_Performed


                                                                                          9|Page
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


              1.To visible the Search customer form

       View_Customer_Button-Action_Performed

              1.To visible the View Customer form

       Delete_Customer_Button_Action_performed

              1.To visible the Delete customer form

       Update_Customer_Button_Action_Preformed

              1. To visible the Update customer form

       Add_Order_Button_Action_Performed

              1. To visible the Add Customer form

       Search_Order_Button_Action_performed

              1. To visible the Search order form

       Add_Item_Button_ActionPerformed

              1.To Visible the Add Item form

       Search_Item_Button_Action_Performed

              1.To visible the Search Item form

       View_Item_Button-Action_Performed

              1.To visible the View Items form

       Delete_Item_Button_Action_performed

              1.To visible the Delete Item form

 Update_Item_Button_Action_Performed

       1. To visible the update Item form




                                                                                          10 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




Login as administrator Button_Action_Performed.

       1.visible admin log in pane.




Purpose-to verify that admin is logged

      Field discribe                     Maximum length                    constrint
User Name TextField                      100                         Not null(char,numbers)
PassWord Field                           100                         Not null(char,numbers)


Access Button action_performed.Two functions will triger.

       1.check username and password,Log in as admin.

       2.enable all locked functions.


                                                                                          11 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


Cancel Button Action_performed.

       1.exit admin login pane.



<AddCustomer> Purpose-To add customers indetail.




Field describe             Maximum length                            constraint
Cus ID TextField           10                                        Not Null(char,numbers)
Name textField             30                                        Not Null(char,numbers)
Address textField          100                                       Not Null(char,numbers)
Contact Text               10                                        Null allowed(numbers)
Add_Button_Action_Performed,three fuctions will trigger

              1.Validate all textFields     2.Add customer details to the database
              3.clear all TextFields

                                                                                          12 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




Clear_Button_Action_Performed

              1. clear all TextFields

Home_Button_Action_performed,two functions will trigger

              1.exit from the system tray      2.To visible Home Screen

Cancel_Button_Action_Performed

              1. exit from the system tray

Search_Customer_Button_Action_Performed

              1.To visible the Search customer form

View_Customer_Button-Action_Performed

              1.To visible the View Customer form

Delete_Customer_Button_Action_performed

              1.To visible the Delete customer form

Update_Customer_Button_Action_Preformed

              1. To visible the Update customer form

Add_Order_Button_Action_Performed

              1.To visible the Add Order form




                                                                                          13 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




<Search customer>




Purpose-To search a specific customer,

Field describe             Maximum length                            Constraint
Customer Name TextField    30                                        Null allowed(char,numbers)
Home_Button_Action_performed,two functions will trigger

              1.exit from the system tray      2.To visible Home Screen

Cancel_Button_Action_Performed

              1. exit from the system tray

QuickMenu_Button_Action_Performed


                                                                                          14 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


1.Visible the quick access Buttons



<View Customers>




Purpose-to view the all currently added customers

Get_Report_Button_Actio_Performed

              1.view the report of the customer details

Refresh_Button_Action_Performed

              1.to refresh customer list

Cancel_Button_Action_Performed

              1. exit from the system tray

                                                                                          15 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




<Delete Customer>




Purpose-to delete aspecific,unwanted customer

Field describe              Maximum length                           Constraint
Customer Name TextField     30                                       Not Null (char,numbers)
Cancel_Button_Action_Performed

              1. exit from the system tray

Delete_Button_Action_Performed

              1.delete selected customer

Home_Button_Action_Performed,two action function will trigger

                                                                                          16 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


              1.exit from delete customer form          2.To Visible Home Screen



<Update Customer>




Pupose- to update/change current details

Field describe                   Maximum length                      Constraint
Cus ID TextField                 10                                  Not Null (char,numbers)
Name TextField                   30                                  Not Null(cahr,numbers)
Address TextArea                 100                                 Not Null(char,numbers)
Contact No TextField             10                                  Not Null(numbers)


Select_this_Customer_Button

       1.search details insted of customerId


                                                                                          17 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


Update_Customer_Button,two functions will trigger

       1.validate all text Fields     2.update/change customer

Clear_Button_Action_Performed

       1.clear all textFields

Cancel_Button_Action_Performed

       1. exit from the system tray

Home_Button_Action_Performed,two action function will trigger

       1.exit from delete customer form         2.To Visible Home Screen



<Add Order>




                                                                                           18 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


Purpose- to add order to specified customer,add orderlist



Field describe                    Maximum length                      Constraint
Cus ID comboBox                   10                                  Not Null (char,numbers)
Cus name lable                    30                                  Not Null (char,numbers)
OrderID Date combo                                                    Date
ItemCode Combo                    30                                  Not Null (char,numbers)
Qty                               10                                  Not Null (numbers)
Discount to this item textField   10                                  Not Null (numbers)
Discount Rate Text                10                                  Not Null (numbers)


Add_Customer_Button_Action_Performed

       1.To visible the add customer form

Add_Order_Button_Action_Performed

       1.Add this order to the selected customer

Ok_Button_Action_Performed

       1.minus the entered qty from qty on hand,manage stock

Add_To_List_Button_Action_Performed,two functions will trigger

       1.add selected item,item details and qty to the OrderDetails table

       2.update current stock

Remove_Item_Button_Action_Performed,three functions will trigger

       1.add qty to qty on hand

       2.remove selected row from table

       3.update stock items

Add_Order_details Button_Action _Performed

       1.send data to OrderDetails Table(DataBase)

View_Report_Button_Action_Performed


                                                                                           19 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


       1.View invoice



Give_Discount_Button_Action_Performed

       1.count discounted total from the net Total

Home_Button_Action_Performed,two action function will trigger

       1.exit from add order form       2.To Visible Home Screen

Help_Button_Action_Performed

       1.To visible help form




                                                                                          20 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




<Search Orders>




PURPOSE-To search orders made by customers one by one.

Field describe                   Maximum length                      Constraint
Customer Name Text               30                                  Not Null (char,numbers)
Order Table_Mouse Clicked

       1.show order Details in order Details Table.

Ok_Button_Action_perfprmed will triger two Functions

       1.exit from the search order for.

                                                                                          21 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


       2.visible Home Screen.

View Report_Button_Action_performed

       1.show the invoice of the customer.

<Add Items>




PURPOSE- add new Items to the stock.

Field describe               Maximum length                          Constraint
ItemCode TextField           10                                      Not Null (char,numbers)
Item Name TextField          50                                      Not Null(Char,numbers)
Exp Date TextField           10                                      Not Null(Char,numbers)
Byuing Price TextField       10                                      Not Null(numbers)
Seling price TextField       10                                      Not Null(numbers)
Add Button Action_Performed two functions will triger

       1.Add Items.

                                                                                          22 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


       2.clear all fields after adding.

Clear Button Action_performed

       1.clear all text Fields.

Cancel Button Action_performed

       1.exit from the system tray.

Home Button Action_performed

       1.Visible the Home screen.

<Search Items>




Purpose- To check Specific item’s current status on stock..

Field describe                     Maximum length                     Constraint
Item Name Text Field               30                                 Not null(Char)

                                                                                           23 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




Cancel Button Action_performed.

       1.exit from the systen tray.

Home Button Action_performed.will triger two functions,

       1.exit from the search Items form

       2.visible Home Screen.

<View Items>




Purpose- to check current stock status..

OK Button Action_performed.will triger two functions.

       1.exit from the stock form

                                                                                           24 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


       2.visible Home Screen.

Most Selling Item Buton Action_performed.

1.A report to inform what is the most selling Item.

Home Button Action_perfprmed.

       1.To visible the Home screen.

<Delete Items>




Purpose- To delete a unwanted Items that are added.

Delete Button_Action_Performed.will triger two functions,

       1.Delete the selected Item


                                                                                           25 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


       2.clear all fields.

Cancel Button Action_Performed.

       1.exit from the system tray.

Home Button Action_Performed.

       1.To visible Home Screen.

<Update Items>




Purpose-Update item information

       Eg:- item qty,exp date,Buying price,selling price.. etc.



Field describe                    Maximum length                      Constraint
Item Name Text Field              30                                  Not Null(char,Numbers)
                                                                                           26 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system


Item Type Text Field       30                                         Not Null(Char,Numbers)
Quentity Text Field        10                                         Not Null(Numbers Only)
Exp Date Text Field        10                                         Not Null(Numbers Only)
Buying Price Text Field    10                                         Not Null(Numbers Only)
Selling Price Text Field   10                                         Not Null(Numbers Only)
Item Name Combo_Box Action_Performed.

       1.show related informations in the fields.

Add Qty Button Action_performed.

       1.will add entered quentity to the current quentity.

Update Button action_performed.

       1.Update new data to the selected item.

Clear Button Action_Performed.

       1.clear all the fields

Cancel Button action_Performed.

       1.exit from the system tray.

Home Button action-Performed.

       1. visible Home Screen.

Quick Menu Button action_Performed.

       1.visible Customer Menu Pane.




                                                                                           27 | P a g e
               Copyright (C) Institute of Java & Software Engineering, permission to use
Technical Document for PAS distributors system




                                                                                          28 | P a g e
              Copyright (C) Institute of Java & Software Engineering, permission to use

								
To top