ric v2.0 development workshop ric 2.0 requirements overview david michael 101129 v0.1
TRANSCRIPT
Outcomes from the July workshop
1
Presentation by:
David Michael
Business Development & Project Manager
Products and Services
eIS Science Technology & Medicine
The British Library
RIC 2.0 Development Workshop 29/11/2010
Where did the requirements come from?
First closed beta release May 2008 search/discover and funding collaboration and storage 24 diverse Bio Medicine groups tested July-Sep 2008 Feedback collated Oct 2008
Engaging Biomedical Researchers Survey Q2 2010 Gather evidence on researcher information behaviour across the
biosciences community
Take all the feedback from the community over the past 2 years and identify the critical parts of RIC 1.0 that need to be in 2.0
2
How the requirements have been produced
3
Title Included? Reason for Inclusion/Exclusion
Detailed Use Cases Y For key functions required in V2.0
Business Rules N RIC is not business orientated although there may be specific ‘Research’ rules that may be captured.
Non Functional Requirements Y
Logical Data Model N To be defined as part of BI requirements
User Profiles Y
Usability Requirements Y
Education and Training Plan Y
Work Products Work Products
RIC Project Owner Account Registration
4
RICUC001 Account Registration Workflow
Ext
erna
l Acc
ount
O
wne
rA
ccou
nt M
anag
erR
ICP
roje
ct O
wne
r
Initiate institution account request via web form and
detail account number and users
required
Review Request
Accept Request
Provide Account, Ref code and web
form url
Open Institution Account +
Generate number on CMS.
Receive institution Account code via
email and web form url
Request Project Owners to set up user account and
provide link to web form
Populate web form to set up user
account
Automated check of web form
Details Ok
Manually Approve user account and
send email confirmation
Recieves feedback on errors and re
enters data
Receives email confirming user account set up with user id and
password
User logs in for first time
Y
N
Y
Provide Feedback
Receives feedback and updates
request
1
2
3
4
5
6
8
9 10
11
12
13
14
15
16
17
18
Receive institution account number
N
Access link to web form
Open web form
19
7
Add additional Users
5
RICUC003 Add Additional Users to Projects Workflow
Hel
p D
esk
Use
rP
roje
ct O
wne
r
Log in to RIC Access a projectSelect the add new
user feature
Add user name and email address
and submit
Exit add new user function and return
to project
Receive Form and manually apply
permissions and send email
confirming addition to new project to
new user / s
1 2 3 4
6
5
7
User receives email confirming access to new
project
Document review workflow
6
RICUC004 Document Review Workflow
Doc
umen
t Rev
iew
erD
ocum
ent O
wne
r
User logs in to RIC and accesses
project repository and selects the
upload feature to add document
User logs into ric and selects
template saved in existing repository
User edits and saves document /
template
User selects review feature
User logs into RIC to send existing doc for review
User selects team members to review the document from list / or selects all team members
User asked if additional team members need
access to review who don’t have
permissions
Select Review deadline and
provide commentary on
review
Submit email (automated)
Receives email and review
notification within RIC homepage
Opens link in email and logs onto the
RIC
Opens review task notification in home page
Opens document for review
Adds commentary via track changes
and comments
Save document as new version
Close document
Opens original email
Responds to email and confirms task
complete in response
Receives email confirming task complete and notification that the
task has been completed by reviewer in RIC homepage
Review deadline arrises and User is
informed of who hasn’t responded
Close review
Review changes in doc and save as
final version
Submit email to reviewers who havn’t fed back
manually
User selects permissions for
who can review / edit document
within project team
User decides to select permissions for who can review / edit document within project
team
N
Change permissionsY
Respond to confirm task
complete
Open task in personal hompage
and check task complete
hom
epa
ge
1 2
3 4
5
6
7
8
9
10
11
12
13
14
15
16
17
1819
2021 22
23
24
26
25
27
28
Resource Discovery
7
RICUC005 Resource Discovery Workflow
RIC
U
ser
Log in to the RIC and access home
pageOpen Project
Select search site
Perform search
Add to search history
Save to repository
Select search results to save and which repository to save in (personal /
Project)
Save As
Add to link repository
Add to Zotero / Mendeley
Add to Zotero / Mendeley
Start another search
link
Ful
l tex
t
xml
N
Y
Return to project / home page
depending on where search
originated
Save Search
Open a result in separate window
Return to project / home page
depending on where search
originated
Close Window
Decide next Step
Receive Search Results
1
3
2
4
5
6
7
8
9
10
11
21
13
14
15
16
17
18
19
20
Enter search text and Click
Search
Use BL research Service
12
Curation Workflow
8
RICUC006 Curation Workflow
RIC
Pro
ject
Ow
ne
r
Project Ends
Project Owner runs curate
function within RIC project User right clicks
items in repository to curate
Check other users in project
Owner informed other users in
Project and can’t curate via pop up
message
All items curated
Project Zipped and closed and further access is denied
Owner requests other users to log
out via email
Y
N
Y
N
1 2
3
4
5
6
7
8
9Confirm RIC can
package and archive project
10
Automatically adds to zip file
Save to chosen repository
11
RSS Feed Management
9
RICUC007 RSS Feed Management
RIC
SY
ST
EM
US
ER
Log into RIC Access Hompage
Access Project and any area with RSS feed manage
capability (repository, idea
generation, funding)
Select Manage RSS feed function
Select option
Click Add Feed
Select feed
Import feed from Outlook
Export feed to Outlook
Select feed to edit, open it and make
changes
Changes saved
Enter feed to add
Click delete
Run import feed function
Run export feed function
Provide list of outlook rss feeds
Provide list of RIC rss feeds
Select feeds to import Select feeds to
export
Import feeds
Export feeds to Outlook
Click Save changes
Perform another
operation
Exit Manage Feeds
Y
N
Feed deleted
Select feed/s
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
PowerPoint Workflow
10
RICUC008 PowerPoint Workflow
US
ER
2R
IC
US
ER
1
Log into RIC access Project,
Repository, Slide Library
Select Function
Select add slides to slide library
function
Click check box/es of slides to delete
Select slide to edit
Explore for presentations on
local drive
Click delete button
Slides deleted from repository
Changes saved
Perform another function
Exit slide library
Open presentation and select slides
to addClick create new
presentation button
Open powerpoint and add selected
slides to presentation
Save presentation to local drive
Add slides to slide library
Open powerpoint with slide to
edit
Save edited slide
to slide library
Edited Slide saved to Slide Library
Close edited slide
Select edit function
Close Presentation
Edit Slide
Click check boxes of slides to add to
presentation
Confirm if slide is being edited by
another user
Y
Do a simultaneous
edit
N
Y
Send other user a pop up
to confirm joint editing
request
Receive pop up
Approve / Reject Joint
editing request
Y
N
Receive joint editing rejection
via a pop up
Reject
Approve
N
1
2
3
4
5
6 7
8 9
10 11
12 13
14
15 16
17
18
19
2021
22
23
24
25
26
27
28
29
30
Discussion Workflow
11
RICUC009 Discussion Workflow
RIC
U
SE
R 1
Log into RIC and access project
homepage
Select Discussion
optionOpen new topic
Respond to an existing discussion
highlighted on homepage
Open an existing topic
Restrict who can view message
Click on restrict viewing rights function and
remove the rights to view of selected members in team
Message automatically
posted to team members via email
Click reply Add message
Add message
Open Discussions folder
Select Forum
Post / Cancel message
Click Exit Discussion forum
and return to project homepage
Continue discussions
Y
N
Y
N
Post
Cancel
1
2
3
4
5
6
7 8 9
10
11
12 1314
15
16
Task Management Workflow
12
RICUC010 Task Management Workflow
US
ER
2R
IC
US
ER
1
Logs into RIC Project Homepage
Open task management
Function
Enter task information
Save task and close
Create new task Choose who to assign task to
Select existing task to edit
Open task and edit
Perform another
operation
Exit tasks
Choose Function
Select Personal User ID Save and
Close
Select Team members User ID Save and Close
Inform team member of
assigned task via email and proj
homepage
Receive task assigned email and update in
project homepage
Close Task and remove from users
view
Self
Team Member
Save Changes + display task in
project homepage
Mark as complate
Y
N
1 2
3
4 5 6
7
8
9
10
11
12
1314 15
16
17
18
Transfer Information to other sites
13
RICUC011 Transfer Information to other sites workflow.
RIC
U
SE
R
Log into RIC Access any project
repository
Access mysite repository
Select item to export
Select where to export item to
(Connotea Mendeley etc)
Export / Import
Click on export
Click import button
Select where to import item from
(Connotea Mendeley etc)
Seamlessly open import
environment
Select item to import
Import item to repository
Seamlessly open export
environment
Save Changes in other environment
Exit other environment
Return to mysite or project repository
Save Changes
Export
Import N
eith
er
13
9
2 6
3
17
7
4
105
1 8
11
12
14
15
16
Search for Collaborators
14
RICUC012 Search For Collaborators Workflow
US
ER
1U
SE
R 2
RIC
6
7
1 3
11
4
9
8
2
10
5
Receive response via email and
message on home page
Define future collaboration
outside of RIC and return to RIC
profile
Open Personal profile
Enter message and click submit
View meet new people with matching
expertise / interests
Click Send email to potential
collaborator in RIC
Receive email
Send email Send response
Send response
Y
Collaboration does not happen
N
Bibliography Formatting Workflow
15
RICUC013 Bibliography Formatting Workflow
RIC
U
SE
R
Log into the RIC selects a project
and accesses the tools section
Select Bibliography
formatting tool
Check box against file name to export
references from
Select citation style
Select reference from project or
personal repository
Click on export
Export references in required style
Click on export to word / reference
manager function
Open word / reference manager with references in
required style
Display references in text window
Edit, Save / Close in word or ref
manager
Repeat process
Export to reference
manager or word
Y
N
Y
NSelect Reference Manager / Word Exit
11
8
4
131
2
7
3
14
15
12
9
610
5
Profile Update Workflow
16
RICUC014 Profile Update Workflow
RIC
U
SE
R
Open Personal profile
Log into ric Click on edit profile Edit information
manually in personal profile
Changes saved
All information present?
Save changes
Close profile editor
N
Y
35
4
7
1
6
8
2
Annotation Workflow
17
RICUC017 Annotation Workflow
RIC
U
SE
R
User logs onto RIC and accesses a
project repository
User selects item to annotate
Generate blank annotation form
Add text, rating, tags to annotation
Click submit
Generate annotation form
with previous entry
Determine if user has annotated the same item
before
Average ratings Save changes
Annotate another item
Exit repository
Y
N
N
Y
7
1
4
2
View annotation history
Exit Annotation history
3
5
6
8 9
10 11
1213
Live Meeting Workflow
18
RICUC018 Live Meeting Workflow
US
ER
2R
IC
US
ER
Open project
1
Open windows live and run live
meeting
Send invite via email
Receive and accept invite
43 7
Log into ric and access home page
Run Livemeeting in RIC
Add attendees to live meeting
6
5
2
Non Functional Requirements – Performance and Capacity
19
ID. RIC Area Name Description
NFPC002 Accessibility Cloud Hosting Hosting the service online obviates the need for local installation and the requirement to constantly upgrade technologies as new features become available.
Non Functional – User Experience
20
ID. RIC Area Name DescriptionNFUE001 Accessibility Single Sign on Need for single sign on. Compatibility with Athens / Shibboleth with
seamless logon to externally linked services such as Connotea and Del.icio.us. Identity management to include links to federated access management systems (e.g. Shibboleth). The reason for this is to make it easier for those in HEI to use the RIC for university-SME collaborations. Southampton doing Shibboleth review
NFUE002 Enabling Collaboration
Identify logged in team members
A facility to identify who is logged on will be required via pop ups on Home Page. Out of the box – all tested
NFUE003 Accessibility Browsers The service will be available over the internet and will be accessible through major Web browsers such Internet Explorer Safari and Firefox. The aim is to make the service available to the user wherever they or their colleagues may be. This includes ensuring accessibility via mobile/portable hardware such as netbooks. The RIC will also need testing on Chrome
NFUE004 Home Page Home Page configuration
When users log on to the RIC their Home page will be displayed. This Home page will present projects in which they are involved in via the top link bar and the activities that have recently taken place within those projects. Users will be able to enter the project workspace by clicking on the project name.
NFUE005 Home page Personal Repositories
The user will have access to a set of personal repositories (e.g. documents, references etc), selected when the user registered for the service (see Out Of The Box Solution feature). The personal repositories should be the same as the project repository space – see below.
Non Functional – User Experience
21
NFUE006 Enabling collaboration: shared repositories:
Project Repository A suite of shared repositories will be available in the default project template in the left hand navigation bar. These will include repositories for:DocumentsReferencesBookmarksSlidesRSS feedsImagesas well as more specialist ones (e.g. medical images) as they become available.
NFUE007 Enabling collaboration: discussion forums:
Wikis and presence engine
The demand for other forms of communication such as instant messaging and Wikis will be investigated during beta evaluation; evidence for this functionality being required by the target audience is not yet available.
NFUE008 Enabling collaboration: finding collaborators:
Identify Collaborators
Users will be alerted via their profile page to other people with similar interests to enable them to identify potential collaborators. This will be dependent on these other people providing enough content in their profile (e.g. tags) to enable them to be matched and allowing the information to be made available to others (see Home Page feature).
NFUE009 Resource discovery: Resource Identification
Each resource will have a description to enable users unfamiliar with the resource to assess its value to them within their default project template.
NFUE010 Tools to assist experimentation:
Data Storage and linking
Users will be able to store data as well as documents within the RIC, thus maintaining linkages between the various research outputs.
NFUE011 Curation of projects and data:
Object Reuse Exchange
Future releases of the RIC may include use of the Object Reuse Exchange protocol in order to maintain relationships between the curated objects. Assignment of name identifiers will be done through links to the Names Authority Service.
NFUE012 Site Templates Modify the RIC environment
Project Owners will be able to generate new project templates and modify the generic RIC site. Project Owners will be able to select the repositories they require for each project by personalising the default template (see Out of the Box Solution feature).There will be a mechanism to allow other resources to be installed into the template.
NFUE013 Site Templates Modify the RIC environment
Documentation will be provided for adding RIC plugins
Non Functional – Plugin Reqs
ID.RIC Area Name Description
NFPR001 Tools to assist experimentation:
OneNote OneNote will be provided as a means of logging experimental protocols within the RIC. Other Electronic Laboratory Notebooks will be investigated as part of ongoing development.
NFPR002 Tools to assist experimentation:
Excel Common tools for data manipulation will be provided that can be launched as standalone or as online services. The default tool will be Excel due to its popularity for recording and manipulating data.
NFPR003 Tools to assist experimentation:
Experimentation workflow tools
Feedback has shown that the methods that were used to generate the data are considered to be as important as the data itself in some circumstances. Within bioinformatics there is increasing use of automated workflow tools to generate data. For this reason the biomedically focused release will provide the following bioinformatics tools as default:
Trident workbench (including Microsoft Biology Foundation toolkit)myExperiment (to find workflows; enactment to local Taverna workbench)
NFPR004 Enabling collaboration: scheduling:
Calendar and Project functionality
An optional shared calendar plug-in will be offered.
The inclusion of project management tools for planning and scheduling would provide a more rounded, integrated environment 22
Non Functional – User Profiles
User Profile Char. No
Characteristic Group
Description
UP001 Personal Profile
Home page: The user’s personal profile will be accessed via the Home page. The profile enables users to share information about themselves such as their expertise and interests – and a photo. This information is valuable when others are trying to identify potential collaborators (see Enabling Collaboration: Finding Collaborators feature). The user will be able to select which fields are kept private and which can be shared. This is also where users will change their password.
UP002 Notifications Users should be able to configure what they want to be notified about (e.g. to be notified that items have been deposited) within their profile
23
Research Information Centre
Questions?
email: [email protected]
24
www.bl.uk/reshelp/experthelp/science