functional design specification v2_pvt

42
Development of the TETS Tracking Tool Light Functional Specification Sasol 21 January 2013 | Version: 1 Prepared by: Etienne van Dam Technical Lead M +27 82 784 7699 | T +27 11 575 4467 | E [email protected]

Upload: sandra-willms

Post on 14-Apr-2017

102 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Functional Design Specification v2_pvt

Development of the TETS Tracking Tool

Functional Design Specification

Sasol12 March 2013 | Version: 1

Prepared by:

Etienne van Dam

Technical Lead

M +27 76 790 0582 | T +27 11 575 3136 | E [email protected]

Page 2: Functional Design Specification v2_pvt

Document Contributors

Name Position

Etienne van Dam Technical Lead

Marié Wessels Development Manager

Ryan Smyth Project Manager

Document Sign-Off

Name Role Signature Date

Martie Ndlovu Sasol Project Sponsor

Marlan Perumal Sasol Project Champion

Marie-Anna Wauts Sasol Project Manager

Quintin Saville Sasol Technical Owner

Amanda Strydom Sasol Business Manager

Johntho Dixon Sasol Business Owner

Rebecca Dlepu Sasol Overall Business

AnalystRyan Smyth 3fifteen Project Manager

Marié Wessels 3fifteen Development Manager

Etienne van Dam 3fifteen Technical Lead

Page 3: Functional Design Specification v2_pvt

Table of Contents

1. Acronyms, Abbreviations, Business Definitions................................................................................4

1.1 Acronyms, Abbreviations..............................................................................................................4

1.2 Business Definitions......................................................................................................................5

2. Executive Summary............................................................................................................................... 5

3. Document Purpose................................................................................................................................ 6

4. The TETS Tracking Tool....................................................................................................................... 6

4.1 Mandatory Confidentiality Agreement.........................................................................................6

4.2 Navigation....................................................................................................................................... 7

4.3 My Personal Profile....................................................................................................................... 8

4.4 Landing Page............................................................................................................................... 12

4.5 View All Notifications Page........................................................................................................13

4.6 Log a New Observation...............................................................................................................15

4.7 Observation Page........................................................................................................................ 16

4.8 Search........................................................................................................................................... 21

4.9 Help................................................................................................................................................ 23

4.10 FAQ................................................................................................................................................ 24

4.11 Reports.......................................................................................................................................... 25

5. Standard SharePoint 2010 Functionality..........................................................................................30

5.1 List ribbon..................................................................................................................................... 30

5.2 Managed Metadata Field............................................................................................................31

Table of Figures

Figure 1 - Confidentiality Agreement..........................................................................................................7

Figure 2 – Navigation Bar Control...............................................................................................................7

Figure 3 – Personal Profile Screen.............................................................................................................8

Figure 4 – Add Alerts Screen.................................................................................................................... 10

Figure 5 – Landing Page............................................................................................................................ 12

Figure 6 – View All Notifications...............................................................................................................14

Figure 7 – Log New Observation Form....................................................................................................15

Figure 8 – View Observation..................................................................................................................... 17

Figure 9 – New Comment Form................................................................................................................18

Figure 10 – Add Keyword........................................................................................................................... 19

Figure 11 – Edit an Observation Form.....................................................................................................20

Figure 12 – Observation Search...............................................................................................................22

Figure 13 – Help: Wiki Page...................................................................................................................... 23

Figure 14 – Help: FAQ List........................................................................................................................ 24

Figure 15 – Request Report Form............................................................................................................25

Page 4: Functional Design Specification v2_pvt

Figure 16 – Request List Report Form.....................................................................................................27

Figure 17 – Request Raw Data Report Form..........................................................................................28

Figure 18 – Generating a Report..............................................................................................................29

Figure 19 – Saving a Report...................................................................................................................... 30

Figure 20 Sample List Report.................................................................................................................... 31

Figure 21 Sample Raw Data Report.........................................................................................................32

Figure 22 Sample Chart Report................................................................................................................. 33

Figure 23 Ribbon bar with 'Attach File' button........................................................................................34

Figure 24 Attaching a file........................................................................................................................... 34

Figure 25 Managed Metadata field...........................................................................................................34

Figure 26 Managed Metadata field value auto completion....................................................................35

Figure 27 Managed Metadata selecting a keyword................................................................................35

List of Tables

Table 1 - Acronyms, Abbreviations.............................................................................................................5

Table 2 - Business Definitions.....................................................................................................................5

Table 3 – Personal Profile Fields................................................................................................................9

Table 4 – Alerts Fields................................................................................................................................ 11

Table 5 – New Observation Fields............................................................................................................16

Table 6 – New Comment Fields................................................................................................................19

Table 7 – FAQ List Fields........................................................................................................................... 25

1. Acronyms, Abbreviations, Business Definitions

1.1 Acronyms, Abbreviations

Acronym Comments / Notes

AD Active Directory

RFC Request for Change

UAT User Acceptance Testing

SDLC Software Development Life Cycle

XSLT Extensible Stylesheet Language Transformation

CSS Cascading Style Sheet

Page 5: Functional Design Specification v2_pvt

FAQ Frequently Asked Questions

RFC Request for Change

Table 1 - Acronyms, Abbreviations

1.2 Business Definitions

Define terms that are specific to the client business or industry and our understanding of the term.

Definition Comments / Notes

TETS Transportation Energy Technology Strategy

Table 2 - Business Definitions

2. Executive Summary

Within the Research and Technology arm of Sasol Technology employees collect and distribute

observations. These observations may pertain to current research, conferences, networking,

meetings, and so forth. Observations are identified as part of their tasked work activity which is

usually shared via electronic mail to whomever they think should know about it. The observations

identified are not collated into a single storage area where the observations can be referenced in

future. It has been pointed out that, occasionally these observations do not reach all the relevant

technology owners.

The solution will utilise the Microsoft Office SharePoint 2010 Server Standard Edition platform

which will allow Sasol Users to capture new, comment on, “like”, and search for observations.

The SharePoint User Profile will be used to store user location, notification subscription, and

preference information. Reporting functionality will be provided that will allow Sasol to export a

List report in a card-layout to Microsoft Office Word format and a Raw Data report into Microsoft

Office Excel format. Configurable Bar and Line charts will be implemented. The charts can be

saved as an image file by the users of the solution. Custom XSLT and CSS will be implemented to

give the solution a social look & feel as will be defined in the Design Specification delivered by

3fifteen. Finally, a FAQ list and SharePoint 2010 Wiki Site will be created to provide help for the

user. Keeping the help files and FAQ up to date will be managed through the SharePoint standard

interface and should continue beyond the initial implementation phase of the project. These

updates will be the responsibility of Sasol.

Page 6: Functional Design Specification v2_pvt

3. Document Purpose

The purpose of this document is to clearly define the functionality and layout of the Sasol TETS

Tracking Tool as it will be developed and implemented. The screens from the wireframes are

included and all details regarding each screen is defined.

4. The TETS Tracking Tool

4.1 Mandatory Confidentiality Agreement

Before users can access the system they must accept the mandatory confidentiality agreement

and update their location, interests and alerts email address in their personal profile. The system

will have a mechanism on each page of the system which will not be visible to the user. This

mechanism will first check if the current user has accepted the mandatory confidentiality

agreement from the user profile properties. If the user has not accepted the mandatory

confidentiality agreement, the user will be redirected to the ‘My Personal Profile’ page where a

modal popup will display the mandatory confidentiality agreement. A modal popup is a popup

which overlays the site content and forces the user to interact with it before they can return to

interacting with the underlying page. The user will not be able to close the modal popup without

clicking on the ‘Accept’ button. When the user clicks on the ‘Accept’ button the system will save to

the user profile that the user has accepted the agreement. The user will not be presented with

the confidentiality agreement again.

Page 7: Functional Design Specification v2_pvt

Figure 1 - Confidentiality Agreement

Once the confidentiality agreement has been accepted, the user will be directed to the ‘My

Personal Profile’ page, where the user will update their location, interests, and alerts email

address. If a new user navigates to any of the pages in the site, the hidden mechanism will check

if the user has updated these properties in their personal profile. If the user has not, the user will

be redirected to the ‘My Personal Profile’ page. Once the user has saved these properties in their

personal profile they will be redirected to the landing page where they can begin to use the

system.

4.2 Navigation

Page 8: Functional Design Specification v2_pvt

Figure 2 – Navigation Bar Control

A navigation bar will be displayed on the top of each page. This navigation bar will contain image

buttons which a user of the system will use to navigate the system.

The following navigation buttons will be available:

Landing Page, see section 4.4

Log New Observation, see section 4.6

Search, see section 4.8

Help, see section 4.9

FAQ, see section 4.10

Request Report, see section 4.11

Personal Profile, see section 4.3

4.3 My Personal Profile

Page 9: Functional Design Specification v2_pvt

Figure 3 – Personal Profile Screen

The user can navigate to the ‘My Personal Profile’ page from the ‘Abbreviated Profile’ web part on

the landing page or from the link button in the navigation bar which will be available on all pages

of the system. On the ‘My Personal Profile’ page, the user can update their location, interests,

and alerts email in the ‘Personal Details’ web part. The user’s alerts email address is defaulted to

the user’s email address as available in their SharePoint User Profile. The user can override the

alerts email address to so that they will be able to receive the alerts on any email address.

Clicking on the ‘Save’ button will save the changes made to the ‘Personal Details’ section and

redirect the user to the landing page.

Fields:

Field Name Comments / Notes Type

NameWill be retrieved from the SharePoint User Profile which is pulled from AD.

Non editable field

Job TitleWill be retrieved from the SharePoint User Profile which is pulled from active directory.

Non editable field

LocationThe user’s current location. Johannesburg, Sasolburg, etc. To be captured by the user.

Mandatory single line text field

Interests

Managed Metadata Tags linking to the Technology Areas of the TETS Tracking Tool application. To be captured by the user.

Mandatory Managed Metadata field

E-mail

The first time a user opens the ‘My Personal Profile’ page, this value will be retrieved from their SharePoint profile. The user is able to change this to any other email address.

Validation: The value entered in this

field must be in the format of an email

address that matches:

<text>@<text>.<text> and will be

validated against that expression.

Mandatory single line text field

Table 3 – Personal Profile Fields

Page 10: Functional Design Specification v2_pvt

The ‘My Liked Observations’ web part will be located to the right of the ‘Personal Details’ web

part. It displays observations which the user marked as liked. A list of the latest five liked

observations will be displayed with standard SharePoint pagination if the user has more than five

liked observations.

The ‘Alerts Management’ web part is used to manage user subscribed alerts. It displays a grid

with the alerts that the user has set up. The user can subscribe to a new alert by clicking on the

‘Add New Alert’ button. The New Alert form will slide out and the ‘Save’ button on the ‘Personal

Details’ web part as well as the ‘Edit’ and ‘Delete’ buttons in the grid of existing alerts will be

disabled.

Page 11: Functional Design Specification v2_pvt

Figure 4 – Add Alerts Screen

Fields:

Field Name Comments / Notes Type

Title The title of the alert. Mandatory single line text field

ObserverA people picker field. The user will be able to search and add existing users from AD.

Optional People Picker field

Observation Type

Managed Metadata Tags linking to the Observation Types of the TETS Tracking Tool application.

Optional Managed Metadata field

Technology Area

Managed Metadata Tags linking to the Technology Areas of the TETS Tracking Tool application.

Optional Managed Metadata field

KeywordsManaged Metadata Tags linking to the Keywords of the TETS Tracking Tool application.

Optional Managed Metadata field

From

This is a date field. The user will be alerted on observations that were logged after the date entered in this field.

Validation: If this field has a value, the To field must also have a value where the date is after this one.

Optional Date Picker field

To

This is a date field. The user will be alerted on observations that were logged before the date entered in this field.

Validation: If this field has a value, the From field must also have a value where the date is before this one.

Optional Date Picker field

Frequency

The frequency on which the user will receive alert emails. Options: Instantaneous, daily, or weekly. The default option will be weekly.

Mandatory dropdown field

Table 4 – Alerts Fields

At least one of the following fields must be entered otherwise the alert will not return useful

information:

Observer

Page 12: Functional Design Specification v2_pvt

Observation Type

Technology Area

Keywords

From and To

Clicking on the ‘Add’ button will save this alert subscription to the user’s profile and slide out the

Alerts form. Clicking on the ‘Cancel’ button will slide out the Alerts form without saving it to the

user’s profile.

Existing alerts can be deleted by clicking on the ‘Delete’ button in the grid next to the saved alert.

A confirmation popup will be displayed before deleting the alert. Existing alerts can be edited by

clicking on the ‘Edit’ button next to the alert in the grid. This will slide out the Alert form with the

fields pre-populated with the saved information.

4.4 Landing Page

Page 13: Functional Design Specification v2_pvt
Page 14: Functional Design Specification v2_pvt

Figure 5 – Landing Page

The ‘Observation Newsfeed’ web parts are located on the landing page below the navigation bar.

These web parts will display the following:

The latest Observation that was logged. Clicking on the observation title will take the user

to the observation page. The web part will also display the number of likes for the

observation.

The observation with the most likes. Clicking on the observation title will take the user to

the observation page. The web part will also display the number of likes for the

observation.

The most popular Technology Area. This will be calculated by adding the number of

observations, number of comments and the number of likes that was tagged with this

Technology Area. The web part will display the Technology Area as a link which will take

the user to the search page with search results for the Technology Area. The web part will

also display the number of observations that were tagged with the Technology Area, the

number of comments on observations that were tagged with the Technology Area as well

as the number of likes on observations that were tagged with the Technology Area.

The most popular Keyword. This will be calculated by adding the number of observations,

number of comments and the number of likes that was tagged with this Keyword. The web

part will display the Keyword as a link which will take the user to the search page with

search results for the Keyword. The web part will also display the number of observations

that were tagged with the Keyword, the number of comments on observations that were

tagged with the Keyword as well as the number of likes on observations that were tagged

with the Keyword.

The most commented observation in the last week. The web part will also display the

number of comments for the observation.

The observation with the most likes in the last week. The web part will also display the

number of likes for the observation.

The latest ten observations that was logged including pagination and a scroll bar. This will

allow users to browse observations that are not part of their alerts criteria. They will be

exposed to observations from other business areas without the need to specifically search

for them.

The ‘Abbreviated Profile’ web part will be located in the top right of all the pages. This web part

will display the following information retrieved from the SharePoint User Profile:

The currently logged in user’s profile picture (avatar)

The user’ first and last name

The user’s job title.

Page 15: Functional Design Specification v2_pvt

The user’s interests will also be displayed in this web part as captured in the ‘My Personal Profile’

page. An ‘Edit My Profile’ link located beneath the ‘Abbreviated Profile’ web part will allow the

user to navigate directly to the user’s ‘My Personal Profile’ page where the user can update their

profile information and alert subscriptions.

The ‘Notifications’ web part located below ‘Abbreviated Profile’ web part will display the three

latest alerts according to the user’s alerts settings. At the bottom of this web part there will be a

‘View All Notifications’ link which will take the user to the ‘All Notifications’ page.

4.5 View All Notifications Page

This page will have the navigation bar at the top and an ‘All Notifications’ web part below that.

This web part will by default display the latest ten user alerts with standard SharePoint pagination

controls on the bottom of the page. The notifications area will be scrollable so that the navigation

bar and pagination control is always visible. The notifications will be sorted by date so that the

latest notification is at the top. Clicking on the notification title will navigate the user to the

observation page.

Figure 6 – View All Notifications

Page 16: Functional Design Specification v2_pvt

4.6 Log a New Observation

Figure 7 – Log New Observation Form

Clicking on the ‘Log New Observation’ button in the navigation bar will open the new observation

form popup. The user needs to fill in the form with the following fields:

Field Name Comments / Notes Type

Title The title of the observation Mandatory single line text field

Description The body of the observation Mandatory multi line rich text field

Comments Summary

When there are many comments on an observation, this field can be used to summarize the comments so that users viewing the observation does not have to read all the comments to get an overview

Optional multi line rich text field

Page 17: Functional Design Specification v2_pvt

of what was discussed. This field must be edited by the observer.

Observation Type

Managed Metadata Tags linking to the Observation Types of the TETS tracking application.

Mandatory Managed Metadata field

Technology Area

Managed Metadata Tags linking to the Technology Areas of the TETS tracking application.

Mandatory Managed Metadata field

KeywordsManaged Metadata Tags linking to the Keywords of the TETS tracking application.

Mandatory Managed Metadata field

HyperlinkThis field can be used to add a link to an online document or article related to the observation

Optional hyperlink field

Table 5 – New Observation Fields

The standard SharePoint ribbon will be used to attach documents to the observation. Clicking on

the ‘Save’ button will save the observation and navigate the user to the observation page. Clicking

on the ‘Cancel’ button will navigate the user back to the landing page without saving the

observation. After the observation was saved, an alert subscription will automatically be added to

the observers profile for the new observation.

4.7 Observation Page

Page 18: Functional Design Specification v2_pvt

Figure 8 – View Observation

On the observation page the navigation bar will be at the top of the page and below that the title

of the observation will be displayed. There will be an ‘Observation’ web part which will display the

following details of the observation:

Picture of the observer

The date on which the observation was logged

The observation type linked to the observation

The technology area linked to the observation

The keywords linked to the observation

The observer’s name

The body of the observation

The Comments Summary

A list of the files attached to the observation

The number of likes

Page 19: Functional Design Specification v2_pvt

Clicking on the observation keywords or technology type will navigate the user to the search page

with results on the clicked item. This web part will also have a ‘Like’, ‘Comment’ and ‘Edit’ button.

The like button will be a thumbs up image button. When a user clicks on this button the number of

likes for this observation will be incremented and the button image will change to a tick mark

image. The user can un-like the observation by clicking on the tick mark image button which will

decrement the number of likes for this observation.

Figure 9 – New Comment Form

A user can leave a comment on the observation by clicking in the ‘Comment’ button. This will

show a popup of the ‘New Comment’ form where the user needs to fill in the following fields:

Field Name Comments / Notes Type

Title The title of the comment Mandatory field

Description The body of the comment Mandatory multi line rich text field

Hyperlink The user can add a link to an online Optional field

Page 20: Functional Design Specification v2_pvt

document or article related to the comment

Table 6 – New Comment Fields

The standard SharePoint ribbon will be used to attach documents to the comment. Clicking on the

‘Save’ button will save the comment and navigate the user to the observation page. Clicking on

the ‘Cancel’ button will navigate the user to the observation page without saving the comment.

Figure 10 – Add Keyword

Any user will be able to add keywords to the observation to better classify it and make it easier to

find when searching by clicking on the ‘Tag’ button. Observation type and technology area will be

closed term-sets which will be managed by a site administrator. Users need to request that new

terms be added to it. Keywords will be an open term-set therefore users will be able to add their

Page 21: Functional Design Specification v2_pvt

own keywords if it does not exist already. If an observation was tagged with a keyword and the

keyword is changed or removed thereafter, the original keyword will stay on the observation until

the user edit’s the observation. When editing the observation the old keyword will be removed and

the user will have to add a new one.

The ‘Edit’ button will only be visible to the observer of this observation. Clicking on it will show the

‘Edit Observation’ form popup with the observation fields pre-populated. Clicking on the ‘Save’

button will save the changes to the observation and navigate the user to the observation page.

Clicking on the ‘Cancel’ button will navigate the user to the observation page without saving the

changes.

Figure 11 – Edit an Observation Form

There will also be a ‘Report to Administrator’ link in this web part which will open the user’s email

client pre populating the following fields:

‘To’ address with the site administrator’s email address

Subject with ‘Please have a look at this observation’

Page 22: Functional Design Specification v2_pvt

Body. A link to the observation will automatically be added to the body of the email. The

user can then add comments into the email body on what needs to be reported.

Below that the ‘Observation Comments’ web part will display the comments on the observation.

By default the latest ten first level comments will be displayed with standard SharePoint

pagination controls below that. At the bottom of the page there will be a text box where a user can

add a quick comment to the observation. This text box will be a multi-line rich text field which

means the user can do basic formatting on the comment such as underline, bold, etc. When

creating a quick comment like this the user will not be able to attach documents to the comment.

The first level comments will be expandable but by default they will be collapsed. The comments

area will be scrollable so that the ‘Observation’ web part and quick comments text box will always

be visible on the page. Sub comments will be slightly indented on the page to easily identify.

Each comment will display the picture and name of the user who made the comment as well as

the comment body and a list of all the attachments on the comment. Each comment will also have

a ‘Reply’, ‘Edit’ and ‘Delete’ button. The ‘Reply’ button will be visible to all users and is used to

add a reply to a reply. Clicking on it will display the same ‘New Comment’ form popup described

above. Comments will only go two levels deep thereafter new sub comments will stay on the same

level. Clicking on the ‘Edit’ button inside the comment area, will display the ‘Edit Comment’ form

popup with the pre-populated information from the comment. Clicking on ‘Save’ will save the

changes to the comment and close the popup. Clicking on ‘Cancel’ button will close the popup

without saving the changes to the comment. The ‘Edit’ button will only be visible to the user who

made the comment. Clicking on the ‘Delete’ button will show a confirmation popup before deleting

the comment. A comment cannot be deleted if it has sub comments. The ‘Delete’ button will only

be visible to the user who created the comment.

On the right of the observation page will be a navigation web part. This web part will have a tab

for keywords and technology area. If you are on the keywords tab, a list of other observations will

be displayed where the keywords match any of the current observation’s keywords. The same

applies for the technology area tab. This will then show links to other related observations which

the user might want to look at. Clicking on an observation title in the web part will navigate the

user to that observation.

4.8 Search

Page 23: Functional Design Specification v2_pvt

Figure 12 – Observation Search

The standard SharePoint search can be used which will search observations, comments and

attachments, however clicking on the ‘Search’ image button on the navigation bar will take the

user to the observation search page. This search is more specific to observations and will only

search observations. The user can use any one or more of the following filters to refine the search

results:

Text in Title or Body

This will only search for the entered text within the body or title of the observation. This

will be a complete phrase match, meaning it will not search for an exact match of the

phrase you entered.

Observer

Observation Type

Technology Area

Keywords

From Date. This will filter based on the observation’s created date.

Page 24: Functional Design Specification v2_pvt

To Date. This will filter based on the observation’s created date.

These filters are inclusive filters which means that if you add an observer and an observation

type, it will only return results where both are matched.

By default the latest ten search results will be displayed with standard SharePoint pagination

controls at the bottom of the page. Only the search results will be scrollable so that the filters

area will always be visible on the page.

4.9 Help

Figure 13 – Help: Wiki Page

Page 25: Functional Design Specification v2_pvt

Clicking on the ‘Help’ image button in the navigation bar will navigate the user to a standard

SharePoint wiki site. This wiki site will contain general help information on how to use the system.

4.10FAQ

Figure 14 – Help: FAQ List

Clicking on the ‘FAQ’ image button in the navigation bar will navigate the user to the FAQ list with

the following fields:

Field Name Comments / Notes Type

Title The title of the question Mandatory single line text field

Description The answer to the question Mandatory multi line rich text field

Page 26: Functional Design Specification v2_pvt

Technology Area

Managed Metadata Tags linking to the Technology Areas of the TETS tracking application.

Mandatory Managed Metadata field

KeywordsManaged Metadata Tags linking to the Keywords of the TETS tracking application.

Mandatory Managed Metadata field

Table 7 – FAQ List Fields

4.11Reports

Figure 15 – Request Report Form

Page 27: Functional Design Specification v2_pvt

Clicking on the ‘Request Report’ image button in the navigation bar will navigate the user to the

‘Reports Page’. On the reports page the user will have the same filtering as on the search page

which will be used to retrieve the data on which the report is based. The user have an option of

Chart, List or Raw Data for the type of report to generate.

For a chart report the following options are available:

Line or bar chart

For the X-Axis value:

o Observation Title

o Technology Area

o Keyword

o Observer

o Created Date

For the X-Axis value:

o Number of Observers

o Number of Observations

o Number of Comments

o Number of Likes

The title of the chart will be “[X-Axis Selected Value] / [Y-Axis Selected Value]”

Example: Keywords / Number of Observations

For a list report the user will be able to select from the following optional fields to include in the

report:

Observation Body

Comments Summary

Comments

The following fields will be mandatory for a List report:

Title

Number of Likes

Observer

Number of Comments

Date of observation

Observation Type

Keywords

Technology Area

Page 28: Functional Design Specification v2_pvt

Figure 16 – Request List Report Form

For a raw data report the user will be able to select from the following optional fields to include in

the report:

Observer

Observation Date

Observation Type

Keywords

Technology Area

Number of Likes

Observation Body

Comments Summary

Comments

The following fields will be mandatory for a Raw Data report:

Title

Page 29: Functional Design Specification v2_pvt

Figure 17 – Request Raw Data Report Form

Clicking on the ‘Generate Report’ button will collect the data according to the filters and open the

report in the appropriate Microsoft Office Client Application. For a list report this will be Microsoft

Word and for a raw data report it will be Microsoft Excel. The user will then be able to save it from

there to their local machine or print the report from the client application.

Page 30: Functional Design Specification v2_pvt

Figure 18 – Generating a Report

For chart reports the image will be opened in a new window. The user can then use the default

browser printing functionality to print the report or save it to their local machine.

Clicking on the ‘Save’ button will display a text box where the user must enter a descriptive name

for the report query. Then clicking in the ‘Ok’ button will save the query directly into the

SharePoint site. Clicking on ‘Cancel’ will return to the reports page. This will allow all users of the

system to open previously saved queries directly from the site.

Page 31: Functional Design Specification v2_pvt

Figure 19 – Saving a Report

On the right of the reports page there will be a ‘Saved Queries’ web part which will display the ten

latest saved report queries. Clicking on the title of the saved query will open the reports page with

the filters and settings pre-populated as it was saved. The report can then be re-generated.

Page 32: Functional Design Specification v2_pvt

Figure 20 Sample List Report

Page 33: Functional Design Specification v2_pvt

Figure 21 Sample Raw Data Report

Page 34: Functional Design Specification v2_pvt

Figure 22 Sample Chart Report

4.12Security

The following security groups will be used for the site:

TETS Owners. The site administrator and site owners will be added to this group. They will

have full control over the site such as add, edit or delete any content throughout the

system. (Observations, comments, FAQ items, Help pages). They will also have direct

access to the back end lists which will be used to store all the information. Therefore they

will be able to delete observations when appropriate.

TETS Members. Users who need to contribute to the system will be added to this group.

They will have permissions to add observations and comments, edit their own observations

and comments as well as delete their own comments. (if the comment does not have a sub

comment). They will not have direct access to the back end lists. They will also not be able

to add or edit to the Help pages and FAQ list.

Page 35: Functional Design Specification v2_pvt

5. Standard SharePoint 2010 Functionality

5.1 List ribbon

The standard SharePoint 2010 ribbon bar that will be used to attach files to observations and

comments.

Figure 23 Ribbon bar with 'Attach File' button

After clicking on the ‘Attach File’ button, a popup will be displayed which will allow the used to

browse and select a file to attach.

Figure 24 Attaching a file

5.2 Managed Metadata Field

The standard SharePoint 2010 Managed Metadata field which will be used for the Keywords,

Technology Area and Observation Type fields.

Page 36: Functional Design Specification v2_pvt

Figure 25 Managed Metadata field

When the user starts typing in the field, the field will show existing terms which match. In an open

term set, this will minimize the chances of users adding multiple terms with different spelling.

Figure 26 Managed Metadata field value auto completion

The user can also click on the tags image button on the right of the field. A popup will appear

which will allow the user to choose a term instead.

Page 37: Functional Design Specification v2_pvt

Figure 27 Managed Metadata selecting a keyword