5. Administration Perspective

Navigation: Main navigation panel, perspective selectors at the bottom: Administration.

Important Access Note

The Administration perspective is only accessible in the Polarion user interface if you have administration rights. If you have such rights for the repository, the Administration perspective selector will always be visible in the navigation panel when you log in to Polarion. If you have administration rights only for a specific Project, the Administration perspective selector will only appear in the navigation panel when you access (i.e., select in the Projects portlet) the project(s) for which you have been granted administration rights.

This perspective provides access to all Polarion administration, configuration, and customization features, including definition and management of projects, managing user accounts, and customizing workflow. This documentation is mainly reference information for the Administration user interface. For information about the various administration and configuration features and how to work with them, see the Administrator's Guide.

5.1. Administration Perspective Portlets

This section describes the main portlets of the Administration perspective.

5.1.1. Projects Portlet

Displays the directory structure of the repository and each project defined in the repository. Enables access to administrative and configuration functions for the repository, or for a selected project. The following sections describe the components of the portlet.

5.1.1.1. Projects Portlet Title Bar

Displays the portlet title "Projects" the following icons:

  • Refresh: forces a refresh of the portlet's data display.

  • Create new project: launches a screen where you can begin creating a new project in the repository

  • Flat/Hierarchical: toggles the way the data appears in the portlet.

  • Help: launches the Help topic for the portlet.

5.1.1.2. Filter Combo-box

This control enables you to filter the list of projects displayed in the portlet. The default option is All Projects. When selected, the portlet lists all projects and project groups in the repository. The other options filter the list for a subset of all projects:

  • My Projects: When selected, the portlet displays only those projects for which the currently logged-in user has a role.

  • Selected Projects: When selected, an ellipsis button appears next to the Filter combo-box. Clicking it launches the Select Visible Projects dialog. This dialog presents a tree view of all project groups and the projects they contain. Each node has a check-box. By default, all nodes are checked, meaning that the respective project group or project is visible in the Projects portlet. Clear the check-box of any project group or project that you do not want to appear in the portlet. (Clearing the check-box for a project group unchecks the nodes of all the projects it contains, meaning none of them will appear in the portlet.)

5.1.1.3. Repository Node

When selected displays a table of all projects defined in the repository in the working area. From there you can browse into the projects' structure.

5.1.1.4. Directories

Displays the directories in the repository, either flat or hierarchically depending on toggle in the portlet title bar. Selecting a directory displays contents in the Browser portlet in the working area, and from there you can browse into the structure of any project directory.

5.1.2. Topics Portlet (Administration Perspective)

The Topics portlet provides access to the topics for the various administration and configuration features of Polarion. Subsequent sections describe each of the Topics,the functionality available, and the scope(s) in which the functionality is applicable (i.e. repository-wide or project-specific).

5.2. Administration Topics

This section documents the topics found in the Topics portlet of the Administration perspective. Note that some topics are available in both the repository scope, and the project scope, some are only in the repository scope, and some are only in the project scope. The applicable scope of the each topic is noted in its description.

5.2.1. Topic: Projects

Scope: Repository

This topic provides access to creation, configuration, and customization of projects. It contains the sub-topic also named Projects.

5.2.1.1. Projects

Selecting this topic displays a table of all projects in the repository. The table appears in the upper half of the working area.

Available functionality:

  • Create new project

  • Mark a repository folder as a project - places a directory tree under Polarion's management

  • Edit properties of the currently selected project - Description, for example.

  • Unmark - in effect, removes the currently selected project's folder tree from management by Polarion.

  • Delete the selected project from the repository.

5.2.2. Topic: User Management

Scope: Repository or Project

This topic provides access to all user management and user administration features of Polarion. These are provided in several sub- topics:

5.2.2.1. Users

Scope: Repository or Project

This topic provides access to user accounts and related management and administrative operations.

Available functionality:

  • Create new user account

  • Search for user account

  • Browse user accounts

  • Edit selected user account

  • View details of selected user account including current system and project Roles, Watches, Votes, and Queries.

  • Delete selected user account. Note that account deletion is not available if and data in the system references a given user account. In such case, removing the user information would invalidate history, traceability, etc.

  • Upload a working calendar configuration file customized for the selected user.

See also: Administrators Guide: User Management.

5.2.2.2. Roles

Scope: Repository only

This topic enables you to view, define, and manage the Roles that can be assigned to users.

Available functionality:

  • View currently defined Roles

  • View users currently assigned each of the currently defined Roles.

  • Assign additional user(s) to any currently defined Role.

  • Add new Role(s)

  • Delete existing Role(s)

See also: Administrator's Guide: User Management: Configuring User Roles.

5.2.2.3. Project Roles

Scope: Project only

This topic enables you to view, define, and manage the Roles that can be assigned to users who have access to a project currently selected in the Projects portlet.

Available functionality:

  • View currently defined Roles

  • View project users currently assigned each of the currently defined Roles.

  • Assign additional user(s) to any currently defined project Role.

  • Add new Role(s) for the project

  • Delete existing Role(s)

See also: Administrator's Guide: User Management: Configuring User Roles.

5.2.2.4. Permissions

Scope: Repository or Project

This topic provides access to the security configuration which defines access rights.

For information about this configuration, see Administrator's Guide: Configuring User Permissions.

Available functionality:

  • Clear cached access permission data

  • Refresh cached access permission data from the configuration file

  • View the global/project security configuration file in browser

  • Download a copy of the global/project security configuration file to local file system

  • Upload a modified version of the global/project security configuration file from local file system to repository

5.2.2.5. Autocreate Configuration

Scope: Repository only

This topic provides access to the global configuration which defines whether or not new users are auto-created from LDAP data.

For information about this configuration, see Administrator's Guide: Configuring LDAP Auto-create.

Available functionality:

  • View the autocreate configuration file in browser

  • Download a copy of the autocreate configuration file to local file system

  • Upload a modified version of the autocreate configuration file from local file system to repository

5.2.2.6. LDAP Configuration

Scope: Repository only

This topic provides access to the global configuration which defines data mapping from an LDAP server to Polarion user accounts.

For information about this configuration, see Administrator's Guide: Configuring Polarion to Work with LDAP

Available functionality:

  • View the LDAP mapping configuration file in browser

  • Download a copy of the LDAP mapping configuration file to local file system

  • Upload a modified version of the LDAP mapping configuration file from local file system to repository

5.2.3. Portal

Scope: Repository or Project

This topic provides access to these sub-topics for customizing and configuring the Polarion portal and dashboards:

5.2.3.1. Overview

Scope: Repository or Project

This topic provides access to the global or project-specific Overview portlet configuration. Select the scope the Projects portlet.

Available functionality:

  • View the Overview portlet configuration file for the selected scope in your web browser.

  • Edit the Overview portlet configuration on line in the Polarion portal web interface, save or cancel changes.

  • Download a copy of the Overview portlet configuration file for the selected scope to local file system for editing off line.

  • Upload a modified version of the Overview portlet configuration file for the selected scope from local file system to the portal.

5.2.3.2. Dashboard

Scope: Repository or Project

This topic provides access to the global or project-specific Dashboard portlet configuration. Select the scope the Projects portlet.

Available functionality:

  • View the Dashboard portlet configuration file for the selected scope in your web browser.

  • Edit the Dashboard portlet configuration on line in the Polarion portal web interface, save or cancel changes.

  • Download a copy of the Dashboard portlet configuration file for the selected scope to local file system for editing off line.

  • Upload a modified version of the Dashboard portlet configuration file for the selected scope from local file system to the portal.

5.2.3.3. Project Overview

Scope: Repository

This topic provides access to the default configuration of the Overview portlet for all projects without a project-specific configuration.

Available functionality:

  • View the Project Overview portlet configuration file for the selected scope in your web browser.

  • Edit the Project Overview portlet configuration on line in the Polarion portal web interface, save or cancel changes.

  • Download a copy of the Project Overview portlet configuration file for the selected scope to local file system for editing off line.

  • Upload a modified version of the Project Overview portlet configuration file for the selected scope from local file system to the portal.

5.2.3.4. Project Dashboard

Scope: Repository

This topic provides access to the default configuration of the Dashboard portlet for all projects without a project-specific configuration.

Available functionality:

  • View the Project Dashboard portlet configuration file for the selected scope in your web browser.

  • Edit the Project Dashboard portlet configuration on line in the Polarion portal web interface, save or cancel changes.

  • Download a copy of the Project Dashboard portlet configuration file for the selected scope to local file system for editing off line.

  • Upload a modified version of the Project Dashboard portlet configuration file for the selected scope from local file system to the portal.

5.2.3.5. Shortcuts

Scope: Repository or Project

This topic provides access to the global or project-specific Shortcuts portlet configuration. Select the scope the Projects portlet.

Available functionality:

  • View the Shortcuts portlet configuration file for the selected scope in your web browser.

  • Edit the Shortcuts portlet configuration on line in the Polarion portal web interface, save or cancel changes.

  • Download a copy of the Shortcuts portlet configuration file for the selected scope to local file system for editing off line.

  • Upload a modified version of the Shortcuts portlet configuration file for the selected scope from local file system to the portal.

5.2.4. Topic: Work Items

Scope: Repository or Project

This topic provides access to all configuration and customization functionality for Work Items. Select the scope of the configuration in the Projects portlet.

Available subtopics:

For more information, see Administrator's Guide: Configuring Work Items,

5.2.4.1. Time Points

Scope: Project only]

This topic provides a GUI for defining and managing Time Points in a project selected in the Projects portlet. For more information about this configuration, see Administrator's Guide: Time Points, and User Guide: Project Planning, Setting Up Work Items for Live Plan, and Time Points.

Available functionality:

  • Create new Time Point

  • View list of currently defined Time Points and their main attributes

  • Edit an existing Time Point

  • Delete an existing Time Point

5.2.4.2. Categories

Scope: Project only

This topic provides a GUI for defining and managing Categories for a project selected in the Projects portlet.

For more information about this configuration, see Administrator's Guide: Configuring Categories.

Available functionality:

  • Create a new Category

  • View a list (including count) of currently defined Categories and their main attributes

  • Edit an existing Category

  • Delete an existing Category

5.2.4.3. Custom Fields

Scope: Repository or Project]

This topic provides access to the global or project-specific configuration files which define custom fields for the different types of Work Items. Select the configuration scope in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Custom Fields. For information on supported field types see Polarion Reference: Administration Reference: Custom Field Types.

Available functionality:

  • Clear custom fields data from system cache

  • View the default global Custom Fields configuration files for any Work Item type in browser

  • Download a copy of the default, or any customized version of the Custom Fields configuration files for different Work Item types to local file system

  • Upload a customized copy of the default, or any previously-downloaded custom version of the Custom Fields configuration files for different Work Item types to local file system

5.2.4.4. Enumerations

Scope: Repository or Project

This topic provides access to the configuration files that define values for various enumerations used in different data fields in the system, particularly for Work Items. For example, you can customize the values for such things as statuses, priorities, and severities. Select the scope of the configuration in the Projects portlet

For more information on this configuration, see Administrator's Guide: Enumerations

Available functionality:

  • Clear enumerations data from the system cache

  • View any of the configuration files in your browser

  • Download any of the available configuration files, default or customized versions, to your local system

  • Upload a customized version of the available configuration files, default or customized versions, from local system to repository

5.2.4.5. Work Flow

Scope: Repository or Project

This topic provides access to the configuration files that define workflow for all Work Items collectively, and for specific Work Item types. Select the scope of the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Workflow.

Available functionality:

  • View any of the configuration files in your browser

  • Download any of the available configuration files, default or customized versions, to your local system

  • Upload a customized version of the available configuration files, default or customized versions, from local system to repository

5.2.4.6. Table Configuration

Scope: Repository or Project

This topic provides access to the configuration file that controls what data (columns) appear in the Table view for Work Items. Select the scope of the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Table View.

Available functionality:

  • View the Table View configuration file in browser

  • Download a copy of the default, or any customized version of the Table View configuration file to local file system

  • Upload a customized copy of the default, or any previously- downloaded custom version of the Table View configuration file to local file system

5.2.4.7. Queries

Scope: Repository or Project

This topic provides access to the configuration file that stores saved queries for the scope currently selected in the Projects portlet.

Note that there is a GUI for this configuration: choose Customize Saved Queries in the And field of the Search bar in various Work Item views (Table, Tree, etc.)

For more information on this configuration, see Administrator's Guide: Queries.

Available functionality:

  • View the Queries configuration file for the selected scope in browser

  • Download a copy of the Queries configuration file for the selected scope to local file system

  • Upload a modified version of the Queries configuration file for the selected scope from local file system to repository

5.2.4.8. Shortcuts

Scope: Repository or Project

This topic provides access to the configuration file that stores Shortcuts for the scope currently selected in the Projects portlet. Shortcuts are name queries that can be saved in different scopes.

Note that Shortcuts can be created or deleted via the GUI : Use the Query Builder to create the query that provides the desired results, run that query, and save it as a Shortcut. For more information see User Guide: Using Queries and Shortcuts.

For more information on this configuration, see Administrator's Guide: Shortcuts.

Available functionality:

  • View the Shortcuts configuration file for the selected scope in browser

  • Download a copy of the Shortcuts configuration file for the selected scope to local file system

  • Upload a modified version of the Shortcuts configuration file for the selected scope from local file system to repository

5.2.4.9. Working Calendar

Scope: Repository

This topic provides access to the configuration page that defines the global Working Calendar parameters (i.e. the "normal" work schedule plus any exceptions, for the entire organization). Here you can configure which days and hours are normal working and non-working days/hours, plus exceptions such as holidays. Note that you can configure each user's personal Working Calendar in the User Management : Users topic. Individual users may also edit their own working calendars from their profile page. For more information, see Administrator's Guide: Working Calendar, and User Guide: Configuring your Working Calendar.

Available functionality:

  • View the global Working Calendar configuration.

  • Modify the global Regular Schedule and/or Schedule Exceptions configurations.

  • Save changes to the global Working Calendar Configuration or cancel changes in progress.

  • Refresh the view of the global Working Calendar.

5.2.4.10. Planning

Scope: Repository or Project

This topic provides access to the configuration file that defines certain defaults related to the planning of Work Items. For example, you can configure the default time estimate value. Select the scope for the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Planning.

Available functionality:

  • View the Planning configuration file for the selected scope in browser

  • Download a copy of the Planning configuration file for the selected scope to local file system

  • Upload a modified version of the Planning configuration file for the selected scope from local file system to repository

5.2.4.11. Linking

Scope: Repository or Project

This topic provides access to the configuration file that controls default values for Work Item linking. Here is where you can set the default value controlling whether or not new Work Items are automatically flagged as suspect. Select the scope for the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Linking.

Available functionality:

  • View the Linking configuration file for the selected scope in browser

  • Download a copy of the Linking configuration file for the selected scope to local file system

  • Upload a modified version of the Linking configuration file for the selected scope from local file system to repository

5.2.4.12. Voting

Scope: Repository or Project

This topic provides access to the configuration file that enables the Voting feature and sets voting limits. Select the scope for the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Voting.

Available functionality:

  • View the Voting configuration file for the selected scope in browser

  • Download a copy of the Voting configuration file for the selected scope to local file system

  • Upload a modified version of the Voting configuration file for the selected scope from local file system to repository

5.2.4.13. Autoassignment

Scope: Repository or Project

This topic provides access to the configuration file that enables automatic assignment of new Work Items and defines how and to whom they are assigned. Select the scope for the configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Auto-assignment.

Available functionality:

  • View the Autoassignment configuration file for the selected scope in browser

  • Download a copy of the Autoassignment configuration file for the selected scope to local file system

  • Upload a modified version of the Autoassignment configuration file for the selected scope from local file system to repository

5.2.5. Topic: Reports

Scope: Repository or Project

This topic provides access to the global configuration file in which Maven reports and report parameters are defined. Select the scope of this configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Configuring Reportsand also refer to comments in the default global configuration file.

Available functionality:

  • View the Maven reports configuration file for the selected scope in browser

  • Download a copy of the Maven reports configuration file for the selected scope to local file system

  • Upload a modified version of the Maven reports configuration file for the selected scope from local file system to repository

5.2.6. Topic: Building

Scope: Repository or Project

This topic provides access to the configuration file in which Polarion build descriptors are defined. Select the scope of this configuration in the Projects portlet.

For more information on this configuration, see Administrator's Guide: Configuring Building and also refer to comments in the default global configuration file.

Available Functionality:

  • View the build descriptor configuration file for the selected scope in browser

  • Download a copy of the build descriptor configuration file for the selected scope to local file system

  • Upload a modified version of the build descriptor configuration file for the selected scope from local file system to repository

5.2.7. Topic: Notifications

Scope: Repository or Project

This topic provides access to configurations that control how Polarion's user notification features work. The following subtopics are available for the scopes indicated:

5.2.7.1. Targets

Scope: Repository or Project

This topic provides access to the configuration file in which defines the events that trigger notifications ("work item created", "work item updated" for example), and also specifies the classes of users who receive notifications on each event ("current assignee", "all watchers", for example). Select the scope of this configuration in the Projects portlet.

For more information on this configuration, refer to Administrator's Guide: Configuring Notifications.

Available functionality:

  • View the notification targets configuration file for the selected scope in browser

  • Download a copy of the notification targets configuration file for the selected scope to local file system

  • Upload a modified version of the notification targets configuration file for the selected scope from local file system to repository

5.2.7.2. Configuration

Scope: Repository only

This topic provides access to the configuration file in which you can configure global settings for notifications including:

  • Prefix used in the Subject line of email notifications

  • Sender address of email notifications

  • SMTP host to be used for notifications

For more information on this configuration, refer to Administrator's Guide: Configuring Notifications and also see comments in the default global configuration file..

Available functionality:

  • View the notification configuration file for the selected scope in browser

  • Download a copy of the notification configuration file for the selected scope to local file system

  • Upload a modified version of the notification configuration file for the selected scope from local file system to repository

5.2.7.3. Notification Targets Reference Information

Targets settings in the configuration files are defined between <notification-config> </notification-config> tags.

Notification events are defined in <event_name></event_name> tags. The following events (and appropriate values of the <event_name> tag) are defined:

Table B.3. Notification Targets

Event Name [code]Description
backlinked-workitem-updatedA work item, which links the given work item was updated. For example, WI-1 links WI-2. WI-1 gets updated, then backlinked-workitem-updated event is triggered, allowing i.e. the W-2 assignee to be notified. Can be configured per link role
linked-workitem-updatedA work item linked by the given one, was updated. For example, WI-1 links WI-2. WI-2 gets updated, then linked-workitem-updated event is triggered, which allows i.e. the WI-1 assignee to be notified. Can be configured per link role.
project-builtA build of the project has been finished
revision-linkedA Work Item ID is present in a SVN commit message. It does not apply for revisions explicitly linked from a Work Item - such links generate the linked-workitem-updated event.
workitem-assignedAn assignee of the work item was changed from none to some value
workitem-attachment-addedAn attachment was added to the work item
workitem-attachment-removedAn attachment of the work item was removed
workitem-attachment-updatedAn attachment of the work item was updated
workitem-commentedA comment was added to the work item
workitem-createdA work item was created
workitem-deletedA work item was deleted
workitem-linkedThe given work item was added to / removed from linked work items set of another work item. Can be configured per link role.
workitem-status-changedA workflow action was performed on the work item
workitem-updatedOther (unrecognized) change was done to work item. workitem-updated event is also triggered when another work item gets a link to this one.
workitem-vote-addedA vote has been added to the work item
workitem-vote-removedA vote has been removed from the work item
workitem-watcher-addedA watcher has been added to the work item
workitem-watcher-removedA watcher has been removed from the work item

Notifications are prioritized so that only one notification is sent to each user about a change. For example, adding an attachment and a comment will result in just one attachment notification if email is the target of both. However the one notification will cover all changes.

Once you have specified notification event you can add a notification target for the event using the following tags:

  • <current-assignee/> - The assignee of the Item. If assignee is changed during the action, both the original and the new assignee will receive notification.

  • <current-author/> - author of the Work Item.

  • <current-user/> - the currently logged-in user (the one who has made the change).

  • <single-email email="email@address"/> - notification will be sent to the given e-mail address.

  • <single-user user-id="polarion_user_id"/> - notification will be sent to the specified user.

  • <all-watchers/> - all users who have been set as watchers of the Work Item.

  • <project-lead> - user defined as the lead of the project to which the event belongs.

  • <project-members> - all users who have any role in the project to which the event belongs.

  • <all-voters> - all users who have voted for the Work Item.

Each user will receive only one notification if s/he falls in multiple categories - that is, both assignee and current user. Please note that not all targets may be used for every event. For example, it makes no sense to use the assignee target for a project-built event.

The linked work items related events (tag <workitem-linked></workitem-linked>) support the roles attribute, which can limit the event configuration to particular roles (comma separated). If the attribute is missing, then all roles are accepted. Only the first matching configuration for the specified role is used.

Here is an example of a linked Work Item roles definition:

<workitem-linked roles="contains,relates_to">

<current-assignee/>

</workitem-linked>

<workitem-linked roles="implements">

<current-author/>

</workitem-linked>

<workitem-linked roles="implements,contains">

<current-author/>

</workitem-linked>
                      

The above fragment will cause the assignee to be notified when his/her Work Item is marked as contained by, or some other Work Item is marked as related to him. When an implements link is added, then the author of implemented Work Item is notified. The third fragment will never be used, because the given roles are already covered by the above entries.

This example will send notification to the Work Item's current assignee when the Work Item is updated:

<?xml version="1.0" encoding="UTF-8"?>

<notification-config>

<workitem-updated>

<current-assignee />

</workitem-updated>

</notification-config>
                      

5.2.8. Announcements

Scope: Repository only

This topic provides access to the configuration file which defines the content of the Announcements portlet of the Repository Dashboard. The announcements configuration file uses the RSS 2.0 XML schema. However, the RSS 2.0 specification is not fully supported by the Announcements viewer. CDATA in the <description> is not currently supported, for example.

For more information on this configuration, see Administrator's Guide: Configuring Announcements.

Available functionality:

  • View the announcements.rss configuration file in browser

  • Download a copy of the announcements configuration file to local system

  • Upload a modified copy of the announcements configuration fie from local system to repository

Important Note for Windows Users

When you download the announcements.rss file to a local system running Windows XP, Windows will rename the file with a different extension. Before uploading modifications to Polarion, you will need to rename the file back to the original name: announcements.rss.

5.2.9. Topic: Scheduler

Scope: Repository

This topic provides access to the configuration file which defines scheduled jobs such as portlet refreshes, metrics recalculation, and builds, and also the schedule on which they are run by means of cron expressions. It also enables you to stop or start the scheduler

For more information on this configuration, see Administrator's Guide, Scheduled Jobs. See also extensive comments in the default global configuration file.

Available functionality:

  • View the job scheduling configuration file in browser

  • Download a copy of the job scheduling configuration file to local system

  • Upload a modified copy of the job scheduling configuration fie from local system to repository

  • Start the Scheduler if it is stopped

  • Stop the Scheduler if it is not currently stopped (stops running Jobs)