Polarion ALM Help
		Next

Polarion ALM Help

Copyright © 2005, 2006, 2007, 2008 Polarion Software

Permission is granted to use, copy, and distribute Polarion ALM documentation provided that the above copyright notice and this paragraph appear in all copies.

2008

Table of Contents

1. Help and Other Documentation

1.1. Help Structure
1.2. Installation Documentation
1.3. Where to begin with Help

2. Quick Overview

3. About Polarion ALM

3.1. Trademarks and Acknowledgements

3.1.1. Disclaimer
3.1.2. See also

1. Administrator's Guide

1. Administration Basics

1.1. Administration rights

1.1.1. The Default Administration Account
1.1.2. Defining Additional Administrators

1.2. The Administration Interface

1.2.1. Graphical User Interface
1.2.2. XML Configuration Files

1.3. Resolving Problems & Troubleshooting

2. The Administration Perspective

2.1. Administration Topics

3. Creating and Managing Projects

3.1. Creating a new Project

3.1.1. Creating a new Project from a template
3.1.2. Creating a new project by marking an existing repository folder
3.1.3. Creating a New Project In Eclipse

3.2. Modifying existing Projects

3.2.1. Accessing the Projects Table
3.2.2. Modifying Project Details

3.3. Adding and Removing Projects from Polarion Management

3.3.1. Removing a Project

3.4. Project templates

3.4.1. Why create Project Templates?
3.4.2. What's in a Template?
3.4.3. Creating a Custom Project Template

4. User Management

4.1. Users and Projects

4.2. Creating User Accounts

4.2.1. Creating a New User Account
4.2.2. Modifying Existing User Accounts

4.3. Configuring User Roles

4.3.1. Default Roles
4.3.2. Adding or Deleting a Role
4.3.3. Assigning a Role to Users

4.4. Configuring User Time-splitting

4.4.1. Accessing the Time-split Configuration
4.4.2. Assigning Split Work Time
4.4.3. Effect on Live Plan

4.5. Configuring User Permissions

4.5.1. How to modify permissions
4.5.2. Steps for different scopes
4.5.3. Restricting User Access Project by Project

4.6. Integrating Polarion ALM Server with LDAP/Active Directory

4.6.1. Configuring Subversion to Authenticate Against LDAP
4.6.2. Configuring Polarion for LDAP User Synchronization

4.7. Synchronization of Polarion Users with LDAP

4.8. Configuring Auto-creation of Users

5. Configuring the Portal

5.1. Configuring the Overview

5.1.1. Overview (repository scope)
5.1.2. Overview (project scope)

5.2. Configuring the Dashboard

5.2.1. Repository Dashboard
5.2.2. Project Dashboard

6. Configuring Work Items

6.1. Configuring Time Points

6.1.1. Creating a New Time Point
6.1.2. Editing an Existing Time Point

6.2. Configuring Categories

6.2.1. Creating a New Category
6.2.2. Editing an Existing Category

6.3. Configuring Custom Fields

6.3.1. Understanding the different configuration files
6.3.2. Mapping to Custom Fields in a Live Document
6.3.3. Required Fields
6.3.4. Removing or Changing Custom Fields

6.4. Configuring Enumerations

6.4.1. Available Enumerations
6.4.2. Configuration scope
6.4.3. Status
6.4.4. Priority
6.4.5. Hyperlink Roles
6.4.6. Work Item Link Roles
6.4.7. Work Item Types
6.4.8. Resolution
6.4.9. Severity
6.4.10. Risk

6.5. Configuring Workflow

6.5.1. Workflow Configuration Interface
6.5.2. Accessing the Workflow Designer
6.5.3. Using the Workflow Designer

6.6. Configuring Table View

6.6.1. The Configuration File
6.6.2. Accessing the Configuration Files
6.6.3. Fields Displayed as Table View Columns

6.7. Configuring Queries

6.8. Configuring Shortcuts

6.8.1. Shortcut process overview
6.8.2. Creating a New Shortcut
6.8.3. Deleting an Existing Shortcut

6.9. Configuring the Global Working Calendar

6.9.1. Accessing the Working Calendar
6.9.2. Modifying the Global Working Calendar

6.10. Configuring Planning

6.10.1. Splitting Work Items Across Time and Dependencies
6.10.2. Due Date Planning Option

6.11. Configuring Linking

6.12. Configuring Autoassignment

6.12.1. Autoassignment Example
6.12.2. Accessing the configuration file

6.13. Configuring Voting

7. Configuring Reports

7.1. Source Code Reports

7.1.1. Accessing the Configuration files

7.2. Workitem Metrics

7.2.1. Accessing the Configuration files

7.3. Package reuse

7.3.1. Accessing the Configuration files

7.4. Workitem Quality Report

7.4.1. Accessing the Configuration files

7.5. Process Quality Report

7.5.1. Accessing the Configuration files

8. Getting Started with Build Management

8.1. Quick Start: Simple Maven 2 Project
8.2. Quick Start: Maven 2 Multiproject
8.3. Quick Start: Ant Build
8.4. Quick Start: Build with Makefile
8.5. Quick Start: External Exe, Batch/Shell Script
8.6. Quick Start: Continuous Integration

9. Advanced Build Management

9.1. Build Artifacts

9.1.1. Local deployment space

9.2. Supported Build Artifacts

9.2.1. Maven 2
9.2.2. Ant
9.2.3. Shell

9.3. Build Descriptors (Definitions)

9.4. Artifacts vs. Descriptors

9.5. Build Properties

9.5.1. Built-in Properties
9.5.2. Standard Properties
9.5.3. Build Execution Properties
9.5.4. Maven 2-specific Properties
9.5.5. Ant-specific Properties
9.5.6. Shell-specific Properties

9.6. Working Directory

9.7. Auto-recognition of Build Artifacts

9.8. How to Build Specific Types of Projects

9.8.1. Eclipse Projects
9.8.2. Maven 1 Projects

9.9. Branched Artifacts

9.10. Maven-specific Information

9.10.1. Maven Profiles
9.10.2. Maven Proxy
9.10.3. Maven Repositories
9.10.4. Comparison with Stand-alone Maven
9.10.5. Under the Hood

9.11. Scheduled Builds

9.12. Integration Builds

10. Configuring Notifications

10.1. Accessing the configuration file

11. Configuring Announcements

11.1. Accessing the configuration file

11.1.1. Adding Security Permissions to Announcements

12. Configuring "My Hats"

12.1. Understanding the Configuration Files and Process

12.1.1. Configuration Directories and Files
12.1.2. Constraining Hats by User Role
12.1.3. Process Overview

12.2. Modifying an Existing Hat Configuration

12.3. Creating a New Hat Configuration

12.3.1. Example Configuration

13. Creating Scheduled Jobs

13.1. Defining and Modifying Jobs

13.1.1. Accessing the configuration file

13.2. Starting and Stopping the Scheduler

13.3. Scheduling Jobs to Run Immediately

13.4. Viewing Jobs in the Monitor

14. Backing up Polarion Data

14.1. References to installation locations.

14.1.1. Variables and equivalent paths

14.2. Project Builds

14.3. Reports

14.4. User-modified data

14.4.1. Polarion Configuration File
14.4.2. Modified installation structure

14.5. Backup Tips for Polarion Server

15. Configuring SSL Support

15.1. Installation Process
15.2. Additional Resources

16. Indexing and Reindex

16.1. Index Synchronization

16.1.1. When to Repair the Index
16.1.2. How to Rebuild the Index

17. System Tuning for Advanced Administrators

2. User Guide

1. Portal Tour

1.1. Polarion Header

1.2. Navigation Zone

1.2.1. The Perspectives

1.3. The Work Zone

1.3.1. Search Bar

1.4. Portal Footer

1.5. Frequently Used Topics

1.5.1. Work Items Topic
1.5.2. Overview Topic
1.5.3. Quality Topic

2. Getting Started with Projects

2.1. Creating Projects

2.2. Accessing Projects

2.2.1. Accessing Project Documents
2.2.2. Accessing Project Work Items

2.3. Exporting to MS Project

2.3.1. Opening the exported file in MS Project

2.4. Importing from Microsoft Project

3. Work Item Basics

3.1. Work Item Types

3.2. Browsing Work Items

3.2.1. Sorting Work Items
3.2.2. Customizing the Work Items Table
3.2.3. Using "My Hats"

3.3. Searching Work Items

3.3.1. Using the Query Builder
3.3.2. Query Language and Editing a Query
3.3.3. Stored and shared queries

3.4. Creating and Editing Work Items

3.4.1. Creating New Work Items
3.4.2. Editing Work Items

3.5. Common Operations with Work Items

3.5.1. Assigning a Work Item
3.5.2. Changing a Work Item's status
3.5.3. Adding Comments to a Work Item
3.5.4. Attaching Files to a Work Item
3.5.5. Voting
3.5.6. Viewing Work Item History
3.5.7. Setting and Removing Watches
3.5.8. Setting Planning Constraints
3.5.9. Printing Work Items

3.6. Linking Work Items

3.6.1. Linking individual Work Items
3.6.2. Linking Multiple Work Items at Once
3.6.3. Using the Matrix view to create and browse links
3.6.4. Creating Links in Multi Edit View
3.6.5. How Links are handled in Live Plan
3.6.6. Suspect Links
3.6.7. Work Item Hyperlinks

3.7. Exporting Work Items

3.7.1. Linked Work Items in Exports
3.7.2. Exporting the Hierarchical Table View
3.7.3. Exporting the Matrix View
3.7.4. Exporting to a Live Document

3.8. Work Item Actions

3.8.1. Duplicating a Work Item in the same project
3.8.2. Changing the Work Item Type
3.8.3. Duplicating a Work Item in a different project
3.8.4. Creating new Work Items and Links in a single operation

3.9. Creating and Comparing Baselines

3.9.1. Creating a Baseline
3.9.2. Comparing baselines

4. Polarion for Requirements Engineers

4.1. Overview of Capabilities

4.2. Inception Phase

4.2.1. Creating a New Requirement in the Portal
4.2.2. Working with Live Documents
4.2.3. Designing Requirements with Multi Edit

4.3. Revision Phase

4.3.1. Revising requirements using Live Documents

4.4. Approval Phase

4.4.1. Assigning Approver(s) to Work Items
4.4.2. Approving or Disapproving Work Items

4.5. About Live Document Templates

4.5.1. Working with Local Files

5. Polarion for Project Managers

5.1. Project Planning

5.1.1. Brief Overview
5.1.2. Updating the Live Plan
5.1.3. Understanding Live Plan Scheduling
5.1.4. Setting up Work Items for Live Plan
5.1.5. Estimating Work Item Duration

5.2. Using Project Dashboards

5.2.1. Accessing the Main Project Dashboards

5.3. Generating Reports

5.3.1. Time and Progress Reports
5.3.2. Reviewing Baselines and Baseline Reports
5.3.3. Generating and Reviewing Work Reports
5.3.4. CMMI Report

6. Polarion for Developers

6.1. Accessing Projects

6.2. Locating your Work Items

6.2.1. Using Search to find Work Items
6.2.2. Using Shortcuts to locate Work Items
6.2.3. Using Topics to locate Work Items

6.3. Common Tasks and Operations

6.3.1. Viewing and Editing a Work Item
6.3.2. Estimating Work Item Time
6.3.3. Reporting Time for Individual Work Items
6.3.4. Using the Time Sheet View
6.3.5. Work Item Discussion and Comments
6.3.6. Resolving or Closing a Work Item
6.3.7. Working with Builds
6.3.8. Working with Tests
6.3.9. Viewing source code and documentation

6.4. Configuring your Working Calendar

6.4.1. Accessing your Working Calendar
6.4.2. Editing your Working Calendar

7. Collaborating Via Wiki

7.1. Accessing the Wiki

7.2. Getting Started with Wikis

7.2.1. Creating a New Wiki Space
7.2.2. Navigating Between Wiki Spaces

7.3. Common Wiki Operations

7.3.1. Adding a New Wiki Page
7.3.2. Updating Existing Wiki Pages
7.3.3. Working with Attachments

7.4. Editing Wiki Pages

7.4.1. Switching Editors
7.4.2. Using the Rich Text Editor
7.4.3. Using the Wiki Editor

7.5. Searching the Wiki

7.5.1. Using Global Search
7.5.2. Searching Across Wiki Pages

7.6. Working with Wiki History

7.6.1. Finding a Specific Revision
7.6.2. Rolling Back Changes
7.6.3. Download Attachments from a Revision

7.7. Wiki Administration Operations

7.7.1. Deleting a Wiki Page
7.7.2. Deleting a Wiki Space

A. Polarion Reference

1. Administration Reference

1.1. Polarion Folder Structure

1.1.1. Windows structure
1.1.2. Linux structure
1.1.3. Common folders

1.2. Polarion System Processes

1.3. Scheduler cron information and examples

1.4. Enumerations

1.4.1. Existing enumerations

1.5. Standard Work Item Fields

1.6. Default Roles and Permissions

1.7. Permissions Configuration

1.8. Project templates

1.9. Custom Field Types

1.9.1. List of Supported Types

1.10. Building configuration file format

1.11. Work Report Job Configuration

1.11.1. Job Parameters
1.11.2. Configuration Example

1.12. Workflow Conditions and Functions

1.12.1. LinkedWorkItemStatus
1.12.2. LinkedWorkItemsStatusChange
1.12.3. FieldValueChange
1.12.4. LinkedWorkItemType
1.12.5. FieldNonEmpty

1.13. Polarion Log Files

1.14. Apache Log Files

2. Team Credits

B. Polarion User Reference

1. Polarion Header

1.1. Home Link
1.2. User Profile link
1.3. Logout link
1.4. Help link
1.5. About link
1.6. Minimize/Maximize Icon
1.7. Site Search

2. Polarion footer

3. Projects Perspective

3.1. Projects Portlet

3.1.1. Title Bar
3.1.2. Filter Combo-box

3.2. Shortcuts Portlet

3.2.1. Title Bar Icons
3.2.2. Default Shortcuts

3.3. Topics Portlet (Projects Perspective)

3.3.1. Topics for Repository
3.3.2. Topics for Project Group
3.3.3. Topics for Project

4. Repository Perspective

4.1. Projects Portlet

4.1.1. Projects Portlet Title Bar
4.1.2. Filter Combo-box
4.1.3. Repository Node
4.1.4. Directories

4.2. Browser Portlet

4.2.1. Browser Portlet Title Bar
4.2.2. Path Bar
4.2.3. Info View
4.2.4. Content Table

5. Administration Perspective

5.1. Administration Perspective Portlets

5.1.1. Projects Portlet
5.1.2. Topics Portlet (Administration Perspective)

5.2. Administration Topics

5.2.1. Topic: Projects
5.2.2. Topic: User Management
5.2.3. Portal
5.2.4. Topic: Work Items
5.2.5. Topic: Reports
5.2.6. Topic: Building
5.2.7. Topic: Notifications
5.2.8. Announcements
5.2.9. Topic: Scheduler

6. Dashboards

6.1. Topic: Overview

6.1.1. Overview: Repository
6.1.2. Overview: Project Group
6.1.3. Overview: Project
6.1.4. Overview: Portlet Descriptions

6.2. Topic: Dashboard

6.2.1. Scope: Entire Repository
6.2.2. Scope: Entire Project Group
6.2.3. Scope: Individual Project
6.2.4. Dashboard Topic: portlet descriptions

6.3. Quality Dashboard

6.3.1. Quality - Work Items
6.3.2. Quality - Process
6.3.3. Quality - Testing
6.3.4. Quality - CMMI

List of Figures

1.1. Accessing configuration files
1.2. Project configuration
1.3. New Project
1.4. New Project
1.5. New Project
1.6. Accessing the Workflow Designer
1.7. Graphical Workflow Designer
1.8. Saving a Shortcut
2.1. Polarion Portal Layout
2.2. Navigation Portlets in Perspectives
2.3. View Tabs
2.4. Table view
2.5. Live Plan View
2.6. Road Map View
2.7. Multi Edit View
2.8. Matrix view
2.9. Time Sheet view
2.10. Work Item Selections
2.11. Linking to Another Work Item
2.12. The Quality Topic
2.13. Viewing Project Documents
2.14. Work Items
2.15. Creating a Shortcut
2.16. Export
2.17. Table Configuration Dialog
2.18. Search Bar
2.19. Query Builder
2.20. Polarion Portal Layout
2.21. Stored Queries
2.22. Work Item Linking
2.23. Matrix View Search
2.24. Matrix View Toolbar
2.25. Stable project with linked Work Items
2.26. Work Item changes at Level 1
2.27. Work Item changes at Level 2
2.28. Suspect Link
2.29. Quick-create New Linking Work Item
2.30. Quick-create New Linking Work Item
2.31. Awaiting Approval
2.32. Setting Planning Constraints
2.33. Create Work Report Dialog
2.34. Time Sheet view
2.35. Linking to a Repository Revision
2.36. Creating a revision link via SVN commit messages
2.37. Builds and Build Details
2.38. Test information
B.1. Polarion Header

List of Tables

1.1. Custom fields configuration files
1.2. Work Item Fields and Enumeration Configuration Files
1.3. Fields that can be displayed as Table view columns
2.1. Queries for items that link TO a specified Work Item
2.2. Queries for items that are linked BY a specified Work Item
A.1. cron expressions for jobs
A.2. Examples of cron Expressions
A.3. Default Work Item Fields
A.4. Default Roles and Permissions
A.5. Hall of Fame
B.1. Default Shortcuts
B.2. Main Report Nodes in Project Topics Portlet
B.3. Notification Targets
B.4. Overview Portlet Fields

List of Examples

1.1. Repository Root Path

		Next
		Welcome