Direkt zum Hauptinhalt

Admin Info

EN | Administrator Guide for Configuring the UPPS! Extension WorkItem Hider (WH)


Overview

Who is this documentation for?

This documentation is intended for system or project administrators responsible for configuring the UPPS! WorkItem Hider (WH).

Prerequisites

Before reading this documentation, you should be familiar with basic Polarion project administration.

What you will learn

After reading this documentation, you will be able to configure the behavior and functionality of the WorkItem Hider for specific projects individually.

Introduction

Documentation is most effective when it is available directly at the point of use. In Polarion, document templates often include help or comment Work Items that guide users when creating or editing Work Items in derived documents.

However, when a document is created from such a template, these help/comment Work Items appear alongside the actual Work Items. In documents with extensive guidance, this can clutter the structure and reduce readability. Deleting the help/comment Work Items improves the overview, but doing so too early may remove valuable guidance that is still needed later.

The WorkItem Hider solves this problem by allowing help and comment Work Items to be shown or hidden as needed, without deleting them.

Instructions for configuration

Configuration scope

TBD

Specify Hideable WorkI tems Query

Here you can define a query that identifies all WorkItems considered hideable. These Work Items are indicated by a menu icon in the LiveDoc Editor view of the corresponding LiveDoc. In the editor, you can hide a WorkItem by left-clicking the icon, or open additional actions by right-clicking it.


The field accepts any WorkItem query that can be created in the WorkItem Tracker. To obtain the query text, create your query in the WorkItem Query Builder. Then click the small caret (triangle) at the right end of the input field to open the context menu, and select Convert to Text in the upper-right corner. Copy the resulting text and paste it into the field above to define which WorkItems can be hidden.