Web Client User Guide for Release 5.1
This guide is a reference for the browser-based interface included with ScrumWorks Pro release 5.1. New users are encouraged to read the Quick Start Guide first for a product use overview. Please visit our support site with any questions or to report issues.

Requirements

The ScrumWorks Pro Web Client requires one of the following web browsers with JavaScript enabled:
  • Mozilla Firefox 3.6 and higher
  • Safari 5.0 and higher
  • Google Chrome 9 and higher
  • Microsoft Internet Explorer 8 and higher
  • Microsoft Internet Explorer 7 is supported but lacks features and performance of more modern browsers
Quick Links
Getting Started with the Web Client
  • Log into ScrumWorks Pro Web Client
  • View Navigation
Planning View
  • Selecting the Planning view
  • Select a Product
  • Select a release or team
  • Create a backlog item
  • Editing a backlog item
  • Business Weight
  • Backlog item themes
  • Adding Attachments
  • Opening and Downloading Attachments
  • Delete a backlog item
  • Prioritizing backlog items
My Tasks View
  • Selecting the My Tasks view
  • Updating your assigned Tasks
Sprints View
  • Synchronizing with other Desktop Client and Web Client users
  • Selecting the Sprints view
  • Select a Product
  • Select a Sprint
  • Task Board Overview
  • Task Board Layout Description
  • Customizing the Task Board Display
  • Add Tasks
  • Edit Tasks
  • Task Comments
  • Changing Task Status
  • Ranking Tasks
  • Moving Tasks between Backlog Items
  • Volunteer as Point Person
  • Update Timesheet Entry
  • Delete Tasks
  • Marking Product Backlog Items done
  • Product Backlog Item Comments
  • Sprint Burndown Chart
Dashboard
  • Selecting the Dashboard view
  • Select a Product
  • Select a Report
Full page item editor
  • Opening the full page editor
Documentation Home

Getting Started with the Web Client

The ScrumWorks Pro Web Client is intended as a light-weight alternative to the ScrumWorks Pro Desktop Client. The Web Client provides team members access to sprint tasks through the "Sprints" and "My Tasks" views, while managers and product owners have access to backlog management features through the "Planning" view. The "Dashboard" view gives all users access to custom web reports from the convenience of the web client.

The Web Client has four top-level areas:

  1. My Tasks - a user-centric view of one user's tasks across all Products. It is a light and convenient interface primarily intended for team members working on multiple teams and sprints.
  2. Planning - offers managers and product planners the opportunity to define and manage the product backlog. This area allows multiple columns of backlog items to be defined by the user for purposes of prioritization and categorization via drag and drop between columns.
  3. Sprints - a sprint specific view providing team members a digital "task board" interface for tracking the progress of all tasks in the selected Sprint.
  4. Dashboard - provides easy access to your ScrumWorks Pro web reports.

Log into ScrumWorks Pro Web Client
All ScrumWorks Pro users may log into the Web Client, although product access, specific roles and team membership is required for certain functions.
  1. Open a supported browser and navigate to your server's ScrumWorks Pro installation:

    http://<hostname:8080>/scrumworks

    where <hostname> should be replaced with the hostname and/or IP address of the server where the ScrumWorks Pro server is installed.
  2. The welcome screen will present you with two options, "ScrumWorks Pro Web Client Login" and "ScrumWorks Pro Desktop Client".
  3. In the Web Client Login section, enter your login name and password as set in the User Manager or User Preference section of the ScrumWorks Pro Desktop Client. Users administration capabilities are available in the ScrumWorks Pro Desktop Client.

    If you choose the option 'Remember me for two weeks', you will be automatically logged into the Web Client each time you access the page until you explicitly logout or two weeks has transpired. For security reasons, do not use this option on computers to which other people have access.

» top

View Navigation

When navigating between the different Web Client views, the last view you selected will be saved. Each time you log into the Web Client, the last page you were viewing will be loaded as your default page.

» top

Planning View

The Planning view provides the ability to create and organize backlog items into releases and sprints.

The view contains three columns that can be configured to show a product release or a team's sprints. Backlog items can be dragged to re-prioritize them within the same column, or dragged between columns to modify release and sprint associations.

Selecting the Planning view

Once authenticated, the Planning view is always accessible by clicking the "Planning" navigation option in the page header.

All ScrumWorks Pro users can access this view; no special permissions are required.

» top

Select a Product

To select a Product:

  1. Locate the Product selection menu located directly below the page header on the left hand side. Click the currently selected product name or the drop-down icon to activate the menu.
  2. The Product selection menu places your recently opened products on the left side of the menu, while a list of all available products is on the right side.
  3. Select a product by clicking the product name. The page will refresh with the new product context. Note that this product context persists through the current and future sessions until it is changed again.
  4. To cancel a product selection, close the menu by clicking outside of the menu area.

» top

Select a release or team

Once you have selected your product context, you can start populating the columns with data. The dropdown for each column contains all of your active (un-archived) releases, and all teams that are working on the product.

By default, the release appearing at the top of the backlog is loaded into the left column, and the first two teams are loaded into the center and right columns respectively. Once you make a selection, it is remembered for future sessions and will be restored whenever possible.

To change what data is displayed in a column, choose a release name or team name from that column's dropdown menu.

  • Selecting a release name from the dropdown menu will populate that column with all uncommitted backlog items in the selected release.
  • Selecting a team name from the dropdown will populate the column with the backlog items in that team's current sprints. If you want to view all of the team's sprints, select the 'All' option on that team's column.

» top

Create a backlog item

To create a backlog item, click the new backlog item button associated with the desired target release or sprint. Upon saving, the backlog item will be associated to that sprint or release. If you create a backlog item in a sprint column, you will still be required to select the release for the new backlog item.

The create backlog item dialog will appear and the backlog item's attributes can be populated including title, description, estimate, themes, comments, and business value data. Click save when finished and the backlog item will be created. The backlog item title is required.

To create a backlog item, you must have the Create Product Backlog Item permission.

» top

Editing a backlog item

From the planning view, you can edit a backlog item's title, description, and other attributes. To open the backlog item editor, click on the backlog item's title in the Planning view. Multiple editors can be open at the same time. If a backlog item is already open, it will be brought into focus; a single backlog item cannot be open in more than one editor.

Your role affects what you can see and edit in the backlog item editor. For instance, if you don't have permission to see business weight, you will not see any business weight information.

You can change the associated release by selecting a different release from the selector. The backlog item will be moved into that release ranked at the top of that release.

To mark the backlog item as done, so it contributes toward the team's velocity, chose a Done status in the status dropdown.

» top

Business Weight

To change the Business Weight of a backlog item, open the business weight accordion and update the benefit and penalty estimates. The values entered here, in combination with the effort estimate, generate a number of calculations by which the backlog item may be compared relative to its release, product, and other backlog items. The business weight, ROI, and rBV values only update upon saving the backlog item and updates will reflect the next time the editor is opened.

For an explanation of business weight and the related fields please see the user documentation for Earned Business Value.

» top

Backlog item themes

The themes associated with a backlog item can be changed in the Themes accordion on the backlog item editor.

To add a theme to the backlog item, select it from the "Available Themes" list and use the button controls to add it to the backlog item. To remove a theme from a backlog item, select it from the "Applied Themes" list and use the button control to remove it from the backlog item. You can also double-click on a theme in either list to move the theme to the the other list. Themes may be multi-selected using Shift or Ctrl keys.

» top

Adding Attachments
Files can be attached to backlog items from the item editor.
To attach a files:
  1. Expand the 'Attachments' accordion.
  2. Click the button to browse for the file to attach.
  3. The attachment will be uploaded when you click the 'Save' button on the editor.
Note, only one attachment may be uploaded at a time.

» top

Opening and Downloading Attachments
Files attached to backlog items may be opened and downloaded from the web client.
To open or download files:
  1. Expand the 'Attachments' accordion to view the list of attachments.
  2. Click the link for any file to open it.
  3. When clicked, the attached file is downloaded and automatically opened by the browser, according to browser settings for opening files of differing extension types.
  4. Attachments opened by the browser may be saved locally by using the browser's File menu or right-click context menu.

» top

Delete a backlog item

To delete a backlog item, open the backlog item's editor by clicking on the title. The editor will show a "Delete" button on the bottom left hand side of the editor.

You will be prompted to keep or delete the historic backlog item data. Keeping the data will preserve estimate history used in release level reports. Deleting the historical data will remove the backlog item and its historical effort estimates will not factor into release level reports.

» top

Prioritizing backlog items

From the planning view, you can organize and prioritize backlog items. Moving them within a release or sprint, as well as between releases and sprints.

To move a backlog item, you can drag it vertically from the current position and drop it to a new desired position. Moving backlog items in this manner adjusts the "relative priority" of the item in contrast to other items in the backlog.

Notes:

  • This feature is only available for users with Commit and Prioritize backlog item permissions, users without this permission can not move backlog items in the planning view.
  • Dragging a backlog item marked Done into a release will prompt you to change the status to a Not Started status type since Done items must be associated with teams.

» top

My Tasks View

The ScrumWorks Pro My Tasks view provides a user-centric view of ScrumWorks Pro data. It is a light and convenient interface primarily intended for team members working on multiple teams and sprints.

The view is comprised of a list of all undone tasks assigned to you in current sprints: those that are ongoing or whose begin or end dates are within the last five days. The tasks are displayed in priority order as listed in the ScrumWorks Pro Desktop application.

Intended for users working on multiple teams, products, or sprints, the My Tasks view offers users a consolidated view of all tasks for which the logged in user is the designated Point Person across all products and sprints.

Selecting the My Tasks view

Once authenticated, the My Tasks view is always accessible by clicking the "My Tasks" navigation option in the page header.

Required Permission: View Task, for each listed product.

» top

Updating your assigned Tasks

You can update the Hours Spent Today, Hours Remaining and the Status of your tasks from the My Tasks view. Once you have made changes to your tasks, clicking on the Update Tasks button will submit those changes.

Required Permission: Create/Edit/Delete Task, for each listed product where changes are to be made.

If you decide that you have made a change in error, you can click the Cancel button to revert any unsaved changes.

» top

Sprints View

The Sprints view is designed primarily for Scrum team members working toward Sprint goals. The Sprints view employs a "task board" paradigm, where tasks are arrayed into columns representing task status. All tasks currently defined in the selected Sprint will appear in the task board, including tasks with a designated point person and those without a point person designation (unspecified).

The Sprints view is comprised of two main elements:

  1. Task board - a functional view that shows all the current tasks within a sprint and their statuses.
  2. Sprint Burndown Chart - a graphical representation of Sprint level progress that shows the sums of tasks and task hours remaining on a day by day basis.

Synchronizing with other Desktop Client and Web Client users

Because ScrumWorks Pro is a multi-user system, there is a possibility that the data represented within the Web Client is out of synchronization with changes made by other users. To compensate for this, the Sprint View will automatically poll the ScrumWorks Pro server for any updates to visible content every 30 seconds. Users can manually trigger a polling event by clicking the "Update" icon on the upper right of the interface.

If an update is detected the Web Client will silently refresh the visible data on your screen. The exception is if the data being updated is at risk of conflict due to an ongoing edit. If you are editing a task that simultaneously receives an update, a conflict notification message will appear at the bottom of the editor. It is up to you to decide whether to ignore the message and continue editing or close and re-open the editor to obtain the latest updates. If you save your changes after receiving an update notification, your changes will over-write the previous changes that were made. ScrumWorks will not over-write data in an open editor automatically.

All actions taken by Web Client users are immediately saved to the ScrumWorks Pro Server.

» top

Selecting the Sprints view
Once authenticated, the Sprints view is always accessible by clicking the "Sprints" navigation option in the page header.

» top

Select a Product

The "Sprints" view of the Web Client is a sprint centric view; it shows information relating to a specific sprint as selected by the user. The first step to selecting a sprint, however, is selecting the Product to which the Sprint belongs. Note, the list will contain those products for which the user has access.

To select a Product:

  1. Locate the Product selection menu located directly below the page header on the left hand side. Click the currently selected product name or the drop-down icon to activate the menu
  2. The Product selection menu places your recently opened products on the left side of the menu, while a list of all available products is on the right side.
  3. Select a product by clicking the product name. The page will refresh with the new product context. Note that this product context persists through the current and future sessions until it is changed again.
  4. To cancel a product selection, close the menu by clicking outside of the menu area.

» top

Select a Sprint

The "Sprint" view of the ScrumWorks Pro Web Client is a team member centric view; it shows information relating to a specific Sprint as selected by the user.

Required Permission: View Task.

To select a sprint:

  1. First make sure the correct Product has been selected.
  2. Select the appropriate team from the drop-down menu labeled "Team" located under the Product selector.
  3. Select the desired sprint from the drop-down menu labeled "Sprint". Sprints are listed in reverse chronological order. The page will reload immediately upon selection.
ScrumWorks Pro will remember the last Sprint you selected in the current and future sessions.

» top

Task Board Overview

The "Sprints" view of the ScrumWorks Pro Web Client provides a "task board" interface for selected sprints. Task boards are used at the team level to track the progress of product backlog items and tasks in sprints. The task board arrays all defined sprint tasks into status columns, indicating the overall progress of the sprint spatially.

Each row of the task board represents a product backlog item that has been committed to the sprint. The product backlog items are displayed in the far left column. Tasks related to each product backlog item are displayed in the appropriate task status columns to the right.

Changing the status of a task is as easy as dragging it from one column to the next. Task order within each status column can also be maintained via drag and drop.

» top

Task Board Layout Description

The task board is designed to be used as you would index cards laid out on a table or pinned up on a wall. Each row represents a product backlog item and its associated tasks. The product backlog item title and description are displayed in the far left-hand column. Each of the product backlog item's tasks are displayed as individual cards, ordered within the status column that applies to each task. The header of each column lists the status and the number of tasks in that column.

  • Product backlog items - Each product backlog item displays the Key, Title, Description, Effort Estimate, Comment count, and Done indicator.
  • Tasks - Each task card widget displays the Task Title, Point Person, and Estimate Hours remaining.

» top

Customizing the Task Board Display

The task board may be customized in the following way:

  • Highlight Tasks for Team Members - When selecting team members from the dropdown list, any tasks assigned to the selected team members will be highlighted with the corresponding color. "Unspecified" tasks may also be highlighted to aid finding tasks that are not yet claimed by any team members.

» top

Add Tasks

New tasks may be added from the Web Client.

Required Permission: Create, Edit, Delete Task.

To add a new task:
  1. Find the product backlog item to which you wish to add a new task in the left most column.
  2. Click the "add task" link located directly under the product backlog items' title. The "Add Task" dialog will open.
  3. The "Task Title" field is required while the "Task Description", "Point Person", "Status", "Team Hours Remaining", and "Hours Spent Today" fields are optional.
  4. A comment may also be included during the create operation.
  5. The dialog may be resized to provide more room for the description field by dragging the edges or corners with the mouse. Note that there is a minimum dialog size as well
  6. Multiple "Add Task" dialogs can be opened simultaneously, and the newest dialog will always be ordered on top.
  7. Click "Save" to complete the add operation or click the cancel button to close and abort any changes.

When saved, the new task appears in the respective status column that was selected by the user, and "Not Started" by default.

Note: When task estimates are used, the first estimate entered and saved is displayed in the Original Estimate field. This figure is used in the desktop client to populate the Task Estimates vs. Actuals report, which is available when the Timesheets feature is enabled in Product Properties.

» top

Edit Tasks

Required Permission: Create, Edit, Delete Task.

Tasks may be edited from the Web Client:
  1. Click the task title as it appears in the task board.
  2. The Edit Task dialog will appear populated with the current task information. Note, the unedited Task title is represented in the header of the dialog.
  3. Edit the "Task Title" (required), "Task Description", "Point Person", "Status", "Hours Remaining", or "Hours Spent Today" as desired.
  4. A single new comment may be set during an edit operation.
  5. Click "Save" or click the cancel button to close and abort any changes.

When saved, the task may change appearance or location in the task board to reflect the edit. For example, if the status was changed, the task will move to the respective status column.

If the point person was edited to the current user, then the task color may change to match the rest of the user's tasks depending on highlight preferences. While your changes are being saved, the task will will be grayed out, and cannot be moved or opened for edit. Once this operation has completed, the task will again be available for changes.

» top

Task Comments

Users can add new comments to tasks during an "Add" or "Edit" operation. Once comments are added, they are visible in the Comments section of the "Edit Task" dialog. By default, the "Comments" section of the "Edit Task" dialog is closed, but shows the total comment count in collapsed form.

Required Permission: Create, Edit, Delete Task.

To view or add new comments
  1. Open the Edit Task dialog
  2. Click the "Comments" section. Note that it will expand to provide visibility into existing comments. Use the scroll bar to read through the comments
  3. To add new comment focus the mouse into the "Enter your comment" field. Type your comment and when finished click "Save" at the bottom right of the dialog.
Comment considerations and limitations
  • Comments are listed in reverse chronological order with the most recent comment at the top.
  • Each comment includes the user that entered the comment and the time the comment was created on the server.
  • Any URLs typed into comments will be available as a link in the posted comment.
  • A single comment is limited to 32767 characters. Any HTML will be escaped and displayed as entered.

» top

Changing Task Status

In the task board, tasks are displayed in columns according to the task status ("Not Started", "Impeded", "In Progress", or "Done"). For example, all tasks that have not yet been started are listed in the "Not Started" column.

Required Permission: Create, Edit, Delete Task.

There are two ways to change task status:

Drag-and-drop method
  1. To change the status of a task, simply drag it into the appropriate status column.
  2. Task status is updated as soon as its dropped into the status column. Status changes made in the Web Client are immediately saved to the database and will shortly reflect in all other clients, including the Desktop Client.
  3. While your changes are being saved, the task will will be grayed out, and cannot be moved or opened for edit. Once this operation has completed, the task will again be available for changes.
Edit Task method
  1. First, open the task's Edit Task dialog.
  2. Choose the desired status in the "Status" drop-down menu and click "Save".
  3. The task now appears in the respective Status column on the task board.

» top

Ranking Tasks

When any one column for a single product backlog item contains more than one task, those tasks can be individually ranked within that status column. This rank is independent of the rank in the Desktop Client. Ranking tasks within the status columns on the Web Client will be maintained within the Web Client only, it will not effect the ranking in the Desktop Client.

Required Permission: Create, Edit, Delete Task.

  • To rank a task within a status column, drag it vertically within the same status column into a new rank position.

» top

Moving Tasks between Backlog Items

Tasks can be moved between product backlog items. To move a task from one product backlog item to another:

Required Permission: Create, Edit, Delete Task.

  • Drag the task from its existing product backlog item and drop it into a status column of the product backlog item to which you want this task to belong.

» top

Volunteer as Point Person

Team members can volunteer as point person on tasks in the Web Client. Being a member of the team corresponding to the selected Sprint is a requirement. When a Team Member decides that she would like to make herself the point person on unassigned tasks or tasks currently associated to another point person, there are two methods to achieve this goal through the Web Client:

Required Permission: Create, Edit, Delete Task.

Edit Task Method:
  1. Make sure you are a member of the team corresponding to the selected Sprint.
  2. Open the Task's Edit Task dialog.
  3. Choose the desired user in the "Point Person" drop-down menu. Click "Save".
  4. The task now displays the new Point Person's name in the task board.
Start Task Method:
  1. Make sure you are a member of the Team corresponding to the selected Sprint.
  2. Find a task with an "unspecified" point person and drag this task into the "In Progress" column.
  3. Your name will automatically be associated as point person.

» top

Update Timesheet Entry

Users can update the time spent on individual tasks through the Web Client using the Edit Task dialog.

Required Permission: Create, Edit, Delete Task.

  1. Open the task's Edit Task dialog. Time can be tracked against any task, not just those tasks for which the user in question is the "Point Person". This is useful in cases of pair programming or collaboration.
  2. In the field labeled "Hours Spent Today" enter the total hours worked on the task during that day. Note that the time must be entered in U.S. format (e.g., 0.25 for 15 minutes). Commas or other decimal indicators cannot be used at this time.
  3. The current user's total hours spent for the given task is summarized in the field labeled "To Total Hours".
  4. Click "Save", or "Cancel" to abort.

Historical entries may only be edited using the Desktop Client's Timesheet screen.

» top

Delete Tasks

Tasks may be deleted from the Web Client through the Edit Task dialog. To delete a Task:

Required Permission: Create, Edit, Delete Task.

  1. Open the task's Edit Task dialog.
  2. Click the "Delete" button in the bottom left of the dialog.
  3. Confirm that you really wish to delete the task by clicking "Yes", or click "No" to abort the delete operation. There is no way to undo this operation.

» top

Marking Product Backlog Items done
Product backlog items can be marked "Done" within the task board. This is useful during sprint review meetings.
  1. Find the "done" checkbox located directly under the product backlog item title in the task board.
  2. If the checkbox is empty, click it to mark the product backlog item "done".

The user must have the "Mark product backlog item as Done" permission.

» top

Product Backlog Item Comments

Users can add new comments to backlog items during an "Add" or "Edit" operation. Once comments are added, they are visible in the Comments section of the backlog item dialog. By default, the "Comments" section of the dialog is closed, but shows the total comment count in collapsed form.

Comments are listed in reverse chronological order with the most recent comment at top. Each comment includes the user that entered the comment and the time the comment was created on the server.

To view or add new comments
  1. Open the backlog item or create a new backlog item
  2. Click the "Comments" section. Note that it will expand to provide visibility into existing comments. Use the scroll bar to read through the comments
  3. To add new comment focus the mouse into the "Enter your comment" field. Type your comment and when finished click "Save" at the bottom right of the dialog.
Comment considerations and limitations
  • Comments are listed in reverse chronological order with the most recent comment at the top.
  • Each comment includes the user that entered the comment and the time the comment was created on the server.
  • Any URLs typed into comments will be available as a link in the posted comment.
  • A single comment is limited to 32767 characters. Any HTML will be escaped and displayed as entered.

» top

Sprint Burndown Chart

The sprint burndown chart indicates the overall progress of the sprint. A "thumbnail" version of the sprint burndown chart is located at the top of task board, under the page header. Clicking the thumbnail will overlay the full sprint burndown chart on the task board. Both the thumbnail and full version are dynamically generated, so updating tasks will update the chart immediately.

Required Permission: View Task.

Sharing the sprint burndown chart
  1. Click the "thumbnail" to display the full sized burndown chart.
  2. Locate the chart's URL at the bottom of the overlay, under the chart.
  3. Select the text of the URL and copy. The copied URL may be shared with other ScrumWorks users via email, IM, etc. (authentication required).
Saving the sprint burndown as an image
  1. Click the "thumbnail" to display the full sized burndown chart.
  2. Right-click the image portion of the chart and select "Save image as...".
  3. Save to the desired location on your hard drive.
  4. The thumbnail image can also be saved using this method.

» top

Dashboard

The Dashboard view allows quick selection and viewing of your existing web reports for the selected product.

Selecting the Dashboard view
Once authenticated, the Dashboard view is always accessible by clicking the "Dashboard" navigation option in the page header.

» top

Select a Product

To select a Product:

  1. Locate the Product selection menu located directly below the page header on the left hand side. Click the currently selected product name or the drop-down icon to activate the menu.
  2. The Product selection menu places your recently opened products on the left side of the menu, while a list of all available products is on the right side.
  3. Select a product by clicking the product name. The page will refresh with the new product context. Note that this product context persists through the current and future sessions until it is changed again.
  4. To cancel a product selection, close the menu by clicking outside of the menu area.

» top

Select a Report

To select a Report:

  1. Locate the report selection menu located directly below the page header. Click the "Select report" prompt or the drop-down icon to activate the menu.
  2. The report selection menu lists all your web reports for the selected product. If you have no reports, the menu will be empty and you will be prompted to launch the desktop client to create one.
  3. Select a report by clicking the report name. The report will load without refreshing the page. You may also right click a report name to copy the report URL or open it in a new window or tab. Your selection is saved and will be automatically loaded the next time you open the Dashboard.
  4. To cancel report selection, close the menu by clicking outside of the menu area.
Note, you must use the desktop client to create a new web report.

» top

Full page item editor

The full page item editor allows you to edit all of the fields of a backlog item at once with out having to switch accordions or tabs as you would with the web client and desktop client.

Opening the full page editor

To open the full page editor:

  • Click on the item key link from the My Tasks, Sprints or Planning page.
  • Click on the item key from the item editor in the desktop client.
  • By going directly to the backlog item's URL: http://<hostname:port/your scrumworks path>/item/<item key>
Note that this mechanism provides a convenient and predictable way to share a single backlog item's contents (via email, IM, etc.).

Note: Editing fields in the full page item editor requires the appropriate permissions. However, any user with product access rights can view backlog items in this fashion.

» top

Documentation Home | Web Client User Guide | Support and Training | ScrumWorks Desktop Client
Copyright © 2011 CollabNet, Inc. All rights reserved.