Getting Started
Documentation Home
- General Precautions
- Prerequisites
- Client Installation
- License Activation
- Authentication
- New Product Creation Wizard
- Getting Started with Products
- Default Role for Team Members
- General Docking Frame Behavior
- Editors Frame Behavior
- Keyboard Navigation
- Contacting Support
- Create a new Product Backlog Item (PBI)
- Save/Close Product Backlog Items
- Delete Product Backlog Item
- Completing Product Backlog Items
- Prioritize Product Backlog Items
- Edit Product Backlog Items
- Edit Product Backlog Item Estimates
- Edit Product Backlog Item Estimate History
- Backlog Item Keys
- Attaching Files to Backlog Items
- Add Tasks to Product Backlog Items
- Add Tasks to an Open Product Backlog Item
- Prioritize Tasks
- Edit Tasks
- Move Tasks between Backlog Items
- Delete Tasks
- Copy/Paste Tasks
- Create New Sprint
- Sprint Exclusion Dates
- Adding Product Backlog Items to Sprints
- Edit Sprint Start Date, End Date, and Goals
- Delete an Empty Sprint
- Hide Historical Sprints
- Column Displays
- Backlog Effort Column
- Task Effort Column
- BW Column
- rBV Column
- ROI Column
- Description Field Editing and Syntax
- Collapsing Backlog Items
- Selecting Multiple Backlog Items and Tasks
- Find in the Product Backlog
- Creating Themes
- Applying Themes
- Editing and Merging Themes
- Removing Themes
- Deleting Themes
- Show and Hide Themes
- Highlight Themes
- Filter Themes
- Open the Sprint Detail Frame
- Add Sprint Tasks
- Edit Sprint Tasks
- Volunteer for Sprint Tasks
- Delete Sprint Tasks
- Mark Sprint Tasks as Done
- Update Sprint Task "Hours Remaining" (Estimated Time Remaining)
- Sprint Burndown and Team Member Load charts
- Filtering
- Sorting by Single and Multiple Column Entries
- Historical Task Estimation Data
- Revise Historical Task Estimates
- Re-size Sprint Frame Window Panels
- Timesheet
- Exporting ScrumWorks Pro data
- Importing into a new Product
- Importing into a Release
- Backing Up ScrumWorks Pro Data (Hypersonic database)
- Move Backlog Items/Tasks Between Products
- Downloading Data from Bugzilla 3.0
- Refreshing Data Downloaded from Bugzilla 3.0
- Editing Data Downloaded from Bugzilla 3.0
- Configuring JIRA v3.9 and above to work with ScrumWorks Pro
- Configuring ScrumWorks Pro to work with JIRA and Self-Signed SSL Certificates
- Downloading from JIRA v3.9 and above
- Refreshing Data Downloaded from JIRA v3.9 and above
- Editing Data Downloaded from JIRA v3.9 and above
- Known Issues with JIRA Downloads
- Creating a New Team (Product Admin only)
- Update a Team's name or Team Members (Product Admin only)
- Deleting a Team (Product Admin only)
- Associating Teams with Products
- Add Users (Global Administrators Only)
- Import Users from Spreadsheet (Global Administrators Only)
- Edit User Login Credentials (Global Administrators only)
- Delete Users (Global Administrators Only)
- Manage Logged-in Users (Global Administrators Only)
- Directory Server
- Switching Users between ScrumWorks and Directory Authentication (Global Administrators Only)
- Enabling or Disabling Product Roles and Permissions
- Granting Global Administrator access (Global Administrators)
- Granting Product Administrator or Roles to Users (Global Administrators and Product Administrators)
- Assign Roles to Multiple Users (Global Administrators and Product Administrators)
- Grant Program Access to Users (Global Administrators and Program Administrators)
- Enabling or Disabling Product Roles and Permissions
- Role Permissions
- Create Roles
- Edit Roles
- Delete Roles
- Overview
- Program Groups and Business Weighting
- Create Program
- Edit Program
- Open Program
- Delete Program
- Create Group
- Edit Group
- Re-organize Groups
- Delete Group
- Assign/Unassign Groups to Products
- Backlog Item Association
- Create new Backlog Item associated to this Group
- Edit Backlog Item
- Delete Backlog Item
- Edit Group Business Weight
- Program Business Value (pBV)
- Program Business Value (pBV) for associated Backlog Items
- Group ROI (gROI)
- Group ROI (gROI) for associated Backlog Items
- Column Displays
Getting Started
Although one ScrumWorks Pro Server permits multiple users, please be careful to avoid write conflicts when simultaneously editing a single Product. Although ScrumWorks Pro receives changes from the server with each request, you can use the Refresh function to manually update your screen if you suspect it's been altered (File > Refresh or the F5 shortcut key). The "Automated Refresh" feature available in the User Preferences (User menu) is recommended.
» top
-
Supported ScrumWorks Pro Desktop Client operating systems
are Windows XP, Windows Vista, Linux with the KDE window manager,
and Mac OS X 10.5.2+ (Leopard).
-
Supported Web Browsers are
Internet Explorer 6 and Internet Explorer 7, Mozilla/Firefox 2.0.x, or Safari 3.1.
-
The minimum hardware requirements are 128 MB of RAM and
150 MB of disk space.
-
Java Web Start (JNLP) is required to launch the ScrumWorks Pro
Desktop Client.
If you have the Java 6 or higher installed (also known as J2SE 1.6+),
Java Web Start is already
installed on your machine. To install Java Web Start, install
the latest JRE from Sun's web site:
http://java.com/en/download/index.jsp
-
Intranet/Internet connection for the duration of your
ScrumWorks Pro session. A broadband connection is
highly recommended for accessing ScrumWorks Pro
over the Internet/WAN.
- The Print to Cards feature requires a program capable of reading Adobe PDF 1.4, such as Adobe Acrobat Reader 5 or higher, or Preview in Mac OS X 10.5.2 or higher.
» top
The ScrumWorks Pro Desktop Client is a Java application that launches via Java Web Start. Java Web Start works by locally caching the application and obtaining updates from the server when available. All data access and storage is done on the server over a network connection, so you must stay connected to the intranet/internet during the course of your session.
-
Install Java 2: make sure the latest JRE (version 6 or above)or
Java SDK is installed on your computer.
-
Point your favorite internet browser to your
server's installation:
http://hostname:8080/scrumworks
where "hostname" should be replaced with the hostname or IP address of the server where the ScrumWorks Pro server-side component is installed.
-
A screen should present you with two boxes,
"ScrumWorks Pro Desktop Client" and "ScrumWorks Pro
Web Client". Click "Launch ScrumWorks Pro Desktop
Client" in the "ScrumWorks Pro Desktop Client"
box.
-
If your browser asks you whether to Save or
Open the file, choose "Open" file. At this
point, Java should begin loading.
- Java Web Start will launch, and ScrumWorks Pro will download and run. The first launch will take longer than subsequent launches. When the server installation of ScrumWorks Pro is updated, clients will automatically receive the updates on their next launch. Depending on your version of Java, the initial launch may indicate it is stalled. This is normal and the program should launch within a minute or two.
» top
Once you have obtained a license file, please follow the directions below to activate your ScrumWorks Pro software.
- Launch the ScrumWorks Pro Desktop Client application as described above.
- If you have not installed a valid license, a license entry dialog will appear when you first launch the ScrumWorks Desktop Client. 'Browse' for your license and click 'Save and Close' to continue with your new license.
- If your license is expired, only the Global Administrator will be able to log in to update the license.
» top
Once you have installed a valid license file, please follow these steps:
-
Launch the application as described above.
-
At the Login prompt, enter your login name and
password. Note, your login name is different
than your First and Last name. Your login name
and password is originally created by the
Global Administrator user using the User Manager. By
default, the Global Administrator's login name is
administratorwith passwordpassword.
- Click OK to continue, or Cancel to exit.
» top
At each step in the process, a Help tab gives explanations of information you will be asked for, and provides information on changing the settings once your Product has been created.
Note that if you cancel the Wizard at any time before clicking Finish, your settings will be lost, including any Teams or Users you have created as part of the setup process.
Once the Product is created, two things happen:
- Roles based on the standard role templates are created for the new Product
- The Product Backlog Window appears
If you do not wish to use the Create Product Wizard, a Product may alternatively be created using the File > New > Product menu option. Note, however, that this method skips all secondary steps like user, team, and role creation. For this reason, it is recommended that new users create Products using the wizard.
» top
-
Click the "File" menu, select "New", then "Product" from the drop down menu. (Only the
Global Administrator may create a new product.)
-
You will then be prompted for various product attributes in the Product Properties window.
-
Product Name: Enter any characters (including spaces) to uniquely identify the project.
-
Backlog Effort Units: Users can define any units for Backlog Items (hours, days, function points, etc.).
Scrum does not define a standard backlog effort unit. NOTE: your choice in this field can be
modified later through the "File" > "Product Properties" menu.
-
Business Weight (BW) Units: Users can define any units for Business Weight,
which is a calculation of a Backlog Item's importance to the Product and/or
business. Expressed as a whole number, it is calculated by adding Benefit
and Penalty values.
-
Enable Timesheets: Allows Users to enter hours spent on Tasks in the web
client, and enables the Timesheet tab of the Sprint Detail window in
the desktop client, which displays a historical record of all Team
members' hours spent per Task that sprint.
-
Roles & Permissions: Allows the Global Administrator to restrict access and use
based on
roles as defined by either the
Global or Product Administrator. Roles can be enabled or disabled on a Product by
Product basis.
Once enabled for a particular product, Product Administrators may set the default Role for Team members.
-
Once the Product is created, two things happen:
- Roles based on the standard role templates are created for the new Product
- The Product Backlog Window appears
Required Permissions: Global Administrator
Both the Global Administrator and Product Administrator may change the product properties by selecting File > Product Properties.
Users with access to the new Product can open the Product from the main menu: "File" > "Open Product".
» top
- A User is added to a Team that has been associated with the Product; or
- A Team is associated with a Product.
There are two ways to set a default Role for Team members:
- In the Create New Product Wizard, Step 7 offers a dropdown to select a Default Role for Team members. The recommended default is Team member [standard], but any available Role Template may be selected.
- In the File > Product Properties menu dialog, under the section Roles & Permissions, there is a dropdown for Default Role for Team members. The recommended default is Team member [standard], but any available Role Template may be selected.
» top
The Product Window acts as a container for dockable frames. "Docking" refers to the behavior by which frames adhere to (dock) or detach from (un-dock) the boundaries of the Product Window and other frames. Frames belong and may only dock to their parent Product Window; For example, the Sprints by Team frame belonging to Product A may not be docked into the window for Product B. To help users keep track of frames' parentage, the titlebar of each displays the name of the Product to which it belongs.
By default, a Product Window opens with the Sprints by Team and the Product Backlog frames docked to the Product Window, sharing the available space. As other frames are opened, they dock to default locations, and frames that were already open adjust to make room for the new frame. Locations, sizes, and relationships between frames are persistent within and between Product sessions; Users may re-arrange locations and relationships of frames, and these locations are remembered by the application so that frames, when restored, return to the location where they were last opened.
Because this high degree of flexibility allows a user to create a potentially confusing arrangement of the Product Window, the default layout of frames can be restored by selecting "View/Restore Default View" from the main menu.
Toggled states: Docked, Floating, and Minimized
Frames can be activated by opening item details within a Product/Program and by selecting tools from the main menu. While some frames are permanently visible, others can be closed using the "X" icon in frame titlebars. Once activated or opened, a docking frame's state and location is controlled primarily by icons at the upper right (Windows/Linux) or upper left (Mac) of each frame. Tooltips appear upon mouseover to describe each icon's action on the frame. The following frame states are available:
-
Docked: Docked frames may be moved within the Product Window and
docked to various locations within it. Drag a frame's titlebar to move it,
and an outline of the frame shows its location, snapping to locations it
may be docked as it is dragged near other frames and the borders of the
Product Window. In general, docked frames cannot be dragged into a floating
position. The exception to this rule is multi-tabbed frames, see below.
-
Floating: Frames and certain tabs may be undocked to floating frames
by either double-clicking the titlebar, or by clicking the "Toggle
Floating" icon in the titlebar. A floating frame cannot be dragged into
a docked position. To dock a floating frame, use the "dock" icon or double
click the frame title bar to restore frames that dock by default.
-
Minimized: A frame can be minimized to a tab by clicking the "pushpin" icon.
A docked frame will minimize that frame to a tab inside the Product Window.
Other frames open in the window will adjust to take up the space vacated by
the frame that was minimized. The minimized frame can be restored to it's
prior docked location by clicking the tab to which it was minimized.
Note, floating frames cannot be minimized directly
(they must first be docked).
Many frames contain tabs to separate information and allow comparison of like data sets. Some of these tabs may be undocked into floating windows or docked alongside other tabs' information.
In the Sprints by Team frame, for example, individual Team tabs may be toggled to floating frames so that Sprints for two or more Teams may be viewed concurrently. This is done by clicking and dragging a tab, or double-clicking that Team's titlebar. To dock a floating Team frame back into the Sprints by Team frame, click and drag the individual Team's frame or double-click its titlebar, and it will return to the parent frame as a tab.
The Editors frame is another multi-tabbed frame into which Backlog Items, Tasks, and Impediments open when they are opened from the backlog or impediments frames. Opening Backlog Items, Tasks, or Impediments opens a tab for each into the Editors frame. These individual tabs may be undocked into floating frames, but they cannot be docked individually alongside other docked Editors.
When a large number of frames share the Product Window, it may be difficult to find a space where a dragged frame does not want to snap to a border or another frame. Holding the CTRL button down when dragging a frame deactivates the snap-to docking feature so that the frame may be easily moved without snap-to docking suggestions.
» top
The Editors frame is a container into which Backlog Items, Groups, Tasks, and Impediments open from either backlog or the impediments frames. Opening Backlog Items, Groups, Tasks, or Impediments opens a tab for each into a parent "Editors" frame. These individual tabs may be undocked into floating frames, or docked back into the parent "Editors" frame. Individual editor tabs may not be docked apart from the parent "Editors" frame.
Using the controls at either the upper right (Windows) or upper left (Mac) corner, or by combinations of clicking and dragging the frame title bar, the Editors frame may be maximized to occupy the entire window; toggled to a floating frame; 'docked' back into the window; and minimized to a tab at the bottom of the window.
Next / Previous Navigation in Editors
When an Editor is opened from the Product Window, the row selection in the Sprints by Team or Product Backlog frames corresponds to the item displayed and selected in the Editor: Clicking on the "∧" (Previous) and "∨" (Next) buttons in the editor moves the row selector up or down while the Editor displays the information for each successive or preceding item. Row selection follows the type of item in focus in the Editors frame: When clicking the up or down buttons from a Backlog Item, row selection is moved to the previous or next Backlog Item. If the same buttons are being used from a Task Editor, row selection moves only between Tasks. To streamline editing while scrolling in this manner through multiple Backlog Items or Tasks, changes are saved automatically upon clicking the Next or Previous buttons. The Next/Previous buttons are absent on Impediments.
Keyboard shortcuts: CTRL + DOWN ARROW (Next), CTRL + UP ARROW (Previous)
Creating New Backlog Items
The "New" button adds a new tab of the same type to the Editors frame and focus moves to that tab so that information may be entered and saved. Information for new Tasks must be saved before the new Task appears below the last existing Task in the PBI.
Keyboard shortcuts: CTRL + N (New PBI), CTRL + T (New Task), CTRL + I (New Impediment)
» top
This information is also available as printable, tri-fold keymaps for Windows/Linux and Mac OS X
- General
- Menu bar
- Product Window
- Editors
| Windows | Mac | Action |
|---|---|---|
| CTRL+Q | CMD+Q | Close ScrumWorks Pro. |
| CTRL+W | CMD+W | Closes the current window. |
| ESC | ESC | Closes the current pop-up window or menu. Pop-up windows are dialogs with a cancel button. This action does not confirm changes, so be careful when using this key. |
| Windows | Mac | Action |
|---|---|---|
| ALT | OPT | Toggles the keyboard navigation for the main menu. |
| ALT+F | OPT+F | Opens the File menu. |
| ALT+E | OPT+E | Opens the Edit menu. |
| ALT+V | OPT+V | Opens the View menu. |
| ALT+U | OPT+U | Opens the User menu. |
| ALT+R | OPT+R | Opens the Reports menu. |
| ALT+T | OPT+T | Opens the Themes menu. |
| ALT+W | OPT+W | Opens the Window menu. |
| ALT+H | OPT+H | Opens the Help menu. |
| CTRL+O | CMD+O | Opens the product chooser window. |
| F5 | F5 | Refresh the current product. |
| CTRL+F | CMD+F | Opens Find. |
| ALT+N | OPT+N | Find the next incremental match. |
| ALT+P | OPT+P | Find the previous incremental match. |
| CTRL+U | CMD+U | Opens the user manager window. |
| CTRL+P | CMD+, | Opens the user preferences window. |
| CTRL+B | CMD+B | Opens the Product Burndown Charts and Sprint Change Report. |
| F1 | F1 | Opens the user guide in a browser. |
| Windows | Mac | Action |
|---|---|---|
| TAB | TAB | Toggles between the Sprint Backlog and Product Backlog. Focus returns to the last selection. |
| UP ARROW | UP ARROW | Scroll up one row within the Sprint or Product Backlog. |
| DOWN ARROW | DOWN ARROW | Scroll down one row within the Sprint or Product Backlog. |
| LEFT ARROW | LEFT ARROW | Expand the row selection. This option can be applied to a Release, Sprint, or Backlog Item. |
| RIGHT ARROW | RIGHT ARROW | Collapse the row selection. |
| ENTER | ENTER | Opens the item. For the Sprint row, this will open the Sprint Detail window. For a Release, Backlog Item, or Task row, this will open the corresponding editor. |
| PAGE UP | PAGE UP | Scroll up one page. |
| PAGE DOWN | PAGE DOWN | Scroll down one page. |
| HOME | HOME | Scroll to the top of the Backlog. |
| END | END | Scroll to the bottom of the Backlog. |
| CTRL+N | CMD+N | Opens a New Backlog Item editor. |
| CTRL+T | CMD+T | Opens a New Task editor. The Backlog Item drop down menu will be pre-populated with the current selected Backlog Item. The new task will be placed at the bottom of the tasks for the selected Backlog Item. |
| CTRL+C | CMD+C | Copy the current selected task(s). |
| CTRL+V | CMD+V | Paste the copied task(s) in the selected location. If the selected location is a Backlog Item, the task(s) will be pasted after the last task. If the location is a task, the copied task(s) will be pasted directly below the selected task. |
| ALT+ENTER | OPT+ENTER | Opens the context menu for the selected row. |
| DELETE | DELETE | Delete the currently select Product Backlog Item or Task. |
| CTRL+E | CMD+E | Switch focus to an open Editor. |
| Windows | Mac | Action |
|---|---|---|
| CTRL+E | CMD+E | Toggle focus between open Editors. |
| CTRL+Shift+E | CMD+Shift+E | Reverse direction of focus toggle between open Editors. |
| CTRL+R | CMD+R | Switch focus to "Sprints By Team" or "Product Backlog" from an Editor. |
| CTRL+L | CMD+L | Locate the current item on the window it was opened from. Not available in Impediment Editors. |
| CTRL+S | CMD+S | Save changes and keep Editor Open ("Apply" button) |
| ENTER/CTRL+ENTER | ENTER/CTRL+ENTER | Save changes and close Editor. |
| ESC | ESC | Close Editor in focus without saving ("Cancel" button) |
| CTRL+UP | CMD+UP | Open previous item in Backlog in place of currently open item (only in Editors where the Next/Previous buttons are available). |
| CTRL+DOWN | CMD+DOWN | Open next item in Backlog in place of currently open item (only in Editors where the Next/Previous buttons are available). |
| CTRL+N | CMD+N | Create new Backlog Item (only in Backlog Item Editors). |
| CTRL+ALT+N | CMD+ALT+N | Copy description text as a new Backlog Item. If description text is selected, only the selection will be copied. If no text is selected, the whole description is copied. |
| CTRL+T | CMD+T | Create new Task (only in Backlog Item and Task Editors). |
| CTRL+ALT+T | CMD+ALT+T | Copy Task description as a New Task. If description text is selected, only the selection will be copied. If no text is selected, the whole description is copied. |
| CTRL+I | CMD+I | Create new Impediment (only in Impediment Editors). |
» top
Some usage information about your ScrumWorks Desktop Client and Server will be submitted to the ScrumWorks Support website. The data collected is the same data shown in Help > About under the "Database counts" and "System properties" sections.
The only time the data can be used to identify your particular installation is if you choose to submit it to the ScrumWorks Support Team via the website. If you do not wish to have your usage/system information associated with your support request, uncheck the "Send System Information to Danube" checkbox on the website.
NOTE: on selecting this menu option, usage data is always submitted from your client to our server. This anonymous usage information is collected to better meet the needs of our customers.
» top
Managing Products
-
Recently Opened Products (most recent
first)
- Lists your five most recently opened products
-
All Products (alphabetically)
- Lists all Products in ScrumWorks Pro accessible by the user
-
Sprint(s)
- Shows the most recent Sprint(s) for the currently selected product
Selecting a product and clicking the "Open" button opens a Product Window for the product. ScrumWorks Pro lets users open more than one Product Window for the same product.
» top
Note, users can open the same Product many times. This configuration is valuable for moving Product Backlog Items large distances in the Product Backlog.
» top
» top
-
Select "Delete Current Product" from the File
menu.
-
Click "Yes" to confirm, or "No" to cancel the
deletion.
-
If you would like your database to be backed up first, select 'Yes', otherwise
click 'No' (default "Hypersonic" database only). 'Cancel' aborts the delete operation.
Backup the attachments by copying the following directory to your backup medium:
INSTALLDIR/server/scrumworks/data/attachments
- If the backup and deletion are successful, you will receive a success message. If not, an error message will appear.
» top
Product Window Overview
Using the controls at the upper right (Windows/Linux) or left (Mac) corner of each frame or by combinations of clicking and dragging the frame titlebars, each frame may be maximized to occupy the entire window; toggled to floating frames; 'docked' back into the window; and minimized to become tabs at the left or right sides of the window.
Keyboard shortcuts are available for navigating the Product Window.
For more on using the Sprints by Team frame, see Sprint Management.
For more information on docking behavior, see General Docking Behavior.
» top
For more on using the Product Backlog frame, see Product Backlog Items and Release Management.
» top
You have the following options for printing:
- Backlog Items with their Tasks
- Backlog Items only
- Tasks only
To print Backlog Items and/or Tasks:
- Select a set of Backlog Items or Tasks.
- Right-click the selection.
- Select the "Print to cards" option.
- In the "Print to cards options" dialog, select paper size and, if you're printing Backlog Items, whether to print those Backlog Items' Tasks as well.
- Clicking "Generate Printer-ready PDF" will open a "Save PDF file" dialog where you may select a file name and location for the printer-ready format.
- Once saved, open the file to print.
» top
Product Backlog Items
Required Permissions : Create Product Backlog Item
-
Select the window containing the product to receive the new PBI.
Click the "File" > "New" > "Backlog Item" menu item from the Product
Backlog window.
-
Right-click on a Release on the right pane,
and select the "Add new Backlog Item to this
Release" option from the context menu, to
create a PBI in the selected Release.
-
Right-click on a Sprint on the left pane, and
select the "Add new Backlog Item to this
Sprint" option from the context menu, to
create a PBI in the selected Sprint.
-
From the Product Backlog, Sprints by Team, or
a Backlog Item editor, use the shortcut CTRL + N on Windows or Cmd+N on Mac OS X.
- From a PBI editor, select some text from the description field, right click on it, and select "Split as New Backlog Item". The selected text will be copied into the description field of the new Product Backlog Item (keyboard shortcut: CTRL + ALT + N).
Basic Info tab:
-
Enter a Title (required).
-
See Description
Field Editing and Syntax for tips on
entering a description.
-
Enter the Estimated effort remaining in the
units specified for the product. Please note
that effort estimates must be whole numbers
(no decimals). The field may be left empty to
indicate an unestimated Backlog Item. They appear
with an estimate of "-" in the Product.
See Edit Product Backlog Item Estimates for more details about the various Backlog Item estimates.
-
When a Backlog Item is created using the "File"
menu or a Sprint's context menu, you can select
the Release associated with the Backlog Item.
When created using a Release's context menu,
the Backlog Item is automatically associated with
that Release.
Enter 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 measured relative to its Release, Product, and other Backlog Items.
See Earned Business Value (Business Weight) for more on these calculations.
Themes tab:
Themes can be applied directly in the Backlog Item Editor by selecting unapplied Themes and moving them over to the applied side using the button controls.
History tab:
The History tab allows users with proper permissions the ability to back-date historical PBI estimates.
» top
-
Save and Close: Click the "OK" button, or use keyboard shortcut: CTRL + ENTER
-
Save without Closing: Click the "Apply" button, or use keyboard shortcut: CTRL + S
- Exit without Saving: Click the "Cancel" button, or use keyboard shortcut: ESC
» top
Please consider carefully before deleting a PBI whether:
- the PBI has outlived its use but was historically meaningful in the project; or
-
the PBI was a mistake and effort estimate
history should not be tracked for this PBI in
metrics like the Product Burndown Chart.
For example, a user may create a "test" Backlog Item and assign it effort. The user then intends to delete the PBI because it was only a "test". In this case, the user probably wishes to permanently remove all effort estimation history in the delete operation.
As a counterexample, consider a PBI that was added by the Product Owner several sprints before the current sprint. Now, however, the Product Owner announces to the team that this PBI is no longer needed for the product because business conditions have changed. In "deleting" the PBI, the team probably wants to preserve the effort impact this PBI imparted on previous sprints because removing its history would skew historical metrics.
Required Permission : Delete Product Backlog Item
-
Right-click the PBI in question and choose
"Delete Backlog Item" from the drop down
menu.
- A dialog will ask the user whether to preserve the PBI's estimation history during this operation. Choosing "Yes" will preserve the history but remove the item from view; choosing "No" will permanently delete the item and all estimation history; choosing "Cancel" will abort the operation. Warning: this is an irreversible decision; once deleted, PBIs cannot be restored or undeleted.
» top
Required Permission : Mark Product Backlog Item as Done
Backlog Items can be marked "Done" in one of two ways:
-
Using the Backlog Item Editor:
-
Double-click the PBI in question to open
the edit dialog.
-
Check the box labeled "Done". Click
"OK" or "Apply" to save the change.
-
Double-click the PBI in question to open
the edit dialog.
-
Using the context menu:
-
Right-click on the Backlog Item to bring
up the context menu.
-
Click "Mark Backlog Item as done".
-
Right-click on the Backlog Item to bring
up the context menu.
Note: Product Backlog Items may only be finished as part of a Sprint, and as such cannot be marked "Done" unless associated to a Sprint. Product Backlog Items marked "Done" cannot be moved to the Product Backlog side of the Product; the "Done" flag must first be unchecked.
» top
-
To prioritize Backlog Item(s) select and drag them
to their desired location.
When you drop a single or group of Backlog Items into a Sprint or Release filtered by Theme, the Backlog Item(s) will be prioritized immediately below the item (i.e. Backlog Item, Sprint, or Release) above the drop indicator, displacing downward all other items whether or not they are visible.
-
Valid drop locations will be indicated by a horizontal
black line that demonstrates the drop location. The cursor
will change to a circle with a line through it (universal
"Do Not" symbol) if the drop location is invalid.
-
Release the mouse button at the desired drop location.
-
You may reprioritize a block of multiple
Backlog Items together. Click here for detailed
instructions.
-
You may move Backlog Items into another Product's
Product Backlog. The correct set of permissions must
be assigned to the user wanting to drag-and-drop
between Products. See Move
Backlog Items/Tasks Between Products for more
details.
It maybe cumbersome to move Backlog Items large distances in the Product Backlog via drag-and-drop. Instead, use the "Move to Release" feature documented in the Associate Backlog Items to Release section.
Required Permission : Prioritize Sprint/Product Backlog
» top
-
Double-click the PBI row in the Product
Backlog window. (Alternatively: press the ENTER
key or right-click
the PBI and then choose "Edit Backlog Item").
When opening a Product Backlog Item, a
tabbed editing frame appears, see
Editors Frame Behavior for more information.
- The Backlog Item Editor dialog will open. Make changes and save with "OK." (See Description Field Editing and Syntax for tips on entering a description.)
» top
Whatever your preference, ScrumWorks Pro allows you to specify your choice of backlog effort estimation unit when you create a product or change its properties. Note that Sprint Tasks are distinct from Product Backlog Items and Task effort remaining is always estimated in hours. As a result, ScrumWorks Pro will not sum task hours to equal backlog effort.
Required Permission : Estimate Product Backlog Item
-
Double-click the PBI row in the Product Window.
(Alternatively: press the ENTER
key or right-click
the PBI and then choose "Edit Backlog Item").
-
The Backlog Item Editor dialog will open. Click the tab labeled
"Estimates".
-
In the text entry box for "Effort" under the "Estimates"
subsection, add a value for the estimated Effort needed
to complete the PBI. The field may be left empty to
indicate an unestimated Backlog Item. They appear with
an estimate of "-" in the Product.
» top
-
Double-click the PBI row in the Product Backlog
window. (Alternatively: press the ENTER
key or right-click
the PBI and then choose "Edit Backlog Item").
-
The Backlog Item Editor dialog will open. Click the tab
labeled "History".
-
Add new entries using the text entry fields on
the left and pressing 'Add'. The estimate is added
to the table on the right ordered by date. No
duplicate dates are allowed.
-
To delete an entry, select a row in the
table. Right-click and select 'Delete'. Alternatively,
you can press the 'Delete' key on your keyboard
after selecting one or more rows.
-
To cancel editing, just press the 'Cancel' button.
No changes will be saved.
» top
The Key Prefix may be changed by a user with Global Administrator or Product Administrator permissions. When a Key Prefix is changed, all Backlog Items using that Prefix are updated.
To set or edit Backlog Item Key:
- Open File > Product Properties.
- For "Key Prefix", enter a string of characters (5 or fewer, no spaces, no dashes) that will allow quick identification of the Product.
» top
Files may be attached to Backlog Items for reference and illustration purposes. Files of any type may be uploaded, and multiple files may be attached to any Backlog Item. Multiple copies or versions of the same file may be uploaded to any Backlog Item.
On the Server, the uploaded files are stored in the "attachments" sub-directory of the ScrumWorks Pro Server data directory (INSTALLDIR/server/scrumworks/data).
The Attachments Tab
A file is attached to a Backlog Item in the Attachments tab of the editor for a Backlog Item. This tab displays a table listing all existing attachments by file name, date uploaded, the name of the person who attached the file, and the file size.
Attached files may be downloaded to a user's computer by selecting the row corresponding to each desired file and clicking the "Download" button. Similarly, files may be removed from the Backlog Item and deleted from the directory by selecting the row(s) and clicking the "Remove" button.
Adding Attachments to Backlog Items:
To attach a file:
- Open the Backlog Item editor and select the "Attachments" tab. Click the "Upload File" button in the bottom left corner. A new Backlog Item must be saved before you can upload attachments.
- In the resultant dialog titled "Attach File to Backlog Item",
a text box appears into which you may enter the path to the desired file;
or, click the "Browse" button to find the file using your operating system's
file-browsing interface.
Note: If the file-browsing interface is taking a long time to appear, you may need to upgrade to the latest version of Java on the client machine. This is caused by a known Java bug that is fixed in Sun's latest Java 1.6 update. - Multiple files may be uploaded simultaneously by clicking the "Add another file" button at the bottom of the "Attach File to Backlog Item" dialog. A new file line item will be added to the upload queue. To remove any file from the upload queue, click the "Remove" button next to the file listed. The entry will be removed from the listing of files to be uploaded.
- To begin uploading the queued files, click the "Upload files" button. A "Please wait..." message appears as the files are being uploaded. When the upload is complete, a notification appears listing the files that were successfully attached.
- Clicking the "Cancel" button during upload will abort the attachment of any files not yet uploaded. A message will appear notifying you which files have been attached successfully, and which file uploads were aborted due to the cancellation.
Opening Attachments (Windows and Mac Clients only)
To open a file on Windows and Mac Clients:
- Double-click the row of an attachment you would like to open
- The file is downloaded and automatically opened by the corresponding application based on the Operating System file extension association.
- If there is no application associated with the attachment's file extension, the file Explorer on Windows or the Finder on Mac will be launched and the downloaded attachment file will be selected.
To download a file:
- Open the Backlog Item editor and select the "Attachments" tab.
- Select the row for each attachment that you would like to download.
- Click the "Download" button to begin downloading every selected file.
A "Please wait..." message appears while the files are being downloaded.
When the download is complete, a notification appears listing the directory
the files were saved to and the files that were successfully downloaded.
The confirmation dialog will list all of the files that were not successfully downloaded with its corresponding error.
If the filename already exists in the directory, the downloaded file will have a number appended to its filename.
Remove Attachments:
To remove an attachment:
- Open the Backlog Item editor and select the "Attachments" tab.
- Select the row for each attachment that you would like to remove.
- Click on the "Remove" button. A confirmation dialog listing all proposed attachment removals will be displayed. To continue attachment removal, click the "Yes" button. Upon confirmation, the attachment(s) will be removed from the ScrumWork Pro data directory
There is no version management for attached files; that is, duplicate files may be attached indiscriminately, or intentionally. If duplicate files are attached intentionally, say, to maintain a record of changes to an attached document over time, the "Uploaded" column displaying the date and time files have been uploaded may be used to track versions of files using the same name.
» top
Task Management
Note, Danube Technologies encourages splitting a task into several if the estimate exceeds 12 hours.
Required Permissions : View Task
-
Right-click the PBI in question and choose
"Add New Task for this Backlog Item" from the
drop down menu. (Alternatively: use the shortcut
CTRL+T after selecting a PBI)
-
The Task editor dialog will open as a tabbed frame, see
Editors Frame Behavior
for more information.
-
Enter the
Task Title, Task Description (See Description Field Editing
and Syntax for tips on entering a
description), the
Point Person and Estimated Hours remaining for
the task. The associated product Backlog Item
will be pre-selected based on the context from
which the task was created but may be changed at
this time.
Note: you can use the Task Description field to list any specific "definition of done".
- Click OK to save, or Cancel to abort.
» top
-
Press Ctrl + T (or Cmd+T on Mac OS X) to create a task belonging to that Backlog Item.
- Select text from the description field, right click it, and select "Split as New Task" (Keyboard Shortcut: CTRL + ALT + T). The selected text will be copied to the new Task's description.
» top
Required Permissions : Create, Edit, Delete Task
-
To prioritize a Task ahead of another Task,
left-click and drag the Task staying within
the confines of the current Product Backlog
Item. To move a task from the current Backlog
Item to another Backlog Item, drag the task
outside of the confines of the current Backlog
Item and into the confines of the target
Backlog Item.
-
The cursor will change when dragging. The
outline of a box will appear in places where
the Task can safely be dropped. The position
of the drop will be indicated by a horizontal
black line that demonstrates the drop
target.
-
The cursor will change to a circle with a line
through it (no smoking) if the drop target is
invalid.
-
Release the mouse button when the valid drop
target indicates the desired priority.
» top
-
Double-click the Sprint task row in question
in the Product Window. (Alternatively: press the ENTER
key after selecting the task). The Task editor dialog will
open as a tabbed frame, see
Editors Frame Behavior
for more information.
- Edit as desired and click OK or Apply to save or Cancel to discard changes. See Description Field Editing and Syntax for tips on entering a description.
» top
-
Select one or more Tasks and
drag them to your desired location.
-
The cursor will change when dragging. The
outline of a box will appear in places where
the Task(s) can be dropped. The position of
the drop will be indicated by a horizontal
black line that demonstrates the drop
target.
Note that Tasks can also be moved between Backlog Items across Products.
-
The cursor will change to a circle with a line
through it (no smoking) if the drop target is
invalid.
-
Release the mouse button when the valid drop
target indicates the desired priority.
- You may only move Tasks into another Product with the correct set of permissions. See Move Backlog Items/Tasks Between Products for more details.
» top
-
Select one or more Tasks.
-
Right-click one of the selected Tasks and choose
"Delete Task(s)" from the menu.
- A dialog will ask you to confirm the action. Warning: this is an irreversible decision; once deleted, Tasks cannot be restored or undeleted.
» top
Required Permissions : Create, Edit, Delete Task
-
Select the Tasks you want to copy in either the Product Backlog or
the Sprints by Team frame.
-
Right-click on any of the selected Tasks and choose
"Copy Task(s)" from the menu (keyboard shortcut: CTRL + C).
The following attributes of the selected Tasks will be copied: title, description and the most recent estimate.
-
Select a Product Backlog Item or a Task as the
target of the copy. Right-click on the selected
target and choose "Paste Task(s)" from the menu
(keyboard shortcut: CTRL + V).
If the target is a Product Backlog Item, the copies of the Tasks will be added at the bottom of the PBI's Task list. If the target is a Task, the copies will be added right below it.
- Notes: copied tasks can be pasted multiple times. Tasks can be copied across multiple backlog items with multi-select. It is also permissable to copy Tasks between two Products. To do that, the user has to have the required Permissions in both Products.
» top
Sprint Management
The Sprint follows a one-day Sprint Planning Meeting. Many Daily Scrum Meetings occur during the Sprint (one per day). At the end of the Sprint we have a Sprint Review Meeting, followed by a Sprint Retrospective Meeting.
According to Scrum rules, the team must not be interrupted with additional requests after a Sprint has been negotiated and started. Guaranteeing the team won't be interrupted allows it to make real commitments it can be expected to keep.
-
Click the "File" > "New" > "Sprint" menu item from the Product
Backlog window.
-
A dialog will open asking for the start and
finish dates for the sprint (you can change
these later if you need to). Please note the
currently acceptable date format is mm/dd/yyyy
if you are in the USA (server locale is
en_US). Elsewhere, the acceptable date format
is dd/mm/yyyy.
-
You may edit the excluded days of the Sprint by clicking
on the calendar icon after entering valid start and finish
dates for the Sprint. For more information regarding
Sprint exclusion dates, see
Sprint Exclusion Dates.
-
Sprints can be named. Provide a text string
name that will appear next to the Sprint dates
in the Sprint header row.
-
Sprint Goals can be written in free-text
format. Your text will be parsed and bullet
points added where carriage returns exist.
Edit the default text as desired. See Description Field Editing
and Syntax for tips on entering goals.
-
Sprints are not explicitly associated with Releases,
instead Backlog Items preserve their Release associations when
they are committed to a Sprint. This change was
made to enable the ability to work on multiple Releases
in a Sprint.
-
Team: select a team which will be responsible
for completing the work added to this Sprint.
The Sprint pane is grouped into tabs by
teams, simplifying work management for a single team.
When multiple teams have been associated with the same
product, each team's Sprints can be located under the
respective team tab.
Please read more about teams here.
-
Note: The list of teams displayed is limited to those teams
that have been associated with the Product. If you
encounter an error indicating that no Teams have been
associated with the Product, please following the instructions
in Adding a Team to a Product
to associate one or more Teams with the product.
-
Click "OK" to save the Sprint.
A red colored row will appear in the Sprint side of the in the Product Window under the associated team's tab representing the new Sprint.
» top
Required Permissions: Create, Edit, Delete Sprints
To edit the exclusion dates:
- Create a new Sprint from the main menu, or edit an existing
Sprint by right-clicking the Sprint row.
- In the new or edit Sprint dialog, click on the Excluded Days calendar
icon, to the right of the From/To Dates dropdown boxes. Valid start and
finish dates must be entered for the Sprint in order to reach the exclusion
date calendar.
- Select the days you would like excluded from the Sprint.
- Click "Close" on the exclusion calendar to return to the Sprint editor.
- Click "OK" to save all of your changes to the Sprint.
» top
Product Backlog Items can be added to Sprints in two ways:
-
Drag-and-drop:
-
To move an existing PBI into a sprint,
drag-and-drop the PBI in question onto the
bottom half of the sprint header row in question
(or above/below any PBI that
is already a part of the Sprint).
-
Release the PBI to add it to the
Sprint.
- You may move multiple PBIs into a sprint. Click here to learn more about multi-selection of items in ScrumWorks Pro.
-
To move an existing PBI into a sprint,
drag-and-drop the PBI in question onto the
bottom half of the sprint header row in question
(or above/below any PBI that
is already a part of the Sprint).
-
Context menu:
-
Right-click on the Sprint header row
you would like the Backlog Item to
belong to.
- Select "Add new Backlog Item to this sprint". Save the new Backlog Item and it will be added at the top of the Sprint.
-
Right-click on the Sprint header row
you would like the Backlog Item to
belong to.
» top
-
Right-click the Sprint row in question in the
Product Window.
-
Choose "Edit Sprint" from the drop down
menu.
- Edit in the dialog window as desired, click "OK" to save, or "Cancel" to discard changes. See Description Field Editing and Syntax for tips on entering goals.
» top
Required Permissions : Create, Edit, Delete Sprints
-
Move any Backlog Items out of the sprint using
drag-and-drop, or delete them using the context
menu.
-
Right-click the sprint row and select "Delete
Sprint" from the context menu.
- Click "Yes" to confirm, or "No" to cancel the deletion.
» top
-
From the "View" menu, select "Past Sprints".
- Select the number of historical Sprints to be made visible.
» top
Release Management
"The product is released to customer or marketplace obligations. The release balances functionality, cost, and quality requirements against date commitments." (Schwaber/Beedle, Agile Software Development with Scrum, p. 80)
ScrumWorks Pro allows you to define releases and group Backlog Items into them. Releases are designated in the Product Backlog by dark blue rows in the main Product Window.
A Release in ScrumWorks Pro can have dates/schedules associated with it. Alternatively, a "Release" can be used without dates to imply a free-form sub-grouping of the Product Backlog. Releases without schedules implied will not show up in progress reports.
-
Click "File" > "New" > "Release".
-
A dialog will open asking for Release name.
Optionally, you can also enter a Release start and end date.
These are used for reporting purposes.
Press OK, or cancel to abort.
- The Release will be represented as a blue row in the Product Backlog frame of the Product Window.
» top
There are three ways to associate PBIs with releases:
-
Drag-and-Drop Existing Backlog Items:
-
Users may move multiple, existing PBIs
from one Release into another via drag-and-drop. Alternatively,
PBIs can be moved out of a Sprint and into a Release on the
Product Backlog. Click here for
detailed instructions on multi-selection.
-
Users may move multiple, existing PBIs
from one Release into another via drag-and-drop. Alternatively,
PBIs can be moved out of a Sprint and into a Release on the
Product Backlog. Click here for
detailed instructions on multi-selection.
-
"Move to Release" right-click menu:
-
In the Product Backlog, right-click the Backlog Item(s) and
mouse-over the "Move to Release" menu option.
-
The Backlog Item(s) will move to the bottom of the selected
release and can be prioritized as desired using drag-and-drop.
The User's focus in the Product Backlog will scroll to indicate
the position of the moved Backlog Item(s).
-
The Backlog Item(s) will move to the bottom of the selected
release and can be prioritized as desired using drag-and-drop.
The User's focus in the Product Backlog will scroll to indicate
the position of the moved Backlog Item(s).
-
In the Product Backlog, right-click the Backlog Item(s) and
mouse-over the "Move to Release" menu option.
-
Backlog Item Editor (only for PBIs in Sprints):
-
If a Backlog Item is in a Sprint, the associated Release
can be modified from the editor.
-
Open the Backlog Item for editing.
-
Change the Release field as desired and save to commit
the change.
-
If a Backlog Item is in a Sprint, the associated Release
can be modified from the editor.
» top
Required Permissions : Create, Edit, Delete Releases
-
Move any Backlog Items out of the
Release using drag-and-drop, re-associate PBIs
to other Releases via the Editor, or delete them
using the right-click context menus.
-
Right-click the release row and select "Delete
Release" from the context menu.
- Click "Yes" to confirm, or "No" to cancel the deletion.
» top
Using and Customizing the Product Window
-
The Product Window uses a configurable docking
framework that allows frames to be rearranged, minimized,
or removed from view entirely. Please see the
General Docking
Behavior section for detailed instructions on docking
behavior.
-
Columns displayed may be set and ordered
separately for the Sprints by Team and Product
Backlog frames.
-
Under the View main menu, select Column Settings.
The dialog is divided into left and right halves
corresponding to the Columns displayed in the
Sprints by Team and Product Backlog frames of the Backlog
Planner Window, respectively.
-
Select the checkboxes that correspond to columns
you wish to be displayed, and deselect checkboxes
for columns you'd like hidden. The two always-on
columns are Committed Backlog Items/Tasks and
Uncommitted Backlog Items/Tasks. These columns
may be ordered, but may not be hidden.
-
Set the order in which columns appear in the
Sprints by Team and Product Backlog panes by selecting a
column name and using the "Move up" and "Move
down" buttons. Columns whose checkboxes are
unchecked may still be ordered in this way, but
will not appear in the Product Window until their
checkboxes are checked.
-
The default columns displayed and their default
order may be reset by clicking the Restore
Defaults button.
- Dragging/Dropping Column location: Once activated, Columns may be repositioned within their respective panes of the Product Window by dragging and dropping individual columns. Any settings made by dragging and dropping will be reflected in the Column Settings window, and may be overridden by subsequent changes to the Column Settings window.
» top
» top
Required Permissions : View Task
» top
Required Permissions : View Business Weight
» top
Required Permissions : View Business Weight
» top
Required Permissions : View Business Weight
» top
Hypertext links can be added to description fields simply by entering a URL. For example:
- http://danube.com
- mailto:name@company.com
- file:///c:/My%20Documents/MyFile.txt
- ftp://ftpserver.com/
- http://www.google.com/search?q=scrumworks
» top
To collapse a Sprint, Release, or Backlog Item, click the '-' (minus) icon next to the title. To expand the item, click the '+' (plus) icon.
Alternatively, use the LEFT ARROW and RIGHT ARROW to collapse and expand respectively Sprint, Release, and Backlog Item rows.
When a Backlog Item is collapsed, the sum of its tasks' hours will appear in the 'Task Hours' column.
The list of items you have collapsed is stored on the server. The next time you open the product, the Sprints, Releases, and Backlog Items you collapsed in the last session will still be collapsed. Each user's preferences are stored separately so you don't have to worry about having your changes stepped on.
» top
Multiple Tasks may also be selected and moved between PBIs.
You may select a set of adjacent Backlog Items or Tasks, or noncontiguous groups:
-
To select a set of adjacent Backlog Items or Tasks,
single click on a Backlog Item or Task with the left
button. Then move the mouse cursor over the last
Backlog Item or Task to be selected, and while holding down
the <Shift> key, left click the
target Backlog Item or Task. ScrumWorks Pro will highlight all the
Backlog Items or Tasks from the first one selected
through the last.
-
To select noncontiguous Backlog Items, single
click on the first Backlog Item with the left
mouse button. Then move the mouse cursor over the next
Backlog Item to be selected, and while holding
down the CTRL/COMMAND key, left mouse click
the target Backlog Item or Task.
Repeat the last step for each Backlog
Item to be selected.
- You may remove Backlog Items from the selection by moving the mouse cursor over a selected Backlog Item, holding the CTRL/COMMAND key, and the left mouse clicking the target Backlog Item or Task.
» top
Use the Find bar at the bottom of the screen to find any item in the product backlog which contains the search term entered in its title. The Find function is limited to searching PBI and Task titles only.
Users can navigate through the results using the "Next" and "Previous" buttons, or the following shortcut keys:
-
Next result: ALT+N
-
Previous result:
ALT+P
When done, you can close the Find dialog using the red X button on the bottom left (shortcuts: ALT+C, Esc).
» top
User Properties
If your organization uses a directory server to manage login information, these fields will be disabled.
» top
-
From the View menu, select "Refresh".
Alternatively, use the shortcut key: F5.
- Any changes on the server will be updated on the Product Window.
-
Either by selecting the option "Automatically
refresh" on the warning dialog
- Or from the preferences menu ("User" > "User Preferences" > "Preferences").
» top
Once the mail server has been configured, users may set notification preferences:
- In the main menu, select User/User Preferences. Click the Notifications section in the left-hand column.
- Enter the e-mail address at which you wish to receive notifications.
- In the section "Product Notifications and Settings", click "Add". In the resultant
"Add Product Notification" dialog, make selections in the following categories:
-
Select Product: Select the Product for which you'd like to receive notifications.
All Products to which the user has at least View Backlog Item or View Task access are
available for selection.
-
Notification Types: Select the types changes you'd like to be notified of -
Backlog Items and/or Tasks. For each notification type, a checkbox selection determines
whether descriptions are included in the change notification e-mails. Since descriptions
often contain a great deal of text, omitting descriptions can significantly reduce the
size of the notification e-mails.
When Task changes are selected, a choice is available to either receive notice of changes to all Teams' tasks, or to filter for changes to only specified Teams' Tasks. Only Teams associated with the Product are listed. If you choose to filter Tasks by Team, you will not receive notifications for Tasks associated with uncommitted Backlog Items.
-
Notification Period: Select that period at which you wish to receive notification of
changes - immediately when each change occurs, or a once-daily listing of all accumulated
changes.
-
Select Product: Select the Product for which you'd like to receive notifications.
All Products to which the user has at least View Backlog Item or View Task access are
available for selection.
- Click "OK". The notification is added to the list in the User Preferences screen.
- To save the listed notifications and their settings, click "Save and Close" or "Apply". To
remove a notification, select the row and click "Remove". To edit a notification, select
its row, click "Edit", and follow the above steps.
» top
Themes
Hierarchical categorization does not work well for Scrum Product Backlogs because all Product Backlog Items must ultimately be prioritized in a one-dimensional list. By nesting folders or hierarchies, the priority of individual items nested below the first level is obscured.
Themes can be used to filter and highlight the backlog for easy identification.
There is no right or wrong way to use themes in ScrumWorks Pro. You can use themes to identify feature sets, the source of backlog items, or just about any other reason you can think of. Themes can be a single word, many words, numbers, or characters.
There are three ways to create and apply themes to product backlog items:
-
Right click the Backlog Item to which you wish to apply a new Theme and
choose "Apply Themes". In the resultant dialog, click the "New" button
at bottom. In the New Theme dialog, enter a Theme name, then click "OK".
-
Select a product Backlog Item row in the Product Backlog Window. From the
Themes main menu, select "Apply Themes". In the resultant dialog, click the
"New" button at bottom. In the New Theme dialog, enter a Theme name, then
click "OK".
-
From the Themes main menu, select "Edit themes" and then "New Theme".
Enter a Theme name, then click "OK".
» top
Themes may be applied to Backlog Items in four ways:
-
Right click the product Backlog Item to which you wish to
apply a Theme. Choose "Apply Theme" and then select the Theme
you wish to apply.
- Select and right click the product Backlog Items to which you wish to apply Themes and choose "Apply Themes". In the resultant dialog, click the checkbox next to each Theme you wish to apply. If a Theme is already applied to all the selected Backlog Items, it will not appear in the list of Themes to apply. All Themes checked will be applied to all Backlog Items selected.
- Select the product Backlog Item row in the Product Backlog Window. From the Themes main menu, choose "Apply Themes". In the resultant dialog, click the checkbox next to each Theme you wish to apply. If a Theme is already applied to all the selected Backlog Items, it will not appear in the list of Themes to apply. All Themes checked will be applied to all Backlog Items selected.
- Open the Backlog Item for editing. Click the "Themes" tab at the top of the editor. Themes not yet applied to this Backlog Item are listed on the left. The right side contains Themes that are currently applied to this Backlog Item. To add a Theme, select one or multiple from the left list and click the right arrow button. To remove a Theme, select one or multiple from the right list and click the left arrow button.
» top
Themes can be edited (renamed) as follows:
-
From the Themes menu, select "Edit themes".
-
Select the theme you wish to alter and click the "Edit" button.
- Make the desired changes and click the "OK" button to save, or "Cancel" to abort.
» top
There are three ways to remove associations between Themes and product Backlog Items:
-
Select and Right click the product Backlog Items you wish to
disassociate from a Theme and choose "Remove Themes". In the
resultant dialog, Any Theme that has been associated with any
of the selected Backlog Items will be listed. Click the checkbox
next to each Theme you wish to remove from the product Backlog
Items, and click "OK".
-
Select the product Backlog Items you wish to disassociate from a
Theme in the Product Window. From the Themes menu, select
"Remove Themes". In the resultant dialog, Any Theme that has been
associated with any of the selected Backlog Items will be listed.
Click the checkbox next to each Theme you wish to remove from the
product Backlog Items, and click "OK".
-
Open the Backlog Item for editing. Click the "Themes" tab at the top of
the editor. Themes applied to this Backlog Item are listed on the
right. To remove a Theme, select one or multiple from the right list
and click the left arrow button.
- Deleting a Theme entirely will remove that Theme's association from product Backlog Items.
» top
Themes can be deleted entirely as follows:
-
From the Themes menu, select "Edit themes".
-
Select the theme you wish to delete and click the "Delete" button.
- Click "Yes" to confirm or "No" to cancel.
» top
-
From the Themes menu, uncheck "Show Themes" by selecting it.
-
To make Themes visible again:
From the Themes menu, check "Show Themes" by selecting it.
» top
-
From the Themes menu, select "Filter or Highlight...".
-
At the top of the resulting dialog, select "Highlight". Select the Themes you wish to highlight.
-
Select the Themes you wish to highlight, then click "OK".
There is a convenient way to highlight a Theme or group of Themes based on a selection of Backlog Items. Existing Themed Backlog Items can be used to quickly highlight all other Backlog Items containing the same Themes.
To Highlight Backlog Items like selected:
-
Select the product Backlog Items you wish to use the Themes from
and then Right click to choose the "Highlight Backlog Items like selected" menu item.
-
The system will obtain all of the Themes contained within your selected Backlog Items.
- All other Backlog Items that contain one or more of the selected Themes will become highlighted.
Remove highlighting:
- From the Themes menu, select "No Filter/Highlight".
» top
There are two primary filter modes. In the first, both the Sprint and Product Backlog sides of the Product Window are filtered. The second mode limits filtering to just the Product Backlog side of the window. When only the Product Backlog side is filtered, product backlog items may be moved from the Product Backlog to the Sprint side of the window.
To filter the product backlog for a particular theme:
-
From the Themes menu, select "Filter or Highlight...".
-
At the top of the resulting dialog, select either "Filter Sprints &
Product Backlog" or "Product Backlog only" as per your desire.
-
Select all Themes you wish to filter on, and click "OK" to apply the filter.
Remove filters:
-
From the Themes menu, select "No Filter/Highlight".
» top
The Sprint Detail Frame
» top
-
Once PBIs have been added to Sprints from the
Product Window, open the Sprint Detail
window by double-clicking the Sprint header
row and click the "New Task" button.
-
Alternatively, right-click the Backlog Item you
intend to create a Task for. Select "Add New Task
for this Backlog Item".
- Enter the Title, Description (note: this space can be used to list the "definition of done"), the point person, the status of the task, Estimated Hours remaining for the task, and choose the associated PBI.
» top
-
Double-click the Task title in question
in the Sprint Detail frame.
-
Alternatively, right-click the target Task and select "Edit".
- Edit as desired and click OK to save or Cancel to discard changes.
» top
-
Right-click the target Task and select "Take Task".
Required permission: Create/Edit/Delete Tasks
» top
Required permission: Create/Edit/Delete Tasks
» top
Note: Hours remaining will automatically change to zero.
Required permission: Create/Edit/Delete Tasks
» top
Either Edit Sprint Task as described above and modify the Estimated Hours Remaining field, or:
-
Select the Sprint task row in question in the
Sprint Detail frame.
-
Double-click into the "Hours Remaining" field. The
field is now editable. Update the estimated
hours remaining using whole number increments
(integers).
-
Click or tab out of the field to save. To
leave the field without saving changes hit the
"Esc" key before doing anything else.
While "Hours Remaining" is displayed as a single number per task, ScrumWorks Pro records all previous values and the dates modified. These changes are reflected in the sprint burndown chart.
» top
Sprint Burndown Chart
The Sprint Burndown graph plots daily changes in the total estimated Task hours remaining in the Sprint. As Task hours are revised, a line is drawn through each new day's data point. Note that this chart shows only data for one specific Product and Sprint, and expresses the aggregate estimated remaining hours for the Team as a whole.
Team Member Load Chart
The Team Member Load chart displays three figures for each member of the Team:
- The dark orange bars represent claimed
hours for the specific Sprint in focus
- The lighter bars represent the claimed hours for all other currently
ongoing Sprints on all Products
- The number above each user's bar totals the claimed hours among all
currently ongoing Sprints on all Products.
» top
- Click the dropdown icon in the column by which you want to filter. A checklist of all existing entries for that column appears in a dropdown list.
- Select the checkbox next to each entry for which you want to filter. Click the "OK" button at the bottom of the dropdown. Alternatively, if only a single filter option is desired, double-clicking that option will select it while at the same time deselecting all others.
- Repeat the process for each column by which you want to filter rows. As successive filters are added, the number of row listings will be reduced.
- To remove a filter for a column, click the dropdown icon in the column header and select the checkbox for "All".
NOTE: The dropdown for the Backlog/Task Title column lists and may only be filtered by Backlog Items.
» top
-
Click desired column once to sort
descending.
-
Click desired column a second time to sort
ascending.
-
Click desired column a third time to sort by
the default.
Default sort is by "Point Person Descending". You can sort by multiple columns by holding the CTRL/CMD key and clicking additional column headers. For example, first click on Point Person, then hold CTRL/CMD and click the Hours Left column to sub-sort by Hours Left.
» top
Required permission: Edit Historical Task Estimates
» top
- From the Sprint Detail frame, check "Show
Estimate History".
- Scroll horizontally and locate the date column and
respective task row to be altered.
- Double-click into the estimate field, even if blank.
The field will become editable. Make changes as desired.
- To save, press the Enter key, or click anywhere outside the edit field. Note, the Sprint Burndown Chart will change to reflect the estimate revision.
» top
» top
Timesheets can be enabled or disabled on a per Product basis. By default Timesheets are disabled for new Products and Products in upgraded installations. To enable Timesheets, check the "Enable Timesheets" checkbox in the "File">"Product Properties" dialog. See the Getting Started with Products section for more information.
Usage
The Timesheet tab on the Sprint Detail frame lets the Team Members view and edit the time they spent on the Tasks in the sprint.
Users can view the Timesheets of each Team Member, but can only edit their own. The Global Administrator and Product Administrators are allowed to edit each Team Member's Timesheet.
To edit a Timesheet entry for a Task and day, double-click on the table cell in the row of the Task and the column of the day to be edited. The time spent on a Task can be entered in hours as a non-negative decimal value.
The view also provides a summary of the total time spent on the Tasks by the entire Team. The summary can be viewed by selecting "All Team Members" in the "Show Hours for" selection box.
The Timesheets can be saved as an Excel document by clicking on the "Export" button. The document contains each Team Member's Timesheet as well as a summary.
Required Permission : View Task
» top
The Impediments Frame
-
Open the Impediments frame by clicking the "View Impediments" button at the top
of the Sprints by Team frame.
-
Click the "New Impediment" button. The Impediment editor dialog will
open as a tabbed frame, see
Editors Frame Behavior
for more information.
-
Enter a Summary, Detail, Reporter, and Entry Date.
See Description
Field Editing and Syntax for tips on entering
details.
- Click Apply or OK to save and close, or Cancel to discard.
» top
-
Open the Impediments frame.
-
Double-click the row corresponding to the impediment in question.
The Impediment editor dialog will
open as a floating tabbed frame, see
Editors Frame Behavior
for more information.
- Edit the text fields, or click the "Resolved" checkbox to indicate that the impediment is resolved.
» top
Earned Business Value (Business Weight)
ScrumWorks Pro implements this theory using "Business Weight". Business Weights represent a Product Backlog Item's business value index, a relative value used to compare the business value of PBIs.
Required Permissions : View Business Weight
Business Weight units are user defined and can be anything from real currencies (U.S. dollars, Euros, etc.) to relative point systems. The units are set in the Product Properties window as described in Getting Started with Products
ScrumWorks Pro calculates the Business Weight of a PBI by summing two user defined values: Benefit and Penalty.
Required Permission : Edit Business Weight
-
Double-click the PBI row in the Product Window.
(Alternatively: press the ENTER
key or right-click
the PBI and then choose "Edit Backlog Item").
-
The Backlog Item editor dialog will open. Click the tab labeled
"Business Weight".
-
In the text entry box for "Benefit (of inclusion in Product)"
under the "Estimates" subsection, add an assessment of the
PBI's benefit to the Product and/or business. This value
should be a whole number, and is expressed in units defined
for Business Weight (BW) in the Product Properties window
as described in Getting Started with
Products.
-
In the text entry box for "Penalty (of omission from Product)"
under the "Estimates" subsection, enter an assessment of the
penalty to the Product and/or business of not including or
completing the PBI. This value should be a whole number, and
is expressed in units defined for Business Weight (BW) in the
Product Properties window as described in
Getting Started with Products.
The numbers entered in the "Estimates" subsection contribute to the values in the "Calculations" subsection to the right.
- Business Weight (BW): A calculation of a Backlog Item's importance to the Product and/or business, determined by adding its Benefit and Penalty values (see below). BW is expressed as a whole number, in units defined by the Team and set in Product Properties.
» top
Release Business Value (rBV): A Backlog Item's Business Weight expressed as a percentage of the sum of all Business Weights per Release. rBV is expressed and displayed as a whole number percentage in the Backlog Item Editor and in the Product Window. It is calculated automatically by summing Business Weights in a Release.
» top
Return On Investment (ROI): This is a cost-benefit analysis involving Business Weights (benefit) and Backlog Effort Estimates (cost). It is an auto-calculated ratio of a given Backlog Item's Release Business Value divided by its Backlog Effort Percentage. This gives an ROI number that is 'normalized' by comparison with the other Backlog Items in a Release. It is expressed as a number to a user-specified precision (see the Product Properties), from a whole number to a real number up to two decimal places.
» top
Data Management
- The full product export format can be re-imported as a new product.
- Product Backlog Items and Tasks may be imported into
a specific Release.
- Task details can be exported on the Sprint Detail window.
Required Permissions : Export the Product
The resulting Excel document contains several worksheets that contain all of the information necessary to recreate a product, including estimate histories. This export does not include the files attached to Backlog Items. To retrieve attachments, they must be manually copied from the following directory: INSTALLDIR/server/scrumworks/data/attachments.
The following describes the full contents of the Product Excel Export file:
-
All Sprints
-
The Sprint Estimate history. This is the sum of task
estimates on the given day. This sum is used in
calculating Sprint burndown charts.
-
All Releases
-
All Backlog Items, in both Sprints and
the Product Backlog, including deleted (inactive) PBIs,
if estimate history was preserved on delete event.
-
The estimate history for each Backlog Item
-
Parent history for Backlog Items. This tells you
when PBIs were dragged between Releases and Sprints.
-
All data regarding attachments associated to Backlog Items.
-
All Tasks
-
The estimate history for each Task
-
Impediments, both resolved and open
In sheets where some columns are not the primary data source (such as PBIs listed in the 'Tasks' sheet), the columns use an Excel reference to point to the primary data source.
The export format includes several fields that are useful for creating reports or seeing the relationships between sheets. The same sheet can be used for importing into a new product. See Importing into a new Product for instructions on what can be safely modified.
» top
Steps:
- To import a new product based on the product export, click "File" > "Import" > "Into New Product...".
- To import a product with its attachments, manually copy the following directory and it's contents to the location: Copy from: {ScrumWorks server's install directory}\server\scrumworks\data\attachments\product{Product ID}
- Select the Excel file you would like to import and click 'Open'.
- Give the product a name different from other products in your system.
- If there are no errors, a 'Success' dialog is presented. If there are errors, you will be
presented with a dialog containing the following information:
- Sheet
- Cell
- The problem
Copy to: {Destination ScrumWorks server's install directory}\server\scrumworks\data\import-attachments
Permissions conflicts can arise between the operating system and ScrumWorks when manually copying the attachments directories and then accessing them via a Product import process in ScrumWorks. To avoid any such conflicts, make sure the owner of the import-attachments/productXXXX directory and all attachment files within that directory is the same user that is running the ScrumWorks server process.
Perform the export, import, and copy the attachments directory as close in time as possible to ensure that there is no additional data changes.
Once a Product has been imported with all its attachments, you may delete the product folder at {ScrumWorks server's install directory}\server\scrumworks\data\import-attachments. All attachments from this directory have been copied to the imported Product. For the exact name of the product folder, refer to the Product Info sheet of the product's Excel export file.
Attachment File Problems
If you receive a notice that not all attachments were imported, and you do not wish to continue with an incomplete set of attachments, you must delete the imported Product and repeat the export and import processes. To ensure that the import and export files are referencing the same attachments and data, follow the steps in the import process immediately after exporting the Product, without making any other changes in ScrumWorks between steps. Making changes to attachments or data in ScrumWorks between an export and an import process greatly increases the chances for corruption, synchronization problems, and missing files.
Formatting:
ScrumWorks Pro requires an imported Excel document to be formatted according to the guidelines below. The format matches that of the ScrumWorks Pro Product Excel Export to make it convenient to move products from one server installation to another using Product Export and Import.
Note: server versions must be identical when moving data between two servers using the Product Export/Import technique.
It is also important that the IDs of PBIs, Tasks, Sprints, and Releases be numeric fields that are unique among items of the same type.
The following worksheets are expected in the import format, along with the provided column names:
- Product Info:
- Product Name: used as a suggestion for the new Product's name. You cannot create two products with the same name.
- Key Prefix: REQUIRED - used as a suggestion for the new Product's key prefix for Backlog Items. This must be unique for each product.
- Backlog Item Effort: used as a suggestion for the new Product's effort units.
- Business Weight Units: used as a suggestion for the new Product's business weight units.
- Track Time Spent: REQUIRED (Yes/No) - setting for enabling/disabling tracking hours spent on tasks.
- ScrumWorks Pro Version: REQUIRED Only used to verify the version of the spreadsheet matches the version of the server. Don't change this field.
- Exporting User: The name of the user who did the export.
- Export Date: The date the export was created.
- Product ID: REQUIRED (Unique) - ScrumWorks generated value used to reference this Product.
- Releases:
- Row: Doesn't affect the import.
- Release Name: REQUIRED - The name of your Release.
- Active: REQUIRED (Yes/No) - ScrumWorks Pro doesn't delete Releases. It marks them inactive to keep an accurate record of work completed.
- Release Start Date: An optional field that marks the start of work on a Release. If you specify this, you must specify the end date.
- Release End Date: An optional field that marks the end of work on a Release date. If you specify this, you must specify the start date.
- Release ID: REQUIRED (Unique) - It is used to reference this Release in other sheets.
- Sprints:
- Sprint Name: An optional name of the Sprint.
- Goals: REQUIRED - The goals of the Sprint.
- Active: REQUIRED (Yes/No) - ScrumWorks Pro doesn't delete Sprints. It marks them inactive to keep an accurate record of work completed.
- Begin Date: REQUIRED - The starting date of the Sprint.
- End Date: REQUIRED - The ending date of the Sprint.
- Team Name: REQUIRED - The name of the team working on the Sprint. If the team does not exist within ScrumWorks Pro, it is created.
- Sprint ID: REQUIRED (Unique) - It is used to reference this Sprint in other sheets.
- Sprint Estimate History:
This is data the Sprint Burndown Charts are generated from.
- Sprint Name: An optional field that matches the name from the Sprints sheet.
- Sprint ID: REQUIRED - The ID of the Sprint from the Sprints sheet.
- Sprint Estimate Date: REQUIRED - The date of the estimate. It should fall between the Sprint start and end dates.
- Sprint Estimate: REQUIRED - The estimate. This should be the sum of the task estimates for the given date.
- PBI:
- Row: Doesn't affect the import.
- PBI Key: REQUIRED - The unique identifier of the PBI. The prefix must match the Product Key Prefix. Imported PBI Keys will be preserved in the newly created product.
- PBI Title: REQUIRED - The title of the Product Backlog Item that will be created.
- PBI Description: An optional field to describe the PBI.
- PBI Current Effort Estimate: The current estimate of the PBI. The export creates these as references to the 'PBI Estimates' sheet pointing at the latest estimate. If you change this value, an estimate will be created with today's date. If you leave the field empty, it will be created as an unestimated PBI. PBIs committed to Sprints must have estimates.
- Themes: An optional field representing a comma separated list of themes associated with this PBI. If the theme(s) don't exist, they will be created.
- Benefit: An optional field representing an assessment of the PBI's benefit to the Product and/or business.
- Penalty: An optional field representing an assessment of the penalty to the Product and/or business of not including or completing the PBI.
- PBI Active: REQUIRED (Yes/No) - ScrumWorks Pro does not give the option of truly deleting PBIs. It marks them inactive to keep an accurate record of work completed. See Delete Product Backlog Item for more information.
- PBI Done: REQUIRED (Yes/No) - Whether or not the PBI is considered 'Done'.
- PBI Completion Date: REQUIRED if 'PBI Done' is Yes - The date the PBI was completed.
- Release Name: Doesn't affect the import.
- Sprint Begin Date: Doesn't affect the import.
- Sprint End Date: Doesn't affect the import.
- Team Name: Doesn't affect the import.
- PBI ID: REQUIRED (Unique) - It is used to reference this PBI in other sheets.
- Sprint ID: REQUIRED if the PBI belongs to a Sprint - The Sprint the PBI belongs to.
- Release ID: REQUIRED - The Release the PBI belongs to.
- PBI Estimates:
- PBI Title: Doesn't affect the import.
- Date: REQUIRED - The date of the estimate.
- Estimate: The estimate in the units specified on the Product Info sheet.
- PBI Active: Doesn't affect the import.
- PBI ID: REQUIRED - The ID of the PBI this estimate belongs to.
- PBI Parent History:
- PBI Title: Doesn't affect the import.
- Change Date: REQUIRED - The date the PBI was moved.
- Release Name: Doesn't affect the import.
- Sprint Name: Doesn't affect the import.
- PBI ID: REQUIRED - The PBI this history item belongs to.
- Sprint ID: The Sprint this PBI was moved into (or empty if the PBI was moved out of a Sprint).
- Release ID: REQUIRED - The Release this PBI was moved into (or no change if the Sprint changed).
- PBI Attachments:
- PBI Key: Doesn't affect the import.
- PBI Title: Doesn't affect the import.
- Attachment File Name: REQUIRED - Name of the attachment file.
- Attachment File Size: REQUIRED - Size of the attachment file in bytes.
- Attached By: REQUIRED - The name of the user that uploaded the attachment to the server.
- Attachment Date: REQUIRED - Date that the file was uploaded to the server.
- Attachment ID: REQUIRED (Unique) - Used to reference the file in the product's attachment directory.
- PBI ID: REQUIRED - The PBI this attachment is associated to.
- Tasks:
- Row: Doesn't affect the import.
- Task Title: REQUIRED - The title of the Task.
- Description: An optional description of the Task.
- Point Person: The person the Task is assigned to. If the field is left empty, the Task will be (unassigned).
- Status: REQUIRED (Not Started/In Progress/Impeded/Done) - The status of this Task.
- Current Estimate: REQUIRED - The current estimate of the Task. The export creates these as references to the 'Task Estimates' sheet pointing at the latest estimate. If you change this value, an estimate will be created with today's date.
- PBI Title: Doesn't affect the import.
- PBI Description: Doesn't affect the import.
- PBI Current Effort Estimate: Doesn't affect the import.
- Benefit: Doesn't affect the import.
- Penalty: Doesn't affect the import.
- PBI Active: Doesn't affect the import.
- PBI Done: Doesn't affect the import.
- PBI Completion Date: Doesn't affect the import.
- Release Name: Doesn't affect the import.
- Sprint Begin Date: Doesn't affect the import.
- Sprint End Date: Doesn't affect the import.
- Team Name: Doesn't affect the import.
- PBI ID: REQUIRED - The ID of the PBI this task belongs to.
- Sprint ID: Doesn't affect the import.
- Release ID: Doesn't affect the import.
- Task ID: REQUIRED (Unique) - It is used to reference this PBI in other sheets.
- Task Estimates:
- Task Title: Doesn't affect the import.
- Date: REQUIRED - The date of the estimate.
- Estimate: REQUIRED - The estimate.
- Task ID: REQUIRED - The ID of the Task this estimate belongs to.
- Impediments:
- Impediment Summary: REQUIRED - A summary of the Impediment.
- Detail: An optional description of the Impediment.
- Entry Date: REQUIRED - The date the Impediment was entered into the system.
- Last Modified Date: REQUIRED - The date the Impediment was last modified.
- Resolved: REQUIRED (Yes/No) - Whether or not the Impediment is resolved.
- Date Resolved: REQUIRED if Resolved is 'Yes' - The date the Impediment was resolved.
- Reporter: The name of the person who reported the Impediment. If it is left empty, the reporter is (unassigned).
- Team Name: REQUIRED - The name of the team that reported the impediment. If the team does not exist within ScrumWorks Pro, it is created.
» top
Required Permissions : Import into Release
When you open the import window, you can import Backlog Items and Tasks by performing the following steps:
- Select a Release on the left side of the window. The imported Backlog Items and Tasks will be added to the top of the selected Release.
- Use the "Browse" button to select an Excel document which contains the Backlog Items and the Tasks to import. When the file is selected, the content of the file will appear in the center "Preview" panel.
- To import the Backlog Items and Tasks shown in the preview, click "Import". The import window will be closed and the Backlog Items and Tasks will be added to the selected Release in the same order as they appeared in the "Preview" panel.
The format of the import files:
The rows of the import files describe either Backlog Items or Tasks. Tasks belong to the last Backlog Item in the file before them. As the content of the import files are imported into Releases, every task in the import files need to belong to a Backlog Item (ie. the first row in the file must be a Backlog Item row).
The columns have the following content:
- A: Backlog Item Title. Must be empty if the row represents a Task.
- B: Task Title. Must be empty if the row represents a Backlog Item.
- C: Backlog Item/Task Description.
- D: Backlog Item/Task Estimate. Must contain a non-negative integer.
| A | B | C | D |
|---|---|---|---|
| Backlog Item Title | PBI description | 5 | |
| Task 1 title | Task 1 description | 7 | |
| Task 2 title | Task 2 description | 3 | |
| Backlog Item 2 Title | PBI 2 description | 9 | |
| Task 3 title | Task 3 description | 2 |
» top
» top
Required Permissions :
- Source product requires the 'Drag Backlog Items/Tasks from Product' permission
- Destination product requires the 'Drop Backlog Items/Tasks into Product' permission
-
Open both products and arrange them in a way that the source and destination products are
visible. The "Window" > "Tile" menu item is good for this.
-
Drag the Backlog Item or Task from the source product to the desired location in the
destination product.
- You cannot drag them into a Sprint
- The Backlog Item's tasks will be moved as well. If those tasks were part
of a Sprint, the estimates of remaining work for the Sprint will change for the current day
- Effort units between the source and destination product may differ. Be sure to re-evaluate the Backlog Item estimates when moving Backlog Items.
- You will be prompted about the history of the backlog item:
- Move the history to the new Product - The entire estimate history for the Backlog Item will be moved. This will affect
the Product Burndown Chart for the source and destination Products.
- Start a new history - The estimate history for
the Backlog Item will stay with the source Product
and a new history
will start in the new Product.
- Cancel - Aborts the move.
- When moving multiple Backlog Items between Products,
you will be prompted with a choice about the histories
of the Backlog Items. This choice will be applied to
all Backlog Items of the multi-selection.
Note regarding attachments: When Backlog Items containing attachments are moved to another Product, the attached files are moved with them. No copies of attached files remain in the originating Product. When moving Backlog Items to another Product, if an attached file is unreadable or cannot be found, the movement of all Backlog Items and attachments is canceled, and an error message indicating the problematic files is displayed. In such a case, the move may be enabled by removing the offending attachment from the Backlog Item before again attempting to move the Backlog Items to the destination Product.
When moving Tasks across products:
- If the Tasks are part of a Sprint, the estimates of
remaining work for both the source and destination
Sprints will change for the current day.
- Past Task estimates will not be moved with the Task.
A confirmation dialog will ask if you
still want to move the Task.
- If you want to go ahead with the move, Sprint
Burndown Charts will be affected:
- Source Sprint: Estimates prior to today
will not be able to be viewed or changed,
even if you move the Task back into the Sprint.
- Destination Sprint: A new Task estimate history starts today.
- Source Sprint: Estimates prior to today
will not be able to be viewed or changed,
even if you move the Task back into the Sprint.
» top
External Application Integration
-
In the following dialog select "Bugzilla" from
the Application dropdown. Enter the server address for the data
you wish to download, and if required, enter a Username and Password for an
account with access to the server specified. Click the "Connect" button to
access the server.
-
In the "Specify Release and Retrieved Fields" dialog, choose an existing
ScrumWorks Pro Release as a destination for downloaded data: For each record
selected for download, an individual Backlog Item will be created and placed
at the bottom of the specified Release. Check the box next to each field you
want downloaded from the server and included in each record's Backlog Item.
Except for the fields marked "(always retrieved)", only data for the Fields
you select will be downloaded.
The following Bugzilla Fields are always retrieved for each record:
- Bug #
- Comment (including Description)
- Resolution
- Status
- Summary
Note on Custom Fields: In order to access custom fields from Bugzilla, ScrumWorks Pro expects to find "query.cgi" at the root of your Bugzilla installation ("https://bugzilla.server.com/query.cgi"). This page must accept the parameter "format=advanced" and list the custom fields in the "Advanced Searching Using Boolean Charts" section. This is the default Bugzilla configuration.
-
In the "Search Bugzilla Database" dialog, specify filters for data retrieval
from the selected database. All fields in the database may be filtered,
regardless of which fields have been chosen for download into ScrumWorks Pro.
Select a Field, an operation, and a Value, and click the "Add" button to add
that criteria to the list on the right. Certain operations support multiple words as the value.
If the operation text is plural, then you can append
different search values by separating them with a comma. For example:
"Bug # contains any of the words 4,11" will search for the word 4 or 11 within
the Bug # field and return Bug # 4 and Bug # 11.
Individual filters may be removed by selecting the line from the list and clicking the "Remove" button. Click the "Search" button to search the specified database according to the listed filters. A "Retrieving Items" dialog displays the status of your search. Clicking this dialog's "Cancel" button stops the search. When the search is complete, a list of items matching specified filter criteria are displayed in the table below.
-
To download individual items found, select those items and
click "Download Selected Items". To download the entire
returned list, click "Download All".
Required Permissions : Create Backlog Item
» top
-
In the following dialog select the application from the Application
dropdown, and check the box next to each server from which you want to
download the latest data and click "OK".
-
For each server selected, a list of items previously downloaded is
displayed in a Refresh from Server dialog. To refresh these items,
click "Refresh" and enter a valid Username and Password for the server
in the resulting connection dialog. A "Refresh Successful" notification
will be generated when the refresh from each server is complete. To
continue to the next servers' item listing and connection dialog, click
"Next Server". If you wish to skip a refresh action from any server you've
selected, click the "Skip" button in the Refresh from Server dialog to
continue to the next selected server in the list.
-
After all selected servers have been refreshed or skipped, a Refresh
Summary dialog lists the servers from which data was refreshed and those
from which it was not.
To refresh data in individual Backlog Items, in the Downloaded Data tab of the Backlog Item editor, click the button "Refresh from server". If you have an active session login to the server, the data will be refreshed with the most recent server information. If you do not have an active session login or if for some reason the prior login information cannot be passed to the server, you will be asked to authenticate before the data is refreshed from the server.
Required Permissions : Edit Backlog Item
» top
» top
- Sign on to the server using an account with Administrator privileges.
In the top menu bar, click "Administration".
- In the left side menu, under the section "Global Settings", click
"General Configuration". The body of this page displays various settings
under the following section headings: "Settings", "Internationalisation",
and "Options".
- Under the "Options" section, Find the item "Accept remote API calls".
This item should be set to "ON".
- If this item is set to "OFF", click "Edit Configuration" in the grey bar at the bottom of the page, which enables editing for all items under all sections. Scroll back down to "Accept remote API calls" under the "Options" section, and select the radio button for "ON". Click the "Update" button at bottom of the page to save your configuration changes.
» top
These steps will only need to be performed once for each computer that needs to download data from JIRA. Replace "<path_to_java>" and "<server_name>" with their appropriate values for each computer. Note that if you have multiple versions of Java installed, you will need to replace "<path_to_java>" with the one that runs ScrumWorks Pro via WebStart.
- Open a secure connection to your JIRA server (https://jira.company.com) using Internet Explorer. If you are using Windows Vista, you will need to run Internet Explorer as an Administrator.
- If Internet Explorer prompts you to accept the certificate, click "View Certificate". If it does not prompt you, you can double click the gold lock icon to open the certificate. Alternatively, you can go to the "View" -> "Security Report" menu option.
- Click the "Details" tab.
- Click the "Copy to File..." button.
- Save the certificate as a "DER encoded binary X.509 (.CER)" file. Remember where you save the file.
- You can now close Internet Explorer and use this certificate on any client that needs to download data from JIRA.
- Open up a command prompt.
- Run the command: <path_to_java>\bin\keytool -import -trustcacerts -keystore "<path_to_java>\jre\lib\security\cacerts" -storepass changeit -alias <server_name> -file <file_you_saved.cer>
- When prompted to "Trust this certificate?", enter "Yes"
- You should now be able to download from the JIRA server which uses that key.
» top
- In the following dialog select "JIRA" from the Application dropdown. Enter the server address for the data you wish to download, and enter a Username and Password for an account with access to the server specified. Click the "Connect" button to access the server.
-
In the "Specify Release and Retrieved Fields" dialog, choose an existing
ScrumWorks Pro Release as a destination for downloaded data: For each record
selected for download, an individual Backlog Item will be created and placed
at the bottom of the specified Release. Check the box next to each field you
want downloaded from the server and included in each record's Backlog Item.
Except for the fields marked "(always retrieved)", only data for the Fields
you select will be downloaded.
The following JIRA Fields are always retrieved for each record:- Key
- Description
- Resolution
- Status
- Summary
Notes on Custom Fields:
The JIRA API limits access to custom fields via ScrumWorks Pro to only those with Administrator privileges in JIRA. Even if you normally have access to custom fields in JIRA, if you do not have Administrator privileges, you will not be able to retrieve custom fields from within ScrumWorks Pro.
Because the JIRA API does not identify data type for certain custom fields, internal JIRA code may populate a custom field in ScrumWorks Pro with the internal code rather than an appropriate display value. In such cases, values can only be viewed by accessing the issue directly in JIRA.
-
In the "Seach JIRA Database" dialog, choose from among the three search methods:
Free text, Key name, or Filters. Only Filters previously saved in JIRA are
available. If you have no searches saved in JIRA, you can not use this method
to search the database; Search Filters must be created directly in JIRA to be
available for use in ScrumWorks Pro. Click the "Search" button to search the specified
database according to the selected method. A "Retrieving Bugs" dialog displays the
status of your search. Clicking this dialog's "Cancel" button stops the search. When
the search is complete, Returns matching specified search criteria are displayed in the
table below.
Required Permissions : Create Backlog Item
» top
-
In the following dialog select the application from the Application dropdown,
and check the box next to each server from which you want to download the
latest data and click "OK".
-
For each server selected, a list of items previously downloaded is displayed
in a Refresh from Server dialog. To refresh these items, click "Refresh" and
enter a valid Username and Password for the server in the resulting connection
dialog. A "Refresh Successful" notification will be generated when the refresh
from each server is complete. To continue to the next servers' item listing and
connection dialog, click "Next Server". If you wish to skip a refresh action
from any server you've selected, click the "Skip" button in the Refresh from
Server dialog to continue to the next selected server in the list.
-
After all selected servers have been refreshed or skipped, a Refresh Summary
dialog lists the servers from which data was refreshed and those from which it
was not.
To refresh data in individual Backlog Items, in the Downloaded Data tab of the Backlog Item editor, click the button "Refresh from server". If you have an active session login to the server, the data will be refreshed with the most recent server information. If you do not have an active session login or if for some reason the prior login information cannot be passed to the server, you will be asked to authenticate before the data is refreshed from the server.
Required Permissions : Edit Backlog Item
» top
» top
- Work Log
- Change History
- Watchers
- Time related (Original estimate, Remaining Estimate, Time Spent)
» top
Team Management
Global and Product Administrator users can add new Teams, change Team composition, and delete Teams using the Team Manager, found in the main menu under:
"User" > "Team Manager"
A single Team can work on Sprints in multiple Products simultaneously.
-
Click the "New Team" button.
-
Enter the name of the new Team in the "Team
Name" text field.
-
Select the Team Members of the new Team from
the list "Available Team Members". If you
didn't create any Users yet, this list will be
empty. See User
Management on how to create Users.
Note: adding Users to a Team will give them a default Role, set in Product Properties, for each Product to which the Team is associated. Removing a User's Team membership will remove that User's default Role on Product with which the Team is associated.
-
Click "<<", to add the selected persons
to the Team.
- Click "Save and Close" or "Apply" to save, and "Cancel" to abort.
» top
-
Select a Team from the "Teams" list by
clicking on the Team's name.
-
Edit the name of the Team in the "Team Name"
text field, as desired.
-
To add new Team Members to this team, select
the ones to be added from the list "Available
Team Members". Click "<<" to add the
selected persons to the Team.
-
To remove Team Members from the team, select
the ones to be removed from the list "Current
Team Members". Click ">>" to remove them
from the Team.
Note: adding Users to a Team will give them a default Role, set in Product Properties, for each Product to which the Team is associated. Removing a User's Team membership will remove that User's default Role on Product with which the Team is associated.
- Click "Save and Close" or "Apply" to save, and "Cancel" to abort.
» top
-
Select the Team to be deleted from the "Teams"
list by clicking on the Team's name.
-
Click the "Delete Team" button below the
"Teams" list.
-
Click "Yes" on the pop-up dialog to confirm
the deletion.
Note: You can only delete a Team if it was never assigned a Sprint. This restriction is necessary to preserve integrity of historical information.
» top
-
If desired, first Create a New Team.
Users must have Product Admin privileges to do this.
-
Open the Product for which you wish to add an existing team, so that
the Product Window is in view.
-
Select the +/- Team button located in the upper right-hand corner of the
"Sprints by Team" frame of the Product Window.
-
All available teams are listed in the resulting "Add Team to Product" screen.
Check the box corresponding to any Team the user desires to associate with the
Product. Any Team already associated with the Product will be checked.
-
To remove any Team currently associated with the Product, uncheck the corresponding
checkbox.
-
Click "OK" to add the selected team to this product, or "Cancel" to abort.
-
The new team will appear in the list of Team Tabs on the Sprints
side of the Product Window.
-
If removing an existing team with currently running or past Sprints, a warning will
notify the user that the Sprints will not be removed or deleted. Instead, removing
the team will hide this data from view. If deletion is instead desired, the user
should re-associate the Team and remove all Backlog Items and Sprints manually.
» top
User Management
With regard to Product Access, there are three types of users in ScrumWorks Pro: Global Administrators, Product Administrators, and Users with Role-based access. Global Administrators have universal Product access and are the only users that can create, edit, or delete other users. Product Administrators may grant other Users Product Administrator access and Role-based access. Users with Role-based access have permissions determined by their assigned Role(s) and may not grant any product access to other Users. Any user may set their own password and preferences. The default Global Administrator login is "administrator" with password "password".
With regard to Program Access, there are three types of users: Global Administrators, Program Administrators, and Program Viewers. Global Administrators have universal Program access, and are the only users that can create or delete Programs. Program Administrators may include Products (viewing the names of all Products that exist in the system regardless of individual Product access), create and assign Groups, and grant Program access to other users for Programs they administer. Access to Product Backlog Item information is determined by per-Product access rights and Roles. A Program Viewer may view the names of only those Products that have been included in the Program.
- From the main menu, select "User" > "User Manager" (shortcut key: CTRL+U).
-
If you are using directory authentication, add the user to the group
designated for access to ScrumWorks Pro. Users will populate ScrumWorks Pro's
User Manager automatically based on directory group membership.
See the Directory Authentication section for more information. -
If you are not using directory authentication,
click the "New" button under the list of existing users and enter the
Login Name, Password, and Display Name of the user. Display Names
are used in Task Point Person fields.
Note: Usernames may not contain the colon:character. This holds for ScrumWorks authenticated as well as directory authenticed users. -
Provide access rights to products as described
Grant Product and Program Access
section.
- Click "Save and Close" or "Apply" to save, and "Cancel" to abort.
» top
The proper spreadsheet format is:
- one row for each User
- four columns corresponding to the three fields for each User in the User Manager, in this order: Display Name, Login Name, Password, and E-mail address.
- Column headings are unnecessary, and if included will be imported as if they were entries for a User.
| Johnny Lawrence | jlaw | p3amfk1s | jlaw@cobrakai.com |
| Terry Silver | tsilver | w2gb7jq | |
| Daniel LaRusso | dlarusso | waxonwaxoff | daniel@miyagi.com |
The proper cell format for all field entries must be a string of letters, or letters and numbers: for any field in the spreadsheet, a cell populated only with numbers will cause an error and the import will be rejected. The first three cells for each user must contain a value or the import will be rejected. The e-mail address field is optional.
Upon successful import, Users will appear in the User Manager in alphabetical order by Display Name.
Note: Usernames may not contain the colon
: character.
This holds for ScrumWorks authenticated as well as directory authenticed users.
» top
-
From the main menu, select "User" > "User Manager" (shortcut key: CTRL+U).
-
The "User Manager" window appears. Select a name from the "Users"
list on the left side of the window by clicking on the corresponding row.
Note the "Authentication" column which indicates whether a User's login
information is controlled by ScrumWorks Pro or via a directory server.
-
In the "Login Information" tab,
update the Display Name, Login Name, Password, and E-mail address as desired for ScrumWorks Pro
authenticated users.
Note: Usernames may not contain the colon:character. This holds for ScrumWorks authenticated as well as directory authenticed users.
- Click "Save and Close" or "Apply" to save, and "Cancel" to abort.
» top
-
From the main menu, select "User" > "User Manager" (shortcut key: CTRL+U).
-
Select the User slated for deletion and then
click the "Delete User" button.
- Confirm the deletion by clicking "Yes", or "No" to abort.
If the user is authenticated using the organization directory, the user can not be removed from within ScrumWorks Pro. Global Administrators may not remove themselves from ScrumWorks Pro.
» top
Concurrent User License behavior:
When the licensed number of Concurrent Users is reached, user logins will be blocked until slots become available. At this point, only those with Global Administrator privledges will be able to login, and access will be limited to the User Manager, managing logged-in users, or changing the license.
To manually log users out (requires Global Administrator privledges):
- From the User menu, click "Manage logged-in users".
- In the resultant dialog, all currently logged-in users are displayed along with the time since their last activity. The "Clients in Use" column describes which client, Desktop or Web or both, the user is currently logged into*.
- Check the box next to each User to be manually logged out.
- Click "Log-out User(s)". The list of logged-in users will refresh to reflect the changes made.
* Users under a Concurrent User license may log into multiple instances of both the Desktop and Web Clients, occupying an additional Concurrent User slot for each subsequent instance of each client.
» top
User Attributes
After selecting a user, their user attributes will be shown, but disabled, and their authentication type will be displayed as an indicator for why they are disabled.
Adding Users
If you are using directory authentication, users in the group designated for ScrumWorks Pro access as set up by your directory administrator will automatically gain access. ScrumWorks Pro synchronizes with the directory server for a list of users every few minutes.
Removing Users
To remove a directory user, simply remove them from the group designated for ScrumWorks Pro access in the directory server. ScrumWorks Pro will detect the change shortly and remove the user(s) from the User Manager.
Please see the Directory Configuration documentation for more information on configuring ScrumWorks Pro Server to authenticate against LDAP or Active Directory.
» top
Switching to Directory Authentication
- Make sure your ScrumWorks server has been configured for directory authentication. If the server has not been configured, the ability to switch to directory authentication will be disabled. Please see Directory Configuration.
- In the User Manager, from the list of Users on the left, select the User whose authentication type you wish to switch.
- In the Login Information tab on the right, the User's Authentication type is listed. Click the "Switch to directory" button to the right of the listing. ScrumWorks will compare the Login Name of the selected User to the User IDs in the directory.
- If a directory User ID matching the ScrumWorks Login Name is not found, a notification stating so is displayed. If the directory User ID is known, the ScrumWorks Login Name may be changed to match it, so that ScrumWorks identifies it when the process is attempted again.
- When a directory User ID matching the ScrumWorks Login Name is found, the User ID, First and Last Name, and e-mail address (if any) is displayed for confirmation as the intended User record.
- Click "Confirm" to switch the User's authentication type to directory using the displayed User ID. Note the Login Information is replaced and read-only as described in the Directory Server section.
- In the User Manager, from the list of Users on the left, select the User whose authentication type you wish to switch.
- In the Login Information tab on the right, the User's Authentication type is listed. Click the "Switch to ScrumWorks" button to the right of the listing.
- A dialog appears requesting entry of a ScrumWorks authentication password to be used instead of the directory password. Note: This password is used only for ScrumWorks authentication of the selected User, and does not alter or affect that User's directory password.
- Click "OK" to to complete the switch to ScrumWorks authentication using the provided password.
» top
To Enable Roles and Permissions for a new Product:
- Use the File > Product Properties menu or the Create Product Wizard, for Roles and Permissions, select the radio button for "Enabled".
- Click "OK".
To enable Roles and Permissions for an existing Product:
- Go to File > Product Properties.
- For Roles and Permissions, select the radio button for "Enabled".
- Click "OK".
Required User Type: Global Administrator
» top
-
Logged in as a Global Administrator, from the main menu select "User" >
"User Manager" (shortcut key: CTRL+U).
-
The "User Manager" window appears. Select a name from the list of "Users"
on the left side of the frame by clicking on the corresponding row.
-
In the "Login Information" tab click the checkbox labeled "Grant Global
Administrator privileges to user".
- Click the "Apply" button to save the changes. Global Administrator privileges are effective upon next login.
» top
Global Administrators can grant Product Administrator or Role-based access to any product in the system.
Product Administrators can grant Users access to only those products for which they themselves are administrators.
-
From the main menu, select "User" > "User Manager" (shortcut key: CTRL+U).
-
The "User Manager" window appears. Select a name from the "Users" list on the left side of the window by clicking on the corresponding row.
-
In the "Product Access" tab, scroll to the product you want the selected
User to access. In the Product Access and Roles column,
select either Product Administrator or one or more of the listed Roles for
that Product. Product Administrators have read/write
permissions over all data and fields for that Product, including
managing and assigning Roles to users. When Product Administrator is selected,
the listed Roles are disabled since they are no longer relevant to the selected
User. To revoke Product Administrator status and instead assign one or more
Roles, uncheck Product Administrator, then check one or more of the Roles
that exist for that Product.
-
If a new Role is desired, click "Manage Roles" in the "Roles and Permissions"
column corresponding to the desired Product.
-
Repeat steps 2 and 3 above for each User you wish to grant Product access.
» top
Required User Type: Product Administrator or Global Administrator
-
Open the Product for which you would like to assign Roles. If Roles and Permissions are not
yet enabled, be sure to do so before proceeding
to the next step.
-
From the User menu, select "Role Manager". This menu option is disabled for Products
with Roles and Permissions disabled.
-
From the "Roles" section at left, select a Role you wish to assign to multiple Users.
-
Click the "Assign Role to Multiple Users" button at the bottom of the screen.
-
The "Assign Role to Multiple Users" dialog will be displayed. It will contain a list of all Users
in the system. The selected Role will match that chosen within the Role Manager.
Click the checkbox next to each User to which you wish to apply the selected Role.
Note: Product Administrators will not appear because they have all permissions.
-
Uncheck the checkbox to remove the selected Role from a User.
-
Click "Save and Close" to save, "Apply" to apply current changes or "Cancel" to abort.
-
From here you can choose to make assignment changes for any of the existing Roles
for a User. Select a different Role, and check or uncheck the box next to each User
to apply or remove that Role. Note: If changes were made to a Role's assignment
you must either apply or discard the changes before moving to the next Role. Changes are saved to
the server for that Role when the "Apply" button is pressed. They are also saved to the server when
the "Yes" option is chosen for any unsaved changes when switching to a different Role.
» top
Global Administrators can grant Users access to all programs in the system; Program Administrators can grant Users program access and designate User Type for only those programs for which they are Program Administrators.
-
From the main menu, select "User" > "User Manager" (shortcut key: CTRL+U).
-
The "User Manager" window appears. Select a name from the "Users" list on the left side of the window by clicking on the corresponding row.
-
In the "Program Access" tab, under the "Login Information" section, select the checkbox in the Access column for each program you want the selected User to access. The default User Type is Program Viewer, which provides read-only access to that Program, its Groups, and Products that have been included in the Program.
-
Click "Save and Close" or "Apply" to save, and "Cancel" to abort.
» top
Role Management
Roles and Permissions are optional on a Product by Product basis. Disabling Roles and Permissions leaves access to that Product open to any User in ScrumWorks Pro. By default, Roles and Permissions are disabled for newly-created Products.
Roles apply only to Products; Roles are not applicable to Programs.
To ease administration, Role Templates can be created that are available to each Product in ScrumWorks Pro.
To Enable Roles and Permissions for a new Product:
- In the New Product Wizard or the Product Properties dialog, for Roles and Permissions, select the radio button for "Enabled".
- Click "OK".
To enable Roles and Permissions for an existing Product:
- In the main menu, go to File > Product Properties.
- For Roles and Permissions, select the radio button for "Enabled".
- Click "OK".
Required User Type: Global Administrator
» top
- Business Weight
- Edit Business Weight
- View Business Weight
- Drag and Drop Between Products
- Drag Backlog Items/Tasks from Product
- Drop Backlog Items/Tasks into Product
- Impediments
- View, Create, Edit, Delete Impediments
- Import/Export
- Export the Product
- Import into Release
- Product Backlog Items
- Create Product Backlog Item
- Delete Product Backlog Item
- Edit Historical Estimates
- Edit Product Backlog Item
- Estimage Product Backlog Item
- Mark Product Backlog Item as Done
- Prioritize Sprint/Product Backlog
- Releases
- Create, Edit, Delete Releases
- Reports
- Manage Web Reports
- View Product Progress, Sprint Change, Product/Release Burndown Reports
- Sprints
- Create, Edit, Delete Sprints
- Tasks
- Create, Edit, Delete Task
- Edit Historical Task Estimates
- View Task
- Themes
- Apply/Remove Theme
- Create
» top
Required User Type: Product Administrator or Global Administrator
Create new Role manually:
- From the User menu, select "Role Manager".
- In the "Roles" section, click "New".
- Under "Role Information", provide a name and
description of the new Role.
- Select desired permissions for the role. Note,
selecting a parent permission provides access
to its subordinate permissions.
- Click "Save and Close" or "Apply" to save. The
newly created Role will appear in the "Roles"
section. Alternatively, click "Cancel" to abort.
- From the User menu, select "Role Manager".
- Select an existing Role from the "Roles" section.
- Click "Copy". Note, if you fail to click "Copy" before
continuing, you will be modifying an existing Role, not creating
a new one.
- In the "Role Information" section, modify the existing
name and description.
- In the "Permissions" section, modify the existing
permissions as desired.
- Click "Save and Close" or "Apply" to save. The newly
created permission will appear in the "Roles" section.
Alternatively, click "Cancel" to abort.
- From the User menu, select "Role Manager".
- In the "Role Template" section select a desired
Role Template. Note, once selected a read-only preview of the
Role Template's permission set is made available in the
"Permissions" section.
- Click "Copy Template to New Role". Note that the
"Role Information" and "Permissions" sections are now
editable.
- Make desired changes to the name, description and
permission set.
- Click "Save and Close" or "Apply" to save. The newly
created permission will appear in the "Roles" section.
Alternatively, click "Cancel" to abort.
» top
Required User Type: Product Administrator or Global Administrator
- From the User menu, select "Role Manager".
- Select an existing Role from the "Roles" section.
- Modify the name, description, and Permissions as
desired.
- Click "Save and Close" or "Apply" to save.
If changes were made to the Role name, the change
will be visible in "Roles" section. Alternatively,
click "Cancel" to abort the edit.
» top
Required User Type: Product Administrator or Global Administrator
- From the User menu, select "Role Manager".
- Select an existing Role from the "Roles" section.
- Modify the name, description, and Permissions as
desired.
- Click "Save and Close" or "Apply" to save.
If changes were made to the Role name, the change
will be visible in "Roles" section. Alternatively,
click "Cancel" to abort the edit.
» top
Role Template Management
The standard Role Templates include:
- Product Owner
- ScrumMaster
- Stakeholder
- Team member
» top
Required User Type: Global Administrator
Create new Role Template manually:
- From the User menu, select "Role Template Manager".
- In the "Role Templates" section, click "New".
- Under "Role Template Information", provide a
Template name and description of the new Role.
- Select desired permissions for the role. Note,
selecting a parent permission provides access
to its subordinate permissions.
- Click "Save and Close" or "Apply" to save. The
newly created permission will appear in the "Role
Templates"
section. Alternatively, click "Cancel" to abort.
- From the User menu, select "Role Template Manager".
- Select an existing Role Template from the "Role
Templates" section.
- Click "Copy". Note, if you fail to click "Copy" before
continuing, you will be modifying an existing Role
Template, not creating a new one.
- In the "Role Template Information" section, modify the existing
name and description.
- In the "Permissions" section, modify the existing
permissions as desired.
- Click "Save and Close" or "Apply" to save. The newly
created permission will appear in the "Role Templates" section.
Alternatively, click "Cancel" to abort.
» top
Required User Type: Global Administrator
- From the User menu, select "Role Template Manager".
- Select an existing Role from the "Role Templates"
section.
- Modify the name, description, and Permissions as
desired.
- Click "Save and Close" or "Apply" to save.
If changes were made to the Role Template name, the change
will be visible in "Roles" section. Alternatively,
click "Cancel" to abort the edit.
» top
Required User Type: Global Administrator
- From the User menu, select "Role Template Manager".
- Select an existing Role Template from the
"Role Templates" section.
- Modify the name, description, and Permissions as
desired.
- Click "Save and Close" or "Apply" to save.
If changes were made to the Role Template name, the change
will be visible in "Role Templates" section. Alternatively,
click "Cancel" to abort the edit.
» top
Programs and Groups
The Program Window is comprised of a dual pane interface with a tree structure of nested Groups on the left, and a "Focus pane" on the right that shows the contents of any Group selected on the left. It behaves similarly to a typical tree structure browser, where items in the focus pane on the right can be dragged to other folders in the tree structure.
For example, a Program and subordinate Group hierarchy might be created for a company's product line. Feature sets are represented by Groups, which act like a nested folder system. A Product's individual Backlog Items that relate to a specific feature set may be placed together in a Group named for that feature. Grouping Backlog Items in this way affects neither how nor when they are actually completed (this is performed in the Product), but shows how high-level, cross-Product feature concepts relate to Products and even individual Product Backlog Items.
» top
To illustrate this concept by way of example, imagine a Program with three top level Groups defined: A, B, and C. The Group Manager then weights Group A with a Business Weight of 5, B with 4, and C with 1. This would imply that the Group A represents 50% of the business value in the Program, while B and C represent 40% and 10% respectively.
Now imagine that Group A contains three sub-Groups A1, A2, A3. Groups A1 has a Business Weight of 4, A2 has a Business Weight of 2, and A3 has 4. This means that A1 represents 40% of the value represented by its parent (Group A). A2 and A3 each represent 30% and 40% of Group A's value respectively. And ultimately A1 represents 40% multiplied by A's 50%, or 20% of the total value of the Program.
Further, consider that A1 contains four Product Backlog Items, each with a Business Weight of 10. This means each individual Product Backlog Item represents (25% • 40% • 50%), or 5% of the total value in the Program. When a Product Owner marks this item "Done", it means that 5% of the Program's value has been finished.
» top
-
A Title must be entered that is unique among other Program Titles.
-
See Description Field Editing and Syntax
for tips on entering a description.
- Products may be included in the Program by selecting the appropriate checkbox. Products that have been assigned to other Programs will not be available for inclusion in this new Program.
» top
Program Administrators can edit all of the fields that were available during Program creation: title, description, and assigned products.
Program Viewers can view all of the attributes, but editing is disabled.
» top
-
Selected the desired Program from the drop down menu.
-
The "Included Products:" box displays those Products that have been
assigned to the selected Program.
-
If no Programs exist in the system, a new Program can be created
by clicking the "New" button.
- Each Program is opened into a new Program window that displays only those Groups and Products that have been assigned to it. Multiple Program windows can be open at the same time.
» top
After selecting the menu item, ScrumWorks Pro will confirm the Program deletion.
Program deletion will delete all Groups in the Program's Group hierarchy, and all Product Backlog Items will be disassociated from these Groups. The assigned Products of the deleted Program will be available for inclusion in other Programs.
Only the Global Administrator can delete Programs.
» top
-
Right-click on the Program name and select "Create new Group in this
Program".
- Right-click on the Group name and select "Add new Group within this Group".
-
A name must be entered in order to save the Group.
-
See Description Field Editing and Syntax
for tips on entering a description.
-
You may assign this Group to a Product via
the Product selector.
-
Enter values for the Group's Business
Weight.
» top
Program Viewers can only view the fields.
See Program Groups and Business Weighting for information on interpreting Group Business Weight and Group Return On Investment figures.
Required Permissions: Program Administrator
» top
When moved, Groups retain their Product assignment without regard to their location. That is, a Group with one Product assignment may be moved into a Group with another Product assignment. The moved Group will retain its original Product assignment until it has been reassigned (see Assign/Unassign Groups). When a Group is moved, all Backlog Items associated with it remain in that Group.
Required Permissions: Program Administrator
» top
Required Permissions: Program Administrator
» top
There are two ways to assign a Group to a Product:
-
Right click a Group folder and choose "Edit Group". In the Edit Group dialog, from the
"Product" dropdown, select from the available Products that have been included
in the Program.
- Right-click a Group folder, click "Assign Group to a Product", and in the flyout menu, select from the list of available Products that have been included in the Program.
-
Right-click a Group folder and select "Remove Product Assignment". The prior Product
assignment and any Backlog Item associations will be removed. Backlog Items from the
prior Product assignment will be returned to the Ungrouped Backlog Items.
- The Group is assigned to another Product from either the right-click context menu or from the Edit Group dialog.
Required Permissions: Program Administrator
» top
-
Associated to a Group: A Backlog Item can only be associated to one Group.
- Ungrouped: Backlog Items that are not associated with a Group are listed together into the "Ungrouped Backlog Items" section.
-
Dragging the selected Backlog Item onto a Group row.
-
Dropping the Backlog Item to associate it to the Group.
- You may associate multiple Backlog Items into a Group. See Selecting Multiple Backlog Items for detailed instructions.
You can also remove a Backlog Item's association by choosing the "Disassociate Backlog Item from Group" option from the Backlog Item's context menu. This will place the Backlog Item in the "Ungrouped Backlog Items" section.
Required Permissions: to associate a Backlog Item with a Group, the user must be a Program Administrator and must have access to the Product in question.
» top
-
Right click on the Group to which the new Backlog Item will be associated.
-
Select the "Create new Backlog Item associated to this Group" option from
the context menu.
-
Use the displayed Backlog Item editor to input the details of the Backlog Item.
Please see Create a new Product Backlog Item (PBI) for details.
-
When creating PBIs from within the Group view, the default selected Release
for the Backlog Item is set to the first Release listed in the Product.
- Upon saving, the new Backlog Item will be ranked at the bottom of the selected release.
» top
This action is the same as editing the Backlog Item from the Product Window.
-
Right click on the Backlog Item row you wish to edit.
-
Select the "Edit Backlog Item" option from the context menu.
- Use the displayed Backlog Item editor to edit the Backlog Item. Please see Edit Product Backlog Items for further details.
» top
This action is the same as deleting the Backlog Item from the Product Window.
-
Select one or multiple Backlog Items you wish to delete.
-
Right click on one of the rows.
-
Select the "Delete Backlog Item" option from the context menu.
- Please see Delete Product Backlog Item for further details.
» top
Business Weights applied to Groups are the same conceptually as Business Weights applied to Backlog Items. It is a user defined business value index, a relative value used to compare the business values of Groups against each other. Group Business Weights are not influenced by, nor do they influence Business Weights applied to Backlog Items. For more information about Backlog Item Business Weights please see Earned Business Value (Business Weight)
Business Weight units are user defined and can be anything from real currencies (U.S. dollars, Euros, etc.) to relative point systems. The units are set in the Product Properties window as described in Getting Started with Products
ScrumWorks Pro calculates the Business Weight of a Group by summing two user defined values: Benefit and Penalty.
-
Double-click anywhere on the Group row in the Group view window.
(Alternatively: right-click the Group and then choose "Edit Group").
-
The Group will open in an Editors frame.
-
In the text entry box for "Benefit (of inclusion in Product)"
under the "Estimates" subsection, add an assessment of the
Group's benefit to the Product and/or business. This value
must be a whole number, and is expressed in units defined
for Business Weight (BW) in the Product Properties window
as described in Getting Started with
Products.
-
In the text entry box for "Penalty (of omission from Product)"
under the "Estimates" subsection, enter an assessment of the
penalty to the Product and/or business of not including or
completing the Group. This value must be a whole number, and
is expressed in units defined for Business Weight (BW) in the
Product Properties window as described in
Getting Started with Products.
The values entered in the "Estimates" subsection contribute to the calculations in the "Business Weight" subsection to the right.
- Group Business Weight (gBW): A calculation of a Group's importance to the Product and/or business, determined by adding its Benefit and Penalty values (see below). gBW is expressed as a whole number, in units defined by the Team and set in Product Properties.
» top
In other words, if you add up the gBW of all the children of a single Group, that sum comprises 100% of the pBV of that parent Group. Each child's gBW can therefore be considered as a percentage of its parent's gBW and so on, recursively resulting in a relative Program Business Value for each Group throughout the entire Program tree structure. These calculations are updated automatically.
Required Permission: Program Administrator or Program Viewer
» top
Note: Groups can contain both child Groups and individual Backlog Items. There is no difference in the calculation when this occurs. Each item, either Backlog Item or Group, has it's own Business Weight, which influences what percentage it represents of its parent's Program Business Value.
Required Permission: Program Administrator or Program Viewer
» top
It is an auto-calculated ratio of a given Group's Program Business Value divided by the Group's Backlog Effort Percentage. This gives an ROI number that is 'normalized' by comparison with the other Groups. It is expressed as a number to a user-specified precision (see the Product Properties), from a whole number to a real number up to two decimal places.
Required Permission: Program Administrator or Program Viewer
» top
It is an auto-calculated ratio of a given Backlog Item's Business Weight Percentage divided by the Program Business Value. This gives an ROI number that is 'normalized' by comparison with the other Backlog Items in all Groups. It is expressed as a number to a user-specified precision (see the Product Properties), from a whole number to a real number up to two decimal places.
Required Permission: Program Administrator or Program Viewer
» top
-
Columns displayed may be set and ordered
separately for the Groups and the In-focus Backlog Items panes.
-
Under the Groups main menu, select Columns.
The dialog is divided into left and right halves
corresponding to the Columns displayed in the
two panes of the Group Breakdown View.
-
Select the checkboxes that correspond to columns
you wish to be displayed, and deselect checkboxes
for columns you'd like hidden. The two always-on
columns are Groups and
Backlog Items. These columns
may be ordered, but may not be hidden.
-
Set the order in which columns appear in the
Groups and the In-focus Backlog Items panes by selecting a
column name and using the "Move up" and "Move
down" buttons. Columns whose checkboxes are
unchecked may still be ordered in this way, but
will not appear in the Group Navigator window until their
checkboxes are checked.
-
The default columns displayed and their default
order may be reset by clicking the Restore
Defaults button.
- Dragging/Dropping Column location: Once activated, Columns may be repositioned within their respective panes of the Group Navigator window by dragging and dropping individual columns. Any settings made by dragging and dropping will be reflected in the Column Settings window, and may be overridden by subsequent changes to the Column Settings window.
» top