Documentation Index

Fetch the complete documentation index at: https://help.tuleap.com/llms.txt

Use this file to discover all available pages before exploring further.

Widget - Roadmap

Prev Next

The Roadmap widget allows you to visualize the time-based planning of your projects directly on your dashboard. It provides a Gantt-like view displaying the progress of artifacts (User Stories, Epics, Tasks, etc.) and contextualizing them against time-based iterations (Releases, Sprints).

Installation note

This widget can only be used on the project Dashboard.

Additionally, the Roadmap plugin must be installed and activated on your Tuleap instance.

Prerequisites

For this widget to work properly, your project must be configured with:

  • Active trackers.

  • A consistent hierarchical structure (e.g.: Release > Sprint > User Stories).

  • Semantics configured according to the features used:

Feature

Required semantics

Basic display (Gantt, ribbons, subtasks, links)

Title + Timeframe (required)

Show closed items filter and obsolete items filtering

Status

Progress bar (%)

Progress

Tooltip content on hover

Tooltip

Global artifact eligibility rules

These rules apply to the entire widget (main list, subtasks, ribbons, links).

  • Without the Title or Timeframe semantic configured, artifacts associated with the tracker are ignored by the widget.

  • Artifacts with inconsistent dates (end < start) are considered invalid.

  • Artifacts without a start date and without an end date are not displayed (except in case of a Timeframe configuration error, where they appear at the end of the list).

  • Artifacts closed for more than one year or with an end date older than one year are automatically filtered out.

Installation

Several configuration options need to be set when adding the widget to your dashboard.

Title (Required)

  • Give your widget an explicit name

  • Example: "Product Roadmap 2026" or "Q1 2026 Planning"

Show progress of (Required)

  • Select one or more trackers containing the items to track

  • Examples: Epics, User Stories, Features

  • 💡 These items will appear as main bars in the chart

Filter (Optional)

  • Available only if a single tracker is selected

  • This option allows you to filter the displayed artifacts based on a public report of the selected tracker

Default timescale

  • Choose the initial zoom level

  • Options: Week / Month (default) / Quarter

Once these settings are configured, you can then set up the timeframe ribbons. These ribbons display time bands at the top of the chart to contextualize your items (for example, showing which Release or Sprint a task falls into).

Information

A tracker used to show progress cannot be simultaneously used as an iteration ribbon (and vice versa). The available tracker lists are automatically filtered accordingly.

Timeframe ribbon, level 1 (e.g.: Releases, Versions)

  • Represents the broadest time period

  • Displayed just below the time axis

Timeframe ribbon, level 2 (e.g.: Sprints, Iterations)

  • Represents a sub-division of level 1

  • Requires level 1 to be configured

  • If level 1 is cleared, level 2 is automatically reset

  • Dates must be included within the level 1 dates

⚠️ Important

  • Artifacts must not overlap in time

  • Only iterations whose dates fall within the visible time range are displayed

  • Maintain a continuous timeline for better readability

Content

The roadmap is composed of three main areas:

1. Time header

  • Top row: Years with time unit count

  • Bottom row: Weeks / Months / Quarters depending on the timescale

2. Contextual ribbons (if configured)

  • Level 1: Broad periods (e.g.: "Release 1", "Release 2")

  • Level 2: Sub-periods (e.g.: "Sprint 1", "Sprint 2")

3. Gantt

  • Colored horizontal bars representing your artifacts

  • The vertical red line indicates today's date

  • The length of the bar corresponds to the duration of the artifact

Artifacts

Display

Items are automatically organized according to this logic:

  1. Primary sort: By ascending start date (or end date if no start date)

  2. Invalid artifacts: Invalid artifacts (end date < start date) are displayed at the end of the list

  3. Artifacts without dates: Artifacts with neither a start date nor an end date are not displayed (except in case of a timeframe configuration error, in which case they appear at the end of the list)

Warning

Artifacts whose parent belongs to one of the trackers selected in the widget configuration are not displayed directly in the main list. They appear as subtasks.

Icons and indicators

Various information about your artifacts is displayed on the Gantt chart through indicators.

Indicator

Meaning

: icône “attention”

A configuration error is present on your artifact. This can be:

  • The dates configured on your artifact are inconsistent (end < start)

  • The progress of your artifact cannot be computed

The cause of the error is displayed in the tooltip that appears when hovering over your artifact.

: Bar with percentage %

The Progress semantic is configured on the tracker associated with your artifact

: Diamond

Milestone: the dates of your artifact are identical or missing (no start date or end date)

Dashed bar (dashed border)

The artifact dates are inherited from another tracker (implied dates, computed via the Timeframe semantic "implied from another tracker"). The artifact does not have its own date fields but obtains them from linked artifacts.

Tooltip

  • Hover over an item to display a tooltip containing details about your artifact

  • L’infobulle affiche les propriétés paramétrées dans la sémantique Tooltip de votre tracker

Subtasks

  • The chevron to expand subtasks only appears if subtasks exist: once clicked, subtasks are displayed indented below their parent

  • If the subtask belongs to another project: the project icon and name are displayed

  • Subtasks follow the same eligibility and filtering rules as the main list (see Global artifact eligibility rules)

  • Subtasks are also filtered by their status (open/closed) via the "Show closed items" control

Controls

Timescale

  • You can change the displayed time range: Week / Month / Quarter

  • Changing this option adjusts the display without modifying the configuration

  • This option is disabled if no data is present

Links

  • Select the link type to visualize: arrows appear between linked artifacts

  • The displayed options are based on your link type configuration

  • This control is disabled if no links exist between displayed artifacts, or if no data is visible on screen

  • Also, _is_child links are not in the link selector, as they are displayed via the subtasks display

Show closed items

  • This option allows you to show / hide completed (closed) artifacts based on the Status semantic of the tracker

  • Le filtrage s’effectue en temps réel sur l'affichage

  • This filter applies to both main tasks and their subtasks

FAQ


FAQ

Users in my project cannot see all the artifacts in the Gantt chart.

Make sure your users have the proper read permissions on the trackers and fields involved. In particular:

  • The Title field must be readable

  • The Timeframe semantic fields (start/end dates or duration) must be readable

  • The Status field must be readable (otherwise the artifact will be considered obsolete and hidden)

The timeframe ribbons display is inconsistent

Make sure that:

  • the timeline is continuous (no overlap)

  • the dates between level 1 & level 2 ribbons are consistent

Some artifacts do not appear even though they exist in the tracker

Several causes are possible:

  • The artifact has neither a start date nor an end date filled in

  • The artifact has been closed for more than one year

  • The artifact's end date is older than one year

  • The artifact's parent belongs to one of the selected trackers (the artifact will then appear as a subtask)

  • The artifact's tracker does not have the Title or Timeframe semantic configured

I cannot select the same tracker for progress and iteration ribbons

This is expected behavior. A tracker cannot be used simultaneously to show progress and as an iteration ribbon. The available tracker lists are automatically filtered to prevent this situation.

Dependency arrows are not displayed between some artifacts

For a dependency arrow to appear, the linked artifact must:

  • Have the Title and Timeframe semantics configured on its tracker

  • Be a forward link (outgoing link) from the source artifact

  • Have valid dates and be visible in the widget