Direkt zum Hauptinhalt

Admin Info

Customize UPPS! Extension LS to your or - even better - to your organizational unit's needs

Overview

What is my appropriate role as a reader?

What should I already know?

What will I learn from reading? 

Table of contents

For technical reasons this wiki page does not contain an embedded table of contents.
Please use the navigation panel on the left-hand side of this page to navigate.

Overview

LS customization takes place separately for each individual Polarion project. Administration permission is required for doing this.

image.png

image.png

At the very top of the LS customization page you see the following options and information:

image.png

Even if you save customizations made using this page by clicking the SAVE CONFIGURATON button nothing will change or happen in your Polarion project as long as you did not mark the Enable extension for this Project check box.

 

 

Customizing

Extra Fields Config

Contains specific configurations to control the behavior of the extension depending on the configuration and content of a WorkItem. 

image.png

  1. Scan for Workitem references in TestSteps Field.
    Enabling this may incur a significant performance penality in the execution of the Links Synchronizer job.
    This is due to the TestStep content currently being processed on the Java-level which takes significantly more time to process compared to SQL.
  2. Resolved Workltems are by default not processed.
    Enabling this option will scan for Workitem references in Workltems that are configured with a direct link rule and set the appropriate link role even if it is resolved, i.e has a resolution value set.
    Due to performance reasons, permission to modify Workltem links are not checked. Enable this option if you permit Workltem links to be modified on resolved Workltems.
  3. Resolved Workitems are by default not processed.
    Enabling this will scan for Workttern references in Workitems that are configured with a backlink rule and set the link role on the other Workitern even if it is resolved, i.e has a resolution value set.
    Due to performance reasons, permission to modify Workitem links are not checked. Enable this option if you permit Workitem links to be modified on resolved Workitems.

Extra Link Config

Polarion links can only reference a revision of a target WorkItem in a direct link and do not have the ability to do so with a backlink. So if a reference with a revision is added in the description of a source WorkItem, an action must be defined how the Links Synchronizer should behave when a reference with a revision is added and a backlink configuration would apply.

image.png

All Types

A general configuration that is used to create a link to a referenced WorkItem in a description. The rules set up here are used if no type-specific configuration has been set up for a WorkItem whose description is being evaluated or no type-specific filter could be applied.

Typed Configuration

A type-specific configuration used to link to a referenced WorkItem in a description. The rules set up are only used if a type-specific configuration has been set up for a WorkItem whose description is being evaluated and a type-specific filter applies.

image.png

Rule

A rule contains the information which link role should be used under which conditions. It contains a link role, a target project and target WorkItem types are specified on the left side of the rule. The target WorkItem types can be left empty if the target type is not relevant for that rule. In addition, the reference data types to the right of the rule for which the corresponding link role is to be used are also specified for these conditions.

Rule Priority

The number on the leftmost side of each rule in the general configuration or in any of the typed configuration indicates the order in which each rule is used to match a WorkItem reference and indicates which link role will be used if the sprcific rule configuration applies. You can change the order of the rules by using the up and down buttons to switch with the rule above and below, respectively.

Type Fallback

This configuration checks the "All Types" configuration as a fallback option. If it is not active, nothing is done if no rule applies, or links are removed that would otherwise match an "All Types" configuration.

image.png

Reserved Link Roles

A set of link roles used exclusively for this extension. All link roles listed in this section (automatically and manually set link roles) are matched with referenced WorkItems in the description of any WorkItem in the current project and handled according to the filters set above. Depending on whether a filter can be applied to referenced WorkItems and the associated link, the link will either be set, removed, or updated if changes need to be made.

It is strongly recommended to use only link roles that are used exclusively for this feature, since links are also removed when a reference is removed from or not found in a description.

Reference Data Type

Polarion differentiates between following reference data types with which workitems are embedded in a description.

  • Cross References:

    Cross References are special Polarion hyperlinks used to quickly navigate to the referenced WorkItem within a LiveDoc. They can be identified by the dashed underline under the WorkItem reference and can contain the outline number, type icon, id or title of the referenced WorkItem. A user-defined label may also be specified. Clicking such a link will shift the LiveDoc view into position of the referenced WorkItem.

  • Live Links:

    Live Links are special Polarion hyperlinks used to reference any WorkItem within a Polarion repository. It can contain the type icon, id or title of the referenced WorkItem. A user-defined label may also be specified. Clicking such a link will open the WorkItem in the Tracker view.

  • Hyperlinks:

    Hyperlinks behave like commonly known hyperlinks. These hyperlinks are by default displayed with their URL or alternatively with a user-defined label. In order for the extension to work for these hyperlinks, their URL must contain the base.url value of the polarion.properties configuration (the URL to the same Polarion server). Clicking such a link will open the URL in the same or a new browser tab.

Backlink 

image.png

  • If the created link on the other Workitem is deleted manually, the change cannot be detected by the Workiterm that references that Workiterm and the link will stay missing. This is a common technical hurdle arising from the use of backlinks. A regular update of all Workitems by the LS Job is therefore recommended.
  • If the other Workitem is in a foreign project, conflicts may arise between the LS configuration of the foreign project and this LS configuration.
  • There may also be problems with users who have different permissions in the respective projects that affect reading or writing Workiterns.
  • A revision of a Workitem reference is not supported for backlinks and is therefore not created by the extension, as the resulting state would be invalid.

CAUTION:
The following lists caveats in the Links Synchronizer extension that are not implemented due to technical difficulties or may incur significant performance penalities.

Customizing recommended when using AM-PACK

This section outlines the recommended configurations for AM-PACK projects, which are designed to ensure seamless integration and functionality of the Links Synchronizer with AM-PACK projects. These configurations are already preset to manage specific link roles between designated WorkItems, providing an optimized setup for handling links and references unique to AM-PACK workflows.

Extra Fields Config:

image.png

For the following WorkItems: 

Function

image.png

Interface

image.png

For the following WorkItems: 

Own Requirement. 

image.png

Solution Chatacteristic

image.png

Solution Detail

image.png

Function

image.png

Interface

image.png

Propertyimage.png

Test Case

image.png

For the following WorkItems: 

Function

image.png

Interface

image.png

Keine Kommentare vorhanden

nach oben