Analytical Documentation

Name: UCTool Sample
Version: 0.1-SNAPSHOT

Sample analysis of a bank branch system demonstrating the Use case tool.

Requirements overview

Requirement	Status	Priority	Area	Level
RQ-001 - Provide bank services	Accepted	Normal	General
RQ-100 - Withdrawal	Accepted	High	Cash

Requirements details

Requirement RQ-001 - Provide bank services

Status: Accepted

Priority: Normal

Area: General

Type: Functional

Level: Solution target

Origin: Workshop 2011-03-18

References in use cases: OVR-010 - Use services of bank's branch

Requirement RQ-100 - Withdrawal

Status: Accepted

Priority: High

Area: Cash

Type: Functional

Level: Middle

Cash teller withdraws cash for the client.

References in use cases: CAS-100 - Withdraw cash in local currency

Actors overview

Actors details

Actor Cash teller

Extends actors:

Teller

Goals:

CAS-100 - Withdraw cash in local currency
CAS-200 - Deposit cash in local currency

Inherited actors:

Teller

Inherited goals:

SYS-100 - Identify account
SYS-110 - Identify client

Actor Non-cash teller

Extends actors:

Teller

Goals:

NCA-100 - Transfer funds in local currency
NCA-200 - Perform direct debit in local currency

Inherited actors:

Teller

Inherited goals:

SYS-100 - Identify account
SYS-110 - Identify client

Actor Teller

Extended by actors:

Cash teller
Non-cash teller

Goals:

SYS-100 - Identify account
SYS-110 - Identify client

Actor System

Goals:

FEE-100 - Calculate fee

Actor Client

Goals:

OVR-010 - Use services of bank's branch
OVR-100 - Use cash services of bank's branch
OVR-110 - Use non-cash services of bank's branch

Use Cases overview

Primary actor	Goal	Level
Client	OVR-010 - Use services of bank's branch
Client	OVR-100 - Use cash services of bank's branch
Client	OVR-110 - Use non-cash services of bank's branch
Cash teller	CAS-100 - Withdraw cash in local currency
Cash teller	CAS-200 - Deposit cash in local currency
Non-cash teller	NCA-100 - Transfer funds in local currency
Non-cash teller	NCA-200 - Perform direct debit in local currency
Teller	SYS-100 - Identify account
Teller	SYS-110 - Identify client
System	FEE-100 - Calculate fee

Use cases details

Use case OVR-010 - Use services of bank's branch

Scope: New Branch System

Type: Organization Visibility: White-box Level: High summary

Primary actor: Client

Main success scenario:

1.	Client comes to a branch.

2.	Client approaches a counter and uses services relevant to the counter ( RQ-001 - Provide bank services ): On cash counter uses cash services (OVR-100 - Use cash services of bank's branch) . On non-cash counter uses non-cash services (OVR-110 - Use non-cash services of bank's branch) .

Use case OVR-100 - Use cash services of bank's branch

Scope: New Branch System

Type: Organization Visibility: White-box Level: Summary

Primary actor: Client

Main success scenario:

1.	Client asks the cash teller to perform cash services: Withdraw cash in local currency (CAS-100 - Withdraw cash in local currency) Deposit cash in local currency (CAS-200 - Deposit cash in local currency)

References: OVR-010 - Use services of bank's branch

Use case OVR-110 - Use non-cash services of bank's branch

Scope: New Branch System

Type: Organization Visibility: White-box Level: Summary

Primary actor: Client

Main success scenario:

1.	Client asks the cash teller to perform non-cash services: Transfer funds in local currency (NCA-100 - Transfer funds in local currency) Perform direct debit in local currency (NCA-200 - Perform direct debit in local currency)

References: OVR-010 - Use services of bank's branch

Use case CAS-100 - Withdraw cash in local currency

Scope: New Branch System

Type: System Visibility: Black-box Level: User goal

Primary actor: Cash teller

Description:
Based on requirement (RQ-100 - Withdrawal) .

Main success scenario:

1.	User identifies account (SYS-100 - Identify account) .

2.	User identifies client (SYS-110 - Identify client) based on the account number.

3.	User verifies client's signature.

4.	User enters amount.

5.	System calculates fee (FEE-100 - Calculate fee) and total amount.

6.	User submits the transaction.

7.	System prints withdrawal receipt (Withdrawal receipt) using printing template (Withdrawal receipt - receipts/withdrawal-receipt-template-01.gif) .

Extensions:

4a.	User decides to enter cash denomination:

4a1.	User enters cash denomination.

References: OVR-100 - Use cash services of bank's branch

Use case CAS-200 - Deposit cash in local currency

Scope: New Branch System

Type: System Visibility: Black-box Level: User goal

Primary actor: Cash teller

Main success scenario:

1.	User identifies account (SYS-100 - Identify account) .

2.	User enters amount.

3.	System calculates fee (FEE-100 - Calculate fee) and amount to collect.

4.	User submits the transaction.

Extensions:

1a.	User decides to identify client:

1a1.	User also identifies client (SYS-110 - Identify client) based on the account number.

2a.	User decides to enter cash denomination:

2a1.	User enters cash denomination.

4a.	Amount to collect is above 5000 and client was not identified:

4a1.	System displays error message and returns to step 1 .

References: OVR-100 - Use cash services of bank's branch

Use case NCA-100 - Transfer funds in local currency

Scope: New Branch System

Type: System Visibility: Black-box Level: User goal

Primary actor: Non-cash teller

Stakeholders and interests:

Client: Credit the amount to credit account.

Bank's retail department: Charge the fee.

Bank's audit department: Have all successful transactions posted into transaction log.

Bank's audit department: Have all failed transactions posted into audit log.

Preconditions:

User is logged in.
Client is present at the branch office.

Minimal guarantees:

Transfer failure and its reason logged in audit log.
Error message displayed to user.
No changes made to accounts.

Success guarantees:

Amount and fee debited from the debit account.
Amount credited to the credit account.
Fee credited to proper general ledger account.
Transfer logged in transaction log.

Trigger: Client asks to transfer funds.

Main success scenario:

1.	User selects transfer type (Enumeration Transfer type) .

2.	User identifies debit account (SYS-100 - Identify account) limiting the bank code to own bank.

3.	User identifies credit account (SYS-100 - Identify account) .

4.	User enters amount and effective date.

5.	System calculates fee (FEE-100 - Calculate fee) .

6.	User submits the transaction.

Extensions:

1a.	Transfer type is Express and current time is past cut-off time for express transfers:

1a1.	System displays error message and does not proceed.

2a.	User decides to verify signature:

2a1.	User verifies client's signature for the debit account.

3a.	Debit and credit accounts are the same:

3a1.	System displays error message and lets the user identify other accounts.

6a.	Amount is above 5000 and client's signature was not verified:

6a1.	System displays error message and returns to step 2 .

6b.	Effective date is in past or more than one year in future:

6b1.	System displays error message and returns to step 4 .

References: OVR-110 - Use non-cash services of bank's branch

Use case NCA-200 - Perform direct debit in local currency

Scope: New Branch System

Type: System Visibility: Black-box Level: User goal

Primary actor: Non-cash teller

Main success scenario:

1.	User identifies credit account (SYS-100 - Identify account) limiting the bank code to own bank.

2.	User identifies debit account (SYS-100 - Identify account) .

3.	User enters amount and effective date.

4.	System calculates fee (FEE-100 - Calculate fee) .

5.	User submits the transaction.

Extensions:

2a.	User decides to verify signature:

2a1.	User verifies client's signature for the debit account.

2b.	Debit and credit accounts are the same:

2b1.	System displays error message and lets the user identify other accounts.

5a.	Effective date is in past or more than one year in future:

5a1.	System displays error message and returns to step 3 .

References: OVR-110 - Use non-cash services of bank's branch

Use case SYS-100 - Identify account

Scope: New Branch System

Type: System Visibility: Black-box Level: Subfunction

Primary actor: Teller

Main success scenario:

1.	User enters account number (Account number) .

2.	System validates account number.

3.	User searches for the account.

4.	System retrieves account details (Account details) by account number.

Extensions:

4a.	Not own account (bank code of the account number has Own bank flag unset):

4a1.	System does not retrieve account details.

4b.	Account not found: System displays error message.

References: CAS-100 - Withdraw cash in local currency, CAS-200 - Deposit cash in local currency, NCA-100 - Transfer funds in local currency, NCA-200 - Perform direct debit in local currency

Use case SYS-110 - Identify client

Scope: New Branch System

Type: System Visibility: Black-box Level: Subfunction

Primary actor: Teller

Main success scenario:

1.	User enters personal id number (Personal id number) .

2.	System validates personal id number.

3.	System retrieves client details (Client details) by the personal id number.

4.	User amends/enters the client details (Client details) manually as necessary.

5.	System validates the document number in Lost documents register.

Extensions:

1a.	An account number was passed-in:

1a1.	System retrieves primary account holder details by the account number, pre-fills them as the client details and continues by step 4 .

1b.	Client does not present personal id number:

1b1.	System continues by step 4 .

3a.	Personal id number not found:

3a1.	System displays error message and continues by step 4 .

References: CAS-100 - Withdraw cash in local currency, CAS-200 - Deposit cash in local currency

Use case FEE-100 - Calculate fee

Scope: New Branch System

Type: System Visibility: Black-box Level: Subfunction

Primary actor: System

Main success scenario:

1.	System calls fee engine (operation calculateFee) passing in input data (Input to calculateFee) and retrieving output data (Output from calculateFee) .

2.	System returns the output data to the caller.

References: CAS-100 - Withdraw cash in local currency, CAS-200 - Deposit cash in local currency, NCA-100 - Transfer funds in local currency, NCA-200 - Perform direct debit in local currency

Data structures overview

Data structure	Code	Category
Enumeration Transaction type	TransactionType
Enumeration Transfer type	TransferType
Code table	CodeTable
Code table Bank code	BankCode
Code table Country	Country
Code table Currency	Currency
Code table Gender	Gender
Code table Document type	DocumentType
Withdrawal receipt	WithdrawalReceipt
Account number	AccountNumber
Account details	AccountDetails
Personal id number	PersonalId
Client details	ClientDetails
Personal data	PersonalData
Document identification	DocumentIdentification
Address	Address
Input to calculateFee	calculateFee_in
Output from calculateFee	calculateFee_out

Data structures details

Data structure Enumeration Transaction type

Code: TransactionType

Description:

Transaction types are:

Withdraw cash in local currency.
Deposit cash in local currency.
Transfer funds in local currency.
Perform direct debit in local currency.

References in data structures: Input to calculateFee

Data structure Enumeration Transfer type

Code: TransferType

Description:

Transfer types are:

Normal: performed over-night.
Express: performed on the day of entry.

References in use cases: NCA-100 - Transfer funds in local currency

Data structure Code table

Code: CodeTable

Description:

A base entity for all code tables.

Attributes:

Name	Code	Status	Type
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

References in data structures: Code table Bank code, Code table Country, Code table Currency, Code table Gender, Code table Document type, Account number, Withdrawal receipt, Input to calculateFee, Output from calculateFee, Document identification, Address, Client details, Account details, Personal data

Data structure Code table Bank code

Code: BankCode

Description:

Identifies a domestic bank. Each bank has its own bank code assigned by the national central bank.

Attributes:

Name	Code	Status	Type	Description
Code	code	M	Integer [4]	A four-digit code of the bank.
Own bank	ownBank	M	Boolean	Flag indicating the bank operating the teller system. Exactly one bank code must have the flag set.
Common attributes			Code table

References in data structures: Account number, Withdrawal receipt, Input to calculateFee, Output from calculateFee

Data structure expansion:

Name	Code	Status	Type	Description
Code	code	M	Integer [4]	A four-digit code of the bank.
Own bank	ownBank	M	Boolean	Flag indicating the bank operating the teller system. Exactly one bank code must have the flag set.
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

Data structure Code table Country

Code: Country

Attributes:

Name	Code	Status	Type	Description
Code	code	M	String [2]	The ISO standard country code.
Common attributes			Code table

References in data structures: Document identification, Address, Client details

Data structure expansion:

Name	Code	Status	Type	Description
Code	code	M	String [2]	The ISO standard country code.
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

Data structure Code table Currency

Code: Currency

Attributes:

Name	Code	Status	Type	Description
Code	code	M	String [3]	The ISO standard currency code.
Common attributes			Code table

References in data structures: Account details

Data structure expansion:

Name	Code	Status	Type	Description
Code	code	M	String [3]	The ISO standard currency code.
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

Data structure Code table Gender

Code: Gender

Attributes:

Name	Code	Status	Type	Description
Code	code	M	String [1]
Common attributes			Code table

References in data structures: Personal data, Client details

Data structure expansion:

Name	Code	Status	Type
Code	code	M	String [1]
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

Data structure Code table Document type

Code: DocumentType

Description:

Type of personal document, like passport, id card, etc.

Attributes:

Name	Code	Status	Type	Description
Code	code	M	String []
Common attributes			Code table

References in data structures: Document identification, Client details

Data structure expansion:

Name	Code	Status	Type
Code	code	M	String []
Label	label	M	String [1024]
Valid from		M	Date
Valid until		O	Date

Data structure Withdrawal receipt

Code: WithdrawalReceipt

Description:

Data printed on withdrawal receipt.
Conforms to printing template (Withdrawal receipt - receipts/withdrawal-receipt-template-01.gif) .

Attributes:

Name	Type	Description
Account number	Account number	Client account number, debited for withdrawal amount and fee.
Name	String []	Name of the primary account holder.
Amount withdrawn	Decimal	Amount withdrawn by client.
Date and time	Timestamp	Current system date and time

References in use cases: CAS-100 - Withdraw cash in local currency

Data structure Account number

Code: AccountNumber

Description:

Structure of a domestic account number.

Attributes:

Name	Code	Status	Type	Description
Prefix	prefix	O	Integer [6]	Account number prefix.
Number	number	M	Integer [10]	The account number itself.
Bank code	bankCode	M	Code table Bank code	Code of the bank keeping the account.

References in data structures: Withdrawal receipt, Input to calculateFee, Output from calculateFee

References in use cases: SYS-100 - Identify account

Data structure Account details

Code: AccountDetails

Attributes:

Name	Type	Description
Currency	Code table Currency
Name	String []	Name of the primary account holder.
Available balance	Decimal

References in use cases: SYS-100 - Identify account

Data structure Personal id number

Code: PersonalId

Attributes:

Name	Code	Status	Type	Description
Number		M	Integer [10]

References in use cases: SYS-110 - Identify client

Data structure Client details

Code: ClientDetails

Attributes:

Name	Code	Status	Type	Description
Personal data			Personal data
Document identification			Document identification
Address			Address

References in use cases: SYS-110 - Identify client

Data structure expansion:

Name	Status	Type
Date of birth	M	Date
First names	M	String [50]
Last name	M	String [50]
Gender	M	Code table Gender
Type	M	Code table Document type
Number	M	String [50]
Country of issue	M	Code table Country
Valid until	M	Date
Street	M	String []
City	M	String []
ZIP	M	String []
Country	M	Code table Country

Data structure Personal data

Code: PersonalData

Attributes:

Name	Status	Type
Date of birth	M	Date
First names	M	String [50]
Last name	M	String [50]
Gender	M	Code table Gender

References in data structures: Client details

Data structure Document identification

Code: DocumentIdentification

Attributes:

Name	Status	Type
Type	M	Code table Document type
Number	M	String [50]
Country of issue	M	Code table Country
Valid until	M	Date

References in data structures: Client details

Data structure Address

Code: Address

Attributes:

Name	Status	Type
Street	M	String []
City	M	String []
ZIP	M	String []
Country	M	Code table Country

References in data structures: Client details

Data structure Input to calculateFee

Code: calculateFee_in

Attributes:

Name	Status	Type	Description
Transaction type	M	Enumeration Transaction type
Amount	O	Decimal	Transaction amount equivalent in local currency, if relevant.
Account number	O	Account number	Account number of the transaction, if relevant.

References in use cases: FEE-100 - Calculate fee

Data structure Output from calculateFee

Code: calculateFee_out

Attributes:

Name	Status	Type	Description
Fee	M	Decimal	Fee in local currency.
Fee description	M	String [1024]
Revenue account for fee	M	Account number

References in use cases: FEE-100 - Calculate fee

Attachments overview

Receipt printing templates

Withdrawal receipt - receipts/withdrawal-receipt-template-01.gif

Glossary

Term	Abbreviation	Description

Created in uctool.sf.net.