DOCUMENT HISTORY AND INFORMATIONHis

DOCUMENT HISTORY AND INFORMATION

History of Amendments:
Date Version Modified Section Summary of Change Author
23/06/09 0.1 ALL Initial Draft John Jacobi




Distributed for Review
This document has been distributed for the following to review:
Name Title & Company Issue Date Revision

Approvals
This document requires the following approvals:
Name Signature Title Issue Date






Associated Documents
This document is associated with the following other documents:
Name Title and Originator’s Reference Source Issue Date Version




Table of contents


1 Introduction 5
2 Purpose 5
3 Scope 5
4 Definitions, Acronyms and Abbreviations 5
5 Overview 5
5.1 Use case diagram 5
5.2 Entity relationship diagram 6
6 Functionality Requirements 7
6.1 Logon & Logout 7
6.2 Organisations 7
6.2.1 List Organisations 7
6.2.2 Add Organisation 8
6.2.3 Amend Organisation 12
6.2.4 Mark In-active Organisation 14
6.2.5 Supporting Materials Maintenance 14
List Supporting Materials 14
Add Supporting Materials 15
Amend Supporting Materials 15
Mark In-active a Supporting Materials 15
6.2.6 Directorate Maintenance 15
List Directorates 16
Add Directorate 16
Amend Directorate 17
Mark In-active a Directorate 17
6.2.7 Department Maintenance 17
List Departments 17
Add Department 18
Amend Department 18
Mark In-active a Department 18
6.2.8 Team Maintenance 18
List Teams 19
Add Team 20
Amend Team 20
Mark In-active a Team 20
6.3 Services 20
6.3.1 List Service 20
6.3.2 Add Service 22
6.3.3 Amend Service 26
6.3.4 Mark In-active Service 28
6.3.5 Programme 28
List Programmes 28
Add Programme 28
Amend Programme 29
Mark In-active Programme 29
6.4 Geography 29
6.4.1 Trust Region Maintenance 29
List Trust Regions 29
Add Trust Region 30
Amend Trust Region 30
Mark In-active Trust Region 30
6.4.2 Trust District Maintenance 31
List Trust Districts 31
Add Trust District 31
Amend Trust District 31
Mark In-active Trust District 31
6.4.3 Government Office Region 32
List Government Office Region 32
View Government Office Region 32
6.5 Premises 32
6.5.1 List Premises 32
6.5.2 Add Premise 33
6.5.3 Amend Premise 38
6.5.4 Mark In-active Premise 38
6.5.5 Facility Maintenance 39
6.5.6 Volunteering Opportunity 40
6.5.7 Minor Work Projects 41
6.5.8 Services 43
6.6 Contacts 44
6.6.1 List Contacts 44
6.6.2 Add Contacts 44
6.6.3 Edit Contacts 45
6.7 Address lookup 45
6.8 Type of Business lookup 46
7 Non-functional requirements 47
7.1 Performance 47
7.2 Scalability 48
7.3 Security 48
7.4 Portability 48
7.5 Audit 48
7.6 Error handling 48
7.7 Infrastructure 49
7.8 Look and feel 49
7.9 Legal 49
7.10 Training 49
7.11 User Documentation & Help Screen Requirements 49
7.12 Support & Supportability 49
7.13 Reliability 50
7.14 Design Constraints 50
7.15 Purchased Components 50
7.16 Interfaces 50
7.17 Test 50
7.18 Data 50



1 Introduction
AB currently does not have a central repository for the services that they (and associated) organisations provide. This system requirements specification is part of the project to deliver a central repository called the Services Directory.
2 Purpose
This document details the functional (within Use Case documents) requirements and non-functional requirements for the Services Directory.

NB In early versions of this document many of the requirements are stated as , this means To Be Detailed>. At the point of writing the version then this requirement needs further discussion /investigation or analysis before it can be documented.
3 Scope
The scope of this document is for the Services Directory, this will include any interfaces that are required.

4 Definitions, Acronyms and Abbreviations


5 Overview
5.1 Use case diagram
The following use cases are required to be to be included in the Service Directory


UC Name Description
UC001 Logon & Logout Allowing a user to logon to the system
UC002 Maintain Organisations Maintain the data within the Organisation area of the system
UC003 Maintain Services Maintain the data for Services
UC004 Maintain Programmes Maintain the data for Programme
UC005 Maintain Premises
Maintain the data for premises, facilities and persons
UC006 Maintain Geographic Data Maintain the data within the Geography area of the system

5.2 Entity relationship diagram

# Entity Description
1 Organisation List all organizations that involved with AB services
2 Directorate A unit (which for AB will have a Chief Officer (C.O.) (e.g. Finance, W&I)))
3 Department A unit run by a direct report of a C.O. (e.g. Health & Well Being, Financial)
4 Team A unit that reports to a Department Head (e.g. Payroll, Equality & Diversity)
5 Contact Storing all contacts in the system
6 Service List all services
7 TrustRegion An AB-created geographical area covering one or more County and broken down into Trust Districts.
8 TrustDistrict An AB-created area which is part of a AB Trust Region.
9 Country List all Nation Countries in the system
10 County List all County in the system
11 Town List all Towns in the system
12 Address List all addresses used in the system
13 User List all User of the system
14 ReferenceData List all reference data used in the system
15 SupportingMaterial Supporting materials for Organizations
16 Programme
17 Premise
18 GovOfficeRegion

6 Functionality Requirements
6.1 Logon & Logout
User would enter User name and Password to login the system.

If user forgets password, he/she can click on ‘Forgot Password’ link on the Logon page. The screen will be displayed allowing user to input Username and Email to retrieve password. If Username and Email are not fit, error message will display ‘Username and Email do not match’. Otherwise, system will send password to the email input.

Menu
Four first items on the left menu will be in scope of Phase 1:
- Organisation
- In “Services” module, there are two functions:
• Programme Maintenance
• Service Maintenance
- In “Geography” module, there are four functions:
• Trust Regions/Trust Districts Maintenances
• Government Office Region – List and View
- Premises
6.2 Organisations
6.2.1 List Organisations
By clicking on ‘Organisations’ from the menu, ‘Organisation List’ screen is displayed showing all active Organisations by default. The list is paging with 15 records showing in one page.


If user clicks on ‘Include In-active’ checkbox, all of active and in-active Organisations will be displayed in the list.

User can filter Organisations by selecting ‘All’ or ‘0-9’ or ‘ABCDE’ or ‘FGHIK’, etc. in a row above the list. -> All Organisations that begin with the selected letter will be shown.

User can sort Organisations by clicking on column name.

If user selects an Inactive Organisation in the list to view, the system will display message “Do you want to make this Organization active?” with 2 buttons: OK and Cancel

• If clicking on ‘OK’ button, ‘Organisation Details’ screen is opened and system will automatically change status of Organisation from Inactive to Active
• If clicking on ‘Cancel’ button, it keeps ‘Organisation List’ screen showing and status of selected Organisation is still inactive.

NOTE: Above listing, filtering, sorting and marking an in-active record to active behaviors are standard features in a list screen in the whole system.
6.2.2 Add Organisation
If user clicks on ‘Create’ button on the ‘Organisation List’ screen, ‘Organisation Details’ screen is displayed including two tabs: Details 1 and Details 2 to allow user to enter Organisation fields for new one.

- Below is illustration of Details 1 tab:



By default, all of fields should be blank, all check boxes should be un-ticked.

There are some rules on this screen:
• Mandatory fields
o Organisation Name
o Organisation Short Description
o Type of Business
o Address Line 1
o Postcode
o Phone Number

• Unique fields
o Organisation Name
• Lead Contact lookup will display all contacts in the system in a pop-up window. Refer to Contacts for more details.

• Postcode lookup will display all addresses retrieved from database in a pop-up window. Refer to Address for more details

• Type of Business lookup will display all SIC Code data that already listed in reference data. Refer to Type of Business for more details;

After selecting a Type of Business from pop-up window, related SIC Code will be populated to the text box under Type of Business automatically.

• Nation/Country will list all of Country get from reference data.

• If user manually enters Postcode value, the system will check whether it is existing in the database or not. If not, prompt message should be displayed as 'Address Details cannot be confirmed - Do you wish to enter Unconfirmed Address Data (Y/N?)'. If user clicks No (Cancel), postcode should be focused again and the previous value should be cleared out.

- ‘Details 2’ tab should be as below:



All of list boxes in this tab get from reference data.

If user clicks on ‘Expression of Interest’ checkbox in ‘Details 1’ tab, ‘Detail 3’ tab is displayed and navigated automatically.


In this screen, it will list all of active Programmes and Services in the system to link.

To save Organisation record, user should click on ‘Save’ button on the screen. The system will validate mandatory fields are already input or not and check if Organisation Name is existed in the system.

If some mandatory fields are not input, error message(s) should be displayed and adding is aborted.


If the validation is passed, Organisation record will be saved and Organisation details screen is kept to allow user to add Directorates for this Organisation. Message to inform the successful saving should be displayed as well.



- If user clicks on ‘Back’ button, it will come back to the Organisation List screen.

NOTE: It is a standard behavior in the whole system. After user clicks on ‘Back’ button in a Details screen, the related List screen should be shown.

6.2.3 Amend Organisation
By selectin

Kết quả (Việt) 2:

TÀI LIỆU LỊCH SỬ VÀ THÔNG TIN Lịch sử sửa đổi: Ngày Phiên bản thay đổi mục Tóm tắt của Change Tác giả 23/06/09 0,1 ALL Dự thảo ban đầu John Jacobi phân phối cho xét tài liệu này đã được phân phối cho những việc sau để xem xét lại: Tên đề & Company Ngày phát hành Revision Approvals này tài liệu đòi hỏi phải được sự chấp thuận sau đây: Tên Chữ ký tự Tiêu đề Associated Tài liệu Tài liệu này được kết hợp với các tài liệu khác như sau: Tên Tiêu đề và Originator của Reference Nguồn gian phát hành bản Mục lục 1 Giới thiệu 5 2 Mục đích 5 3 Phạm vi 5 4 Các định nghĩa, từ viết tắt và từ viết tắt 5 5 5 Tổng quan 5.1 Sử dụng trường hợp sơ đồ 5 5.2 Entity relationship diagram 6 6 Yêu cầu chức năng 7 6.1 Logon & Logout 7 6.2 Tổ chức 7 6.2.1 Danh sách các tổ chức 7 6.2.2 Thêm Tổ chức 8 6.2.3 Sửa đổi Tổ chức 12 6.2.4 Đánh In- Tổ chức hoạt động 14 6.2.5 Hỗ trợ bảo dưỡng Vật liệu 14 Danh sách hỗ trợ liệu 14 Add Hỗ trợ liệu 15 sửa đổi Hỗ trợ liệu 15 Mark In-hoạt động một trợ Vật liệu 15 6.2.6 cục Bảo trì 15 Danh sách Ban giám đốc 16 Thêm cục 16 Sửa đổi cục 17 Mark In-hoạt động một Ban giám đốc 17 6.2.7 Bộ Maintenance 17 Danh sách 17 Sở Thêm Bộ 18 Sửa đổi Bộ 18 Mark In-hoạt động một cục 18 6.2.8 Đội Bảo trì 18 Danh sách Đội tuyển 19 Thêm Đội 20 Sửa đổi đội 20 Mark In-hoạt động một đội 20 6.3 Các dịch vụ 20 6.3 0,1 Dịch vụ Danh sách 20 6.3.2 Thêm dịch vụ 22 6.3.3 Sửa đổi dịch vụ 26 6.3.4 Đánh In-hoạt động dịch vụ 28 6.3.5 Chương trình 28 Danh sách các Chương trình 28 Thêm Chương trình 28 sửa đổi Chương trình 29 Mark In-hoạt động của Chương trình 29 6.4 Địa lý 29 6.4 0,1 Region ủy thác bảo trì 29 Danh sách ủy thác Regions 29 Thêm Region ủy thác 30 Sửa đổi Region ủy thác 30 Mark In-Region hoạt động ủy thác 30 Maintenance 31 6.4.2 Tín Quận huyện Danh sách ủy thác 31 Thêm Huyện ủy thác 31 Sửa đổi Huyện ủy thác 31 Mark In-active Quận ủy thác 31 6.4.3 Văn phòng Chính phủ khu vực 32 Khu vực Văn phòng Chính phủ Danh sách 32 Xem Văn phòng Chính phủ khu vực 32 6.5 Mặt bằng 32 6.5.1 Danh sách Premises 32 6.5.2 Add Premise 33 6.5.3 Sửa đổi Premise 38 6.5.4 Đánh In-Premise hoạt động 38 6.5. 5 Cơ sở bảo dưỡng 39 6.5.6 Tình nguyện Cơ hội 40 dự án 6.5.7 nhỏ làm việc 41 6.5.8 Các dịch vụ 43 6.6 Liên hệ 44 6.6.1 Danh sách Liên hệ 44 6.6.2 Thêm hệ 44 6.6.3 Chỉnh sửa hệ 45 6.7 Địa chỉ tra cứu 45 6.8 Loại tra cứu doanh nghiệp 46 yêu cầu 7 phi chức năng 47 7.1 Hiệu suất 47 7.2 Khả năng mở rộng 48 7.3 Bảo mật 48 7.4 Khả năng di chuyển 48 7.5 Kiểm toán 48 7.6 Lỗi xử lý 48 7.7 Cơ sở hạ tầng 49 7.8 Nhìn và cảm nhận 49 7.9 Pháp 49 7.10 Đào tạo 49 7.11 tài liệu & Help Screen Yêu cầu 49 7.12 Hỗ trợ & supportability 49 7.13 Độ bền 50 7.14 Hạn chế thiết kế 50 7.15 Mua Components 50 7.16 Giao diện 50 7.17 Kiểm tra 50 7.18 Số liệu 50 1 Giới thiệu AB hiện không có một kho lưu trữ trung ương cho các dịch vụ mà họ (và liên quan) tổ chức cung cấp. Đặc tả yêu cầu hệ thống này là một phần của dự án để cung cấp một kho lưu trữ trung ương gọi là Directory Services. 2 Mục đích Tài liệu này mô tả chi tiết chức năng (trong tài liệu Use Case) yêu cầu và yêu cầu phi chức năng cho các dịch vụ Directory. NB Trong phiên bản đầu của tài liệu này nhiều người trong số các yêu cầu được quy định như



































































































































, this means To Be Detailed>. At the point of writing the version then this requirement needs further discussion /investigation or analysis before it can be documented.
3 Scope
The scope of this document is for the Services Directory, this will include any interfaces that are required.

4 Definitions, Acronyms and Abbreviations


5 Overview
5.1 Use case diagram
The following use cases are required to be to be included in the Service Directory


UC Name Description
UC001 Logon & Logout Allowing a user to logon to the system
UC002 Maintain Organisations Maintain the data within the Organisation area of the system
UC003 Maintain Services Maintain the data for Services
UC004 Maintain Programmes Maintain the data for Programme
UC005 Maintain Premises
Maintain the data for premises, facilities and persons
UC006 Maintain Geographic Data Maintain the data within the Geography area of the system

5.2 Entity relationship diagram

# Entity Description
1 Organisation List all organizations that involved with AB services
2 Directorate A unit (which for AB will have a Chief Officer (C.O.) (e.g. Finance, W&I)))
3 Department A unit run by a direct report of a C.O. (e.g. Health & Well Being, Financial)
4 Team A unit that reports to a Department Head (e.g. Payroll, Equality & Diversity)
5 Contact Storing all contacts in the system
6 Service List all services
7 TrustRegion An AB-created geographical area covering one or more County and broken down into Trust Districts.
8 TrustDistrict An AB-created area which is part of a AB Trust Region.
9 Country List all Nation Countries in the system
10 County List all County in the system
11 Town List all Towns in the system
12 Address List all addresses used in the system
13 User List all User of the system
14 ReferenceData List all reference data used in the system
15 SupportingMaterial Supporting materials for Organizations
16 Programme
17 Premise
18 GovOfficeRegion

6 Functionality Requirements
6.1 Logon & Logout
User would enter User name and Password to login the system.

If user forgets password, he/she can click on ‘Forgot Password’ link on the Logon page. The screen will be displayed allowing user to input Username and Email to retrieve password. If Username and Email are not fit, error message will display ‘Username and Email do not match’. Otherwise, system will send password to the email input.

Menu
Four first items on the left menu will be in scope of Phase 1:
- Organisation
- In “Services” module, there are two functions:
• Programme Maintenance
• Service Maintenance
- In “Geography” module, there are four functions:
• Trust Regions/Trust Districts Maintenances
• Government Office Region – List and View
- Premises
6.2 Organisations
6.2.1 List Organisations
By clicking on ‘Organisations’ from the menu, ‘Organisation List’ screen is displayed showing all active Organisations by default. The list is paging with 15 records showing in one page.


If user clicks on ‘Include In-active’ checkbox, all of active and in-active Organisations will be displayed in the list.

User can filter Organisations by selecting ‘All’ or ‘0-9’ or ‘ABCDE’ or ‘FGHIK’, etc. in a row above the list. -> All Organisations that begin with the selected letter will be shown.

User can sort Organisations by clicking on column name.

If user selects an Inactive Organisation in the list to view, the system will display message “Do you want to make this Organization active?” with 2 buttons: OK and Cancel

• If clicking on ‘OK’ button, ‘Organisation Details’ screen is opened and system will automatically change status of Organisation from Inactive to Active
• If clicking on ‘Cancel’ button, it keeps ‘Organisation List’ screen showing and status of selected Organisation is still inactive.

NOTE: Above listing, filtering, sorting and marking an in-active record to active behaviors are standard features in a list screen in the whole system.
6.2.2 Add Organisation
If user clicks on ‘Create’ button on the ‘Organisation List’ screen, ‘Organisation Details’ screen is displayed including two tabs: Details 1 and Details 2 to allow user to enter Organisation fields for new one.

- Below is illustration of Details 1 tab:



By default, all of fields should be blank, all check boxes should be un-ticked.

There are some rules on this screen:
• Mandatory fields
o Organisation Name
o Organisation Short Description
o Type of Business
o Address Line 1
o Postcode
o Phone Number

• Unique fields
o Organisation Name
• Lead Contact lookup will display all contacts in the system in a pop-up window. Refer to Contacts for more details.

• Postcode lookup will display all addresses retrieved from database in a pop-up window. Refer to Address for more details

• Type of Business lookup will display all SIC Code data that already listed in reference data. Refer to Type of Business for more details;

After selecting a Type of Business from pop-up window, related SIC Code will be populated to the text box under Type of Business automatically.

• Nation/Country will list all of Country get from reference data.

• If user manually enters Postcode value, the system will check whether it is existing in the database or not. If not, prompt message should be displayed as 'Address Details cannot be confirmed - Do you wish to enter Unconfirmed Address Data (Y/N?)'. If user clicks No (Cancel), postcode should be focused again and the previous value should be cleared out.

- ‘Details 2’ tab should be as below:



All of list boxes in this tab get from reference data.

If user clicks on ‘Expression of Interest’ checkbox in ‘Details 1’ tab, ‘Detail 3’ tab is displayed and navigated automatically.


In this screen, it will list all of active Programmes and Services in the system to link.

To save Organisation record, user should click on ‘Save’ button on the screen. The system will validate mandatory fields are already input or not and check if Organisation Name is existed in the system.

If some mandatory fields are not input, error message(s) should be displayed and adding is aborted.


If the validation is passed, Organisation record will be saved and Organisation details screen is kept to allow user to add Directorates for this Organisation. Message to inform the successful saving should be displayed as well.



- If user clicks on ‘Back’ button, it will come back to the Organisation List screen.

NOTE: It is a standard behavior in the whole system. After user clicks on ‘Back’ button in a Details screen, the related List screen should be shown.

6.2.3 Amend Organisation
By selectin