19. Polarion for Developers

This chapter of the Polarion User Guide provides information about Polarion features and common tasks that are of interest mostly for software developers. Of course some features and topics may overlap with information for project managers or system administrators. In such cases, this chapter may contain only a cross reference to information elsewhere in the documentation.

If you are new to Polarion and haven't already read through the Portal Tour chapter, you might want to do that before going further in this chapter because here there will be references to the navigation and other user interface elements covered in the Quick Tour.

Accessing Projects and Work Items

This section explains how to access projects in your Polarion portal, and the Work Items (tasks, change requests, etc.) that you and others need to process.

Accessing Projects

When you log in to Polarion, the first thing you normally see is the Repository Home page. (At least this is the case in a default installation. Depending on the way your Polarion administrator has set up the system and your system permissions it is possible you could see something different.)

As a developer, you will need to access one or more Projects. In order to be able to do that, you of course need a Polarion user account, but you must also be assigned a role in each Project you have access to. Project roles are assigned by a Polarion administrator. (See Administrator's Guide: Configuring User Roles). Once you are set up administratively, you need to navigate to the Project you want to work on.

The projects being managed with Polarion are listed in the All Projects tab of the Open Project or Project Group dialog. Depending on how projects are organized in your system, the project you are seeking may be a top-level node in the dialog, or it may be under a project group or even a Project Sub-group. (You should be familiar with the organization of your system. For more information see User Guide: Accessing Projects.)

When you locate the project in the Open Project or Project Group dialog, select it and click OK. The project's Home page will begin loading in your browser. You can either wait for it to load so you can review its information, or you can immediately begin navigation to the Work Items topic, or any other topic in the Navigation pane.

Note

Some Polarion systems may be configured to run multiple Polarion servers, and you may be assigned to projects hosted on different servers. On such systems, when you log in you can select which server you want to log into:

Figure 19.1. Server Selection

Server Selection

You can select the server to access when logging in

While working in a project on one server, you can switch to a project hosted on a different server. In the topics view of Navigation, click the current project name, then click Open Project or Project Group. In the dialog, the available servers are listed under Switch to Servers.

Figure 19.2. Switching Polarion Servers

Switching Polarion Servers

You can switch servers while working in the portal

Locating your Work Items

As previously mentioned, "Work Items" are issues you and others need to process to complete the project. Work Items are of different types representing different artifacts. For software development, common types include Requirement, Defect, Change Request, and Task. The types and their definitions are fully configurable, both globally and for each project, so you may see different types in projects you work on.

There are three basic ways you can locate Work Items:

  • Use Search features

  • Use Shortcuts

  • Use Topics

Using Search to find Work Items

If you know the ID of the Work Item you want, or some text in its description, you may be able to get to it quickly using the Site Search in the Polarion header.

Using Shortcuts to locate Work Items

You can use the shortcuts topics in the main navigation panel to access some subset of Work Items. By default, the Global Shortcuts topic contains a shortcut named My Work Items which accesses all unresolved Work Items assigned to you and displays them in the Table view of the Work Items topic. Other shortcuts pull up other sets of Work Items. You can create your own shortcuts from queries you build using the Query Builder in the Table view of the Work Items topic. (See Searching Work Items.)

Once you have accessed a set of Work Items with a Shortcut, you can use the Query Builder in the Table and other Work Item views to refine the list of Work Items. (See Searching Work Items.)

Using Topics to locate Work Items

The Navigation pane contains navigational links that pull up sets of Work Items. The Work Items topic accesses all Work Items of all types in the project. Beneath this link are several others which may vary according to configuration/customization of your system. By default, the following links are present:

  • Task: accesses all project Work Items of Task type

  • Change Request: accesses all project Work Items of Change Request type

  • Requirement: accesses all project Work Items of Requirement type

Note

The Work Item types may be different depending on the project template used to instantiate the project and/or any project-specific customization that may have been done.

The list of Work Item types is configurable by a Polarion administrator, so you may see other items such as Defect or Feature Request which correspond to Work Item types custom configured for your system. (See Administrator's Guide: Configuring Work Items.) In every case, clicking on one of these items should access all project Work Items of the respective type.

Once you have accessed a set of Work Items with a Topic, you can use the Query Builder in the Table and other Work Item views to refine the list of Work Items.