Creek Soap Bank Analysis
Release Number: Version Number: Date: Analyst: Email:
1.0 1.6 April 10, 2009 Jane Doe [e-mail]
1.
Signatory Page
This document was accepted by Sherry Yang. Name ______________________________________________ Date________________
This document was submitted by Jane Doe. Name Date 10/15/07
2.
Revision History
Company Version Date Soap Creek Bank Analysis Soap Creek Bank Analysis Soap Creek Bank Analysis Soap Creek Bank Analysis Soap Creek Bank Analysis 1.0 Filename Comments First submission 10/27/06 Use Case Model.doc
Author Jane Doe
Jane Doe
1.1
11/11/06 Use Case Model.doc
Jane Doe
1.2
11/21/06 Use Case Model.doc
Propagated changes from version 1.7 of Senior Project Proposal through this document. Added B15. Add CRUD Matrix. Added startup and shutdown use cases. Added N/A. Removed Login, Logout, Add Administrator, and Remove Administrator Use Cases. Removed Administrator as an Actor. Propagated changes from version 1.9 of my senior project proposal through this document. Added B17. Updated features verification matrix. Changed business rule B8 to use separate daily and installation download indexes.
Jane Doe
1.5
1/09/07
Soap Creek Use Case Model
Jane Doe
1.6
1/10/07
Soap Creek Use Case Model
Jane Doe
Soap Creek Bank Analysis
1.7
1/11/07
Soap Creek Use Case Model
3.
Table of Contents
1. Signatory Page.............................................................................................................................2 2. Revision History..........................................................................................................................3 3. Table of Contents........................................................................................................................4 4. Context Diagram..........................................................................................................................5 5. Use Case Catalog.........................................................................................................................6 6. Actor Catalog...............................................................................................................................6 7. Features Verification Matrix........................................................................................................7 8. Use Case Specifications...............................................................................................................8 8.1 Search by Name.....................................................................................................................8 8.2 Search by Data.....................................................................................................................11 8.3 Add Bank.............................................................................................................................14 8.4 Remove Bank.......................................................................................................................18 8.5 Download Documents..........................................................................................................21 8.6 Set Document Download Settings.......................................................................................26 8.7 Parse Data............................................................................................................................29 8.8 Set Document Parsing Settings............................................................................................32 9. CRUD Matrix.............................................................................................................................35 10. Low Fidelity UI........................................................................................................................35 10.1 Login..................................................................................................................................35 10.2 Download Settings.............................................................................................................35 10.3 Parse Settings.....................................................................................................................35 10.4 Main Screen.......................................................................................................................35 10.5 By Data Results..................................................................................................................36 10.6 By Name Results................................................................................................................36 11. Glossary...................................................................................................................................36 12. Appendix A Business Rules..................................................................................................38
4.
Context Diagram
5.
3 4 5 6 9 10 11 12
Use Case Catalog
Use Case Name
Search by Name Search by Data Add Bank Remove Bank Download Documents Set Document Download Settings Parse Data Set Document Parse Settings
Use Case ID
Description
User looks up the financial data for a bank by name User researches banks by financial data User adds a bank to the database User removes a bank from the database System downloads and saves bank documents User sets the frequency and time of the document downloads. System extracts data from downloaded documents User sets the frequency and time of document parsing
6.
Name
User Timer1 Timer2
Actor Catalog
Type
Person Software Timer Software Timer
Description
A user of the system Controls when document downloading occurs. Controls when document parsing occurs.
7.
1.1.1 1.1.2 1.2.1 1.2.2 1.2.3 1.2.4.1 1.2.4.2 1.2.4.3 1.2.4.4 1.2.4.5 1.2.4.6 1.2.4.7 1.2.4.8 1.2.4.9 1.2.4.10 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 4.1 4.2 4.3 4.4
Features Verification Matrix
Use Case ID
6 5 5 5 5 12 12 12 12 12 12 12 12 12 12 10 10 10 10 10 12 11 11 13 12 12 12 12 12 12 12 12 12 12 12 3, 4 4 3 3, 4
Feature #
Use Case Name
Remove Bank Add Bank Add Bank Add Bank Add Bank Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Download Documents Download Documents Download Documents Download Documents Download Documents Parse Data Set Document Download Settings Set Document Download Settings Set Document Parse Settings Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Parse Data Search by Name, Search by Data Search by Data Search by Name Search by Name, Search by Data
8.
8.1
Use Case Specifications
Search by Name
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 3 Search by Name Subject Area : UI Description : User looks up the financial data for a bank by name
Requirements/Feature Trace
REQ# 4.2.3 4.2.4 4.2.1 Requirements Name and / or Short Description The system shall allow the user to select data on a specific bank by name. The system shall allow the user to constrain the data range by date The system shall allow the user to constrain bank data by state
Revision History
Author Jane Doe Jane Doe 10/10/06 10/19/06 Date Created use case Removed insertion point of this use case into use case 4. Removed main course steps 4 (system constructs database query) and 5 (system queries database) Removed precondition 1 (user logged on) Comments
Jane Doe
11/21/06
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name User Administrator P P P/S Brief Description A user of the system An administrator of the system
PreConditions
# 1 Description Document parsing cannot be occurring (updating the database with new data)
Start Stimulus
User begins entering data in main screen
Use Case Main Course Steps
Number Description Adds/Alt UC Bus Rule(s)#
Name/Number 1 2 3 4 4 5 User enters bank name User enters beginning date User enters end date User enters state User requests bank data System displays bank data for date range N/A N/A N/A N/A N/A N/A B14 B4 B4 B9 N/A N/A
Exception Conditions
Exception Situations Document parsing is occurring No data found Action(s) on Exception Inform user that the search cannot be performed while document parsing is in progress. Prevent search from occurring. Upon user acknowledgement return to main screen. Inform user that no data was found matching the search conditions. Inform user and stay at main screen. Adds/Alt Use Case # N/A
N/A
PostConditions
# 1 Bank data is displayed for user Description
Candidate Objects
Class/Object Name BankData Holds the financial data enumerated in the project proposal Descriptions Possible attributes Financial data, name, address, date of data
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 1 Maximum: 60 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other:
Timing Information
# 1 At/ Between 5 Step(s) Timing Unit Second 2 N/A 10 Don't have hard data for this. Just a best guess. Minimum Average Maximum Comments
Volume Information
# 1 5 Step # Unit of Measure Byte Minimum 0 Average Depends on time spans chosen by user Maximum 2500 Comments Timespan (years (13) * quarters (4)) * (data_field (10) * num_bytes (4) + date (10))
8.2
Search by Data
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 4 Subject Area : UI Description : User researches banks by financial data
Requirements/Feature Trace
REQ# 4.2.2 4.2.4 4.2.1 Requirements Name and / or Short Description The system shall allow the user to select bank names by constraints on the data factors enumerated in Data Extraction. The system shall allow the user to constrain the data evaluated by date The system shall allow the user to constrain bank data by state
Revision History
Author Jane Doe Jane Doe Jane Doe Jane Doe 10/11/06 10/19/06 11/21/06 12/2/06 Date Created Use Case Modified use case steps, changed use case description, removed post conditions 2 and 3. Inserted start stimulus. Removed precondition 1 (user logged on) Removed main steps 6 and 7 Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name User Administrator P/S Brief Description A user of the system An administrator of the system
PreConditions
# 1 Description Document parsing cannot be occurring (updating the database with new data)
Start Stimulus
User begins entering data in main screen
Use Case Main Course Steps
Number 1 2 3 4 Description User enters financial data constraints User enters financial data matching conditions User enters state User requests matching banks N/A N/A N/A N/A Adds/Alt UC Name/Number B6 B5 B9 N/A Bus Rule(s)#
5
System returns list of banks matching financial constraints
N/A
N/A
Exception Conditions
Exception Situations Document parsing is occurring No data found Action(s) on Exception Inform user that the search cannot be performed while document parsing is in progress. Prevent search from occurring. Warn user and stay at main screen. Inform user that no data was found matching the search conditions. After user acknowledgement return to main screen. Adds/Alt Use Case # N/A
N/A
PostConditions
# 1 Description User is shown list of banks meeting data constraints
Candidate Objects
Class/Object Name None Descriptions Possible attributes
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 0 Maximum: 60 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other:
Timing Information
# 1 4 At/ Between 4 Step(s) Timing Unit Second 2 N/A 10 Don't have hard data. Just a best guess Minimum Average Maximum Comments
Volume Information
# 1 4 Step # Unit of Measure Byte Minimum 0 Average Depends on user search criteria Maximum 228,880 Comments Assume 5722 (ListOfBanks.xls) banks * 40 byte name.
8.3
Add Bank
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 5 Add Bank Subject Area : Data maintenance Description : User adds a bank to the database
Requirements/Feature Trace
REQ# 1.1.2 1.2.1 1.2.2 Requirements Name and / or Short Description The system shall allow the user to add regional banks
The system shall store the bank name. The system shall store the bank address.
Revision History
Author Jane Doe Jane Doe Jane Doe Jane Doe Jane Doe 10/11/06 10/12/06 10/19/06 10/26/06 1/10/07 Date Created use case Modified main steps to included downloading and checking the master CIK list from the SEC Removed requirement 1.1.3 and 1.1.4 added 1.2.1 and 1.2.2. Redid main course steps. Added exception condition bank name already exists Add CIK entry, changed administrator to user, removed scenario 3, will you dropdown or something so user can't enter wrong state abbrievation Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name User P/S Brief Description An user of the system
PreConditions
# 1 Description User is logged in as an administrator
Start Stimulus
User enters add bank screen
Use Case Main Course Steps
Number 1. 2. 3. 4. 5. Description User enters bank name User enters bank state User enters bank CIK User submits data System informs user bank has been added N/A N/A N/A N/A N/A Adds/Alt UC Name/Number B9 B N/A N/A Bus Rule(s)# B10, B14
Exception Conditions
Exception Situations Invalid state abbreviation Bank name already exits Action(s) on Exception Prompt user to reenter state abbreviation. Stay at add bank screen Inform user and return to add bank screen Adds/Alt Use Case # N/A N/A
PostConditions
# 1
Description Bank is added to database. Will be included in future document downloads and parsing.
Candidate Objects
Class/Object Name None Descriptions Possible attributes
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 1 Maximum: 20 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other: Year
Timing Information
# 1 At/ Between 3 Step(s) Timing Unit Second 1 N/A 5 Probably less than 5 seconds Minimum Average Maximum Comments
Volume Information
# 1 3 Step # Unit of Measure Byte 1 N/A 256 Business rule B14 Minimum Average Maximum Comments
8.4
Remove Bank
General Information
Use Case ID Number : 6 Remove Bank Subject Area : Database maintenance Description : User removes a bank from the database
Responsible Analyst : Jane Doe
Requirements/Feature Trace
REQ# 1.1.1 Requirements Name and / or Short Description The system shall allow the user to remove regional banks
Revision History
Author Jane Doe Jane Doe Jane Doe 10/12/06 10/19/06 10/26/06 Date Created use case Added requirements 1.2.1 and 1.2.2. Added timing and volume info. Added main course steps 3 and 4 Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name Administrator P/S Brief Description An Administrator of the system
PreConditions
# 1 Description None
Start Stimulus
User enters remove bank screen
Use Case Main Course Steps
Number 1. 2. 3. 4. 5. Description User requests delete User enters bank name System confirms delete User confirms delete System informs user that bank data has been deleted. N/A N/A N/A N/A N/A Adds/Alt UC Name/Number N/A B10, B14 N/A N/A N/A Bus Rule(s)#
Exception Conditions
Exception Situations Bank name Action(s) on Exception Inform user that the bank name was not found stay at remove bank screen. Adds/Alt Use Case # N/A
PostConditions
# 1 Description All bank data has been removed from the database
Candidate Objects
Class/Object Name cBankData Hold bank data Descriptions Possible attributes Financial data, name, state, CIK
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 0 Maximum: 20 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other: Year
Timing Information
# 1 At/ Between 2 3 Step(s) N/A Timing Unit Second Minimum 0 Average N/A Maximum 10 Comments How long it takes to remove all stored financial data. A couple years worth will probably take a least a couple seconds
Volume Information
# 1 2 Step # Unit of Measure Byte N/A N/A < 3000 Size data(60) * quarter (4) * year (11) + name(40) Minimum Average Maximum Comments
8.5
Download Information
Responsible Documents
General Analyst : Jane Doe
Use Case ID Number : 9 Download documents Subject Area : Data Gathering Description : System downloads and saves bank documents
Requirements/Feature Trace
REQ# 2.1 2.2 2.3 2.4 2.5 Requirements Name and / or Short Description The system shall connect to ftp.sec.gov. The system shall construct the path to the documents to download on the SEC website The system shall retrieve the Form 10K (annual financial report) for a bank The system shall retrieve the Form 10Q (quarterly financial report) for a bank The system shall save the retrieved reports in a temporary folder.
Revision History
Author Jane Doe Jane Doe Jane Doe Jane Doe 10/12/06 10/13/06 10/19/06 12/2/06 Date Created use case Added precondition 4 Added start stimulus, redid main course steps, deleted alternate courses. Removed exception condition "user terminates download" Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name Timer 1 Administrator P/S Brief Description Timer that fires to start the document downloading process An administrator of the system
PreConditions
# 1 2 3 4 Description Internet connection is available for document downloads Sufficient hard drive space is available for document storage Must be between 9:00PM and 4:00AM eastern time See B11 Data Parsing must not be occurring
Start Stimulus
Timer1 kicks off. User enters download settings screen
Use Case Main Course Steps
Number 1. 2.
Description User tells system to download documents System informs user that documents have been downloaded N/A N/A
Adds/Alt UC Name/Number N/A N/A
Bus Rule(s)#
Exception Conditions
Exception Situations 1 Internet connection broken Action(s) on Exception Terminate download, notify user Adds/Alt Use Case # N/A
PostConditions
# 1 New documents are downloaded to a folder Description
Candidate Objects
Class/Object Name DocumentData Descriptions Holds the info about the document downloaded Possible Attributes CIK, bank name, date filed, form type, document name, company name Get Document, Parse Document, Store document data OpenConnection, CloseConection.
cDocument
Perform the functions associated with the downloaded documents
cInternetConnecti on
Manage connections to the internet
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author Jane Doe Comment If timer kicks off use case, no user interaction is required. This use case occurs when the administrator starts the use case. Date 10/19/06
Frequency of Execution
Frequency: Minimum: 0 Maximum: 1 Average: 1 (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other:
Timing Information
# At/ Between Step(s) Timing Unit Minimum Average Maximum Comments
1
1, 2
N/A
N/A
N/A
N/A
N/A
Depends on number and size of documents and speed of internet connection. Insufficient data for hard numbers right now.
Volume Information
# 1 2 Step # Unit of Measure Megabyte Minimum 0 Average 70 + (40 to 50) Maximum 70 + 11444 Comments Master full index text file. All the bank reports filed that day. Could be up to 5722 (ListofBanks.xls) bank reports. Reports seem to be about 2 megabytes. Could be a total of 11 12 gigabytes although the filing periods are more likely to be spread out.
8.6
Set Document Download Settings
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 10 Set Document Download Settings Subject Area : Data gathering Description : User sets the frequency and time of the document downloads.
Requirements/Feature Trace
REQ# 2.7 2.8 Requirements Name and / or Short Description The system shall allow the administrator to set the document downloading frequency. The system shall allow the administrator to set the document downloading time.
Revision History
Author Jane Doe Jane Doe Jane Doe 10/13/06 10/19/06 12/4/06 Date Created use case Added start stimulus Removed exception condition 2 (invalid download frequency (that aren't any invalid frequencies) Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name Administrator P/S Brief Description An administrator of the system
PreConditions
# 1 Description User is logged in as an administrator
Start Stimulus
User enters download settings screen
Use Case Main Course Steps
Number 1. 2. 3. 4. Description User enters document downloading time User enters downloading frequency User submits data System informs user that downloading time and frequency have been set. N/A N/A N/A N/A Adds/Alt UC Name/Number B13 N/A N/A Bus Rule(s)# B11, B12
Exception Conditions
Exception Situations Invalid downloading time Action(s) on Exception System prompts user to enter new time, stays at download settings screen. Adds/Alt Use Case # N/A
PostConditions
# 1 2 Downloading frequency has been set Downloading time has been set Description
Candidate Objects
Class/Object Name None Descriptions Possible Attributes
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 0 Maximum: 2 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other:Year
Timing Information
# At/ Between N/A Step(s) N/A Timing Unit N/A Minimum N/A Average N/A Maximum N/A N/A Comments
Volume Information
# Step # N/A Unit of Measure N/A Minimum N/A Average N/A Maximum N/A N/A Comments
8.7
Parse Data
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 11 Parse Data Subject Area : Data extraction Description : System extracts data from downloaded documents
Requirements/Feature Trace
REQ# 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 2.6 1.2.3.1 1.2.3.2 1.2.3.3 1.2.3.4 1.2.3.5 1.2.3.6 1.2.3.7 1.2.3.8 1.2.3.9 1.2.3.10 Requirements Name and / or Short Description The system shall extract the bank size in assets from the reports The system shall extract the net income from the reports The system shall extract the shareholder's equity from the reports The system shall extract the basic earnings per share from the reports The system shall extract the book value from the reports The system shall extract the return on assets from the reports The system shall extract the return on equity from the reports The system shall extract the efficiency ratio from the reports The system shall extract the net interest margin from the reports The system shall extract the dividend payout ratio from the reports The system shall store the ftp.sec.gov file path of all analyzed documents The system shall delete the reports after mining them. The system shall store the bank size in assets The system shall store the net income The system shall store the shareholder's equity The system shall store the basic earnings per share The system shall store the book value The system shall store the return on assets The system shall store the return on equity The system shall store the efficiency ratio The system shall store the net interest margin The system shall store the dividend payout ratio
Revision History
Author Jane Doe Jane Doe Jane Doe 10/19/07 12/2/06 12/2/06 Date Created Use Case Removed use case main step # 2 (busy indicator) Removed exception condition "user stops parse" Comments
Insertion Points in other Use Cases
Use Case Name Use Case Number Step Inserted After
N/A
N/A
N/A
Actors
Actor Name P/S Brief Description
Timer 2 Administrator
A timer that determines when data parsing occurs An administrator of the system
PreConditions
# 1 2 Description Document downloading is not occurring User is not researching banks
Start Stimulus
Timer2 kicks off Administrator enters parse settings screen
Use Case Main Course Steps
Number 1 2 Description User tells system to begin to begin parsing System returns to parse settings screen N/A N/A Adds/Alt UC Name/Number N/A N/A Bus Rule(s)#
Exception Conditions
Exception Situations No Documents to be parsed Action(s) on Exception Inform user, return to parse settings screen upon user acknowledgement Adds/Alt Use Case # N/A
PostConditions
# 1 Data has been parsed and stored in database Description
Candidate Objects
Class/Object Name cDocument Handles parsing of data from document Descriptions Possible attributes GetAssests, plus fxns for other financial data, delete document? Storage member for each piece of financial data, timestamp?
cFinancialInfo
Hold financial info
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None
Issue
Date Raised
Raised By
Date Verified
Verified By
Other Comments
Author Jane Doe Comment If timer kicks off use case, no user interaction is required. This use case occurs when the administrator starts the use case. Date 10/19/06
Frequency of Execution
Frequency: Minimum: 0 Maximum: 1 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other:
Timing Information
# 1 At/ Between 2 3 N/A Step(s) Timing Unit minutes 1 60 240 Depends on number of documents to parse. Parsing should take place at night so time isn't as great an issue. Minimum Average Maximum Comments
Volume Information
# 1 Step # 23 Unit of Measure Byte 0 (no docs) 630 (number banks / days year) * 40 228880 (all banks at once) Assume 4 bytes per data field, 10 data fields, number banks is 5722, days year is 365. Number banks will likely shrink some because not all file electronically. Minimum Average Maximum Comments
8.8
Set Document Parsing Settings
General Information
Responsible Analyst : Jane Doe
Use Case ID Number : 12 Set Document Parsing Settings Subject Area : Description : User sets the frequency and time of document parsing
Requirements/Feature Trace
REQ# 2.9 Requirements Name and / or Short Description The system shall allow the administrator to set the document parsing time
Revision History
Author Jane Doe Jane Doe 10/19/06 12/4/06 Date Created use case Removed exception condition 1 (invalid parse frequency (that aren't any invalid frequencies) Comments
Insertion Points in other Use Cases
Use Case Name N/A N/A Use Case Number N/A Step Inserted After
Actors
Actor Name Administrator P/S Brief Description An administrator of the system
PreConditions
# 1 Description User is logged in as an administrator
Start Stimulus
User enters parse settings screen
Use Case Main Course Steps
Number 1 2 3 Description User enters parse time User enters parse frequency User submits settings N/A N/A N/A Adds/Alt UC Name/Number B13 B13 N/A Bus Rule(s)#
Exception Conditions
Exception Situations Action(s) on Exception Adds/Alt Use
Case # N/A N/A N/A
PostConditions
# 1 2 Parse frequency has been set Parse time has been set Description
Candidate Objects
Class/Object Name cSystemSettings Descriptions Holds parse and download settings Possible attributes Time and date for parse and download
Assumptions
# None Assumption Date Raised Raised By Date Verified Verified By
Issues
# None Issue Date Raised Raised By Date Verified Verified By
Other Comments
Author None Comment Date
Frequency of Execution
Frequency: Minimum: 0 Maximum: 2 Average: (OR)Fixed: Per: Hour: Day: Week: Month: Day: Other: Year
Timing Information
# At/ Between N/A Step(s) N/A Timing Unit N/A Minimum N/A Average N/A Maximum N/A N/A Comments
Volume Information
# Step # N/A Unit of Measure N/A Minimum N/A Average N/A Maximum N/A N/A Comments
9.
CRUD Matrix
See JaneDoeCrud Matrix.xls
10. Low Fidelity UI
10.1 Login
Consol application text menu
10.2 Download Settings
Consol application text menu
10.3 Parse Settings
Consol application text menu
10.4 Main Screen
10.5 By Data Results
10.6 By Name Results
11. Glossary
Bank size in assets The size of the bank as measured by its total assets. Basic earnings per share - E.P.S., as it is called, is a company's profit divided by its number of outstanding shares. If a company earned $2 million in one year had 2 million shares of stock outstanding, its EPS would be $1 per share. In calculating E.P.S., the company often uses a weighted average of shares outstanding over the reporting term. (http://www.forbes.com/tools/glossary/index.jhtml)
Book value - A company's book value is its total assets minus intangible assets and liabilities, such as debt. A company's book value might be more or less than its market value. (http://www.forbes.com/tools/glossary/index.jhtml) Dividend payout ratio - Percentage of earnings paid out as dividends. (http://www.forbes.com/tools/glossary/index.jhtml) Efficiency ratio A measure of how much of the banks income is being used to cover expenses. A high efficiency ratio means more income is being used to cover expenses. Net interest margin - The difference between interest income and interest expense as a percentage of assets. Form 10-K Annual report of financial information Form 10-Q Quarterly report of financial information Net income The company's total earnings, reflecting revenues adjusted for costs of doing business, depreciation, interest, taxes and other expenses. (http://www.forbes.com/tools/glossary/index.jhtml) Regional Bank For this project defined as a bank having less than 4 billion dollars in assets. Return on assets - Indicator of profitability. Determined by dividing net income for the past 12 months by total average assets. Result is shown as a percentage. R.O.A. can be decomposed into return on sales (net income/sales) multiplied by asset utilization (sales/assets). (http://www.forbes.com/tools/glossary/index.jhtml) Return on equity - indicator of profitability. Determined by dividing net income for the past 12 months by common stockholder equity (adjusted for stock splits). Result is shown as a percentage. Investors use R.O.E. as a measure of how a company is using its money. R.O.E. may be decomposed into return on assets (R.O.A.) multiplied by financial leverage (total assets/total equity). (http://www.forbes.com/tools/glossary/index.jhtml) SEC Securities and Exchange Commission. Publicly traded companies must file financial information here. Shareholder's equity This is a company's total assets minus total liabilities. A company's net worth is the same thing. (http://www.forbes.com/tools/glossary/index.jhtml)
12. Appendix A Business Rules
B1. B2. Username is selected by user. It must be between six (6) and thirty (30) characters long. It can contain a z, A Z, _ (underscore), and . (period). The password is selected by the user. It must be between six (6) and fifteen (15) characters long. It may contain a z, A Z, 0 9, or ! @ # $ % ^ & * _ or . (period). There can be 1 or more administrators. Dates are in the following format: 9/10/85, 10/30/05 (month, day, year). Bank selection matching criteria is greater than, less than, equal to, greater than or equal to, and less than or equal too for each selection item. Empty selection fields are ignored in the search. All selection criteria is related by AND (The search results must match all the entered criteria). Financial data format: bank size in assets: net income: shareholder's equity: basic earnings per share: book value: return on assets: return on equity: efficiency ratio: net interest margin: dividend payout ratio: $999,999,999 $999,999,999 $999,999,999 $9.99 $99.99 9.99% 99.99% 99.99% 9.99% 99.99%
B3. B4. B5.
B6.
numbers are allowed to expand beyond the number of places indicated. B7. B8. SEC date format: year month day (ex: 20061024) This will be used for the initial document download on setup. Master index file path formed as follows: ftp://ftp.sec.gov/edgar/full-index/year/quarter/master.idx year is 4 digit year 2006 quarter is the current fiscal quarter as determined by: 1st Quarter: January 1, March 31, 2005 2nd Quarter: April 1, 2006 June 30, 2006 3rd Quarter: July 1, 2006 September 30, 2006 4th Quarter: October 1, 2006 December 31, 2006 And prefixed by QTR QTR2
B9. B10. B11.
Bank state is entered as two letter state abbreviation (ex: Oregon => OR) Bank name or holding company is entered as is (it must be whatever the documents are filed under at the SEC). Ex: Bank of the Cascades. On the SEC website it says document downloads of more than 5 documents must occur after 9:00PM eastern time. Presumably they must end before morning, say 4:00AM eastern time. Time format: 9:45 am, 10:15 pm. Downloading frequency and parsing must be at least weekly preferably daily to prevent backlog and ensure up to date data. User can select which days of the week it occurs on. Bank name is limited to 256 characters System comes with one default administrative account. Username: admin. Password: admin. There must always be at least one administrator of the system. If only one administrator account remains then it cannot be deleted. Bank CIK is 10 digit integer number.
B12. B13.
B14. B15. B16. B17.