Clarity Roadmaps: Using the Timeline Layout

ccppmop160
2
Visualize and Model Work Using the Timeline
Linked
The roadmap timeline layout displays planning items in monthly, quarterly, or annual periods. The column headers for the time periods match the fiscal time period labels that are defined for the default entity in
Classic PPM
. Only the roadmap items that fall within the roadmap start and finish dates appear on the timeline. The items are further filtered based on your period type view options.
Items on the timeline can be bars, circles, or diamonds. Bars result when you enter both the start date and finish date for an item. Circles result when you enter only the start date for an item. Diamonds result when you enter only the finish date for an item.
The Business Agreements workspace in Clarity enables you to define and manage agreements between investments in Clarity. Stakeholders can review these agreements before conducting the next roadmap planning activity or making decisions that impact the investment dates. You can review existing agreements between investments by selecting the
Show Agreements
toggle. The dependencies between agreements are indicated by using dotted lines to highlight predecessor and successor relationships.
Linked
For Roadmap Items with linked investments, you can configure visual indicators to represent events such as milestones or other key (linked) investment dates in the form of a diamond, circle, triangle, square, star, flag, or a rocket. You can leverage the
Events
sub-tab on
View Options
to define the icons associated with relevant events.
Follow these steps:
  1. From the roadmaps list, open a roadmap.
  2. Click
    Timeline
    .
  3. Click and drag to draw the item on the timeline to cover the appropriate duration. Or, click in a specific time period to create a roadmap item in that location. You can add multiple roadmap items within the same row. If you have not yet assigned a picklist value to the roadmap item, it appears in the
    None
    swim lane. After you have assigned a picklist value to all the roadmap items, the
    None
    swim lane disappears.
  4. Complete the fields in the DETAILS panel. If your administrator has created any mandatory attributes, they will also be added to the DETAILS panel.
  5. You can click the Configure button if you want to add more fields to the DETAILS panel and populate them. To learn more about the DETAILS panel, see Common Components.
  6. Click
    Done
    .
Create Roadmap Items With No Start or No Finish Date
To create a roadmap item with no start date, draw the roadmap item and clear the start date in the
START
field. The roadmap item appears with a diamond symbol, like a milestone.
This image shows a milestone roadmap item with no start date.
To create a roadmap item with no finish date, draw the roadmap item and clear the finish date in the
FINISH
field. The roadmap item appears with an open circle symbol.
image2018-2-27 12:4:17.png
To convert the floating item to an item with firm start and finish dates, select the roadmap item and use the DETAILS panel to add dates. The pointer changes to an arrow to apply dates that align with your drag-and-drop placement. You can edit the exact dates.
Arrange Items in the Timeline
  • Select a roadmap item and drag it anywhere to change the duration or the start or end dates. A roadmap item that you create on the Board shows up at the bottom of the Timeline and you can drag it anywhere.
  • Drag and overlap a roadmap item on to another item to push the target roadmap item down to the next available row. If you create an empty row, the roadmap items below that row move up to fill in the empty row.
  • The labels for the single-date roadmap items (that is, diamonds and circles) display outside the items. Hence, overlapping of the labels might occur when you drag one item over another to push the target item down. In this case, manually drag the target roadmap item down to a new row.
  • Select from available grouping attributes to organize the roadmap items into swim lanes as appropriate for different audiences. You can create roadmap items in the swim lanes and can drag the items between the lanes.
  • Save your grouping configurations as part of the roadmap view for easy retrieval. The grouping configurations for a roadmap persist across all your sessions.
Add Dependencies for Roadmap Items
To define dependencies between roadmap items, add dependency lines between the roadmap items. You can add dependency lines from one roadmap item to another or to multiple roadmap items. For example, you can connect the CRM 2.0 roadmap item in the Grow the Business swim lane to the SaaS Migration roadmap item in the IT Operations swim lane.
Follow these steps:
  1. From the roadmap timeline, click the roadmap item and select the action menu.
  2. Select
    DEPENDENCIES
    to start dependency mode.
  3. Click the connector icon for the target roadmap items to create dependency lines from the source roadmap item.
  4. To delete a dependency line, click the X that appears next to each target roadmap item.
  5. To exit the dependency mode, click the X in the blue
    EDIT DEPENDENCIES
    bar at the top of the page.
    Dependency lines with arrows show the relationships between roadmap items in the timeline.
  6. To hide the dependency lines, click
    View Options
    and clear the
    Show Dependencies
    checkbox.
In the dependency mode, drag-and-drop is disabled for the roadmap items. To edit a roadmap item, click the item to open the DETAILS panel.
If there is a large distance between roadmap items, the dependency lines are truncated in the timeline. In the grid, add the Predecessor and Successors attributes from Column Panel to view all dependencies for a particular roadmap item. A maximum of 25 predecessors and 25 successor values appear for a roadmap item. Any changes you make to the dependencies in the timeline are reflected in the grid.
Configure Roadmap Timeline View Options
Configure the timeline layout to view roadmap items that are grouped in swim lanes by attribute. You can view the items by color and can map those colors back to meaningful values. You can also set the zoom level and select financial metrics that appear as badges on your roadmap items. By default, the timeline swimlane and color settings are set to
None
. Adjust the settings for your audience.
Follow these steps:
  1. Open a roadmap and click
    Timeline
    .
  2. Click
    View Options
    .
  3. In the
    TIMELINE
    sub-tab, configure the following settings:
    • SWIMLANES
      Select a picklist to group the roadmap items into horizontal swim lanes by the picklist values. For example, group roadmap items into swim lanes that are based on business outcomes for a steering committee. Group the same roadmap items by the team for business development directors. Each audience can see where each roadmap item sits in its planning process. You can select from the list of default global picklists or can create a custom global picklist. You can also create a local picklist applicable only to this roadmap. See Create and Manage Local Picklists.
    • COLOR BY
      Select a picklist to add color to your roadmap items based on the display mapping of the picklist values. For example, select Status to display the roadmap items in different colors that indicate their approval status. All approved items appear in blue. The COLORS legend in the bottom right corner of the page shows the value associated with each color. If you collapse the legend, you can reopen it by clicking LEGEND. By default, roadmap items appear in a blue color when you have not selected a value for SWIMLANES or COLOR BY.
    • METRICS
      Select up to three financial metrics to display as badges on the roadmap items to review them in the timeline. The METRICS legend in the bottom right corner shows the metrics in sequential order as you selected them. If you collapse the legend, you can reopen it by clicking LEGEND. The badges appear on each roadmap item in the same order as you select them. You can also edit the values for the selected metrics for each roadmap item in the timeline. Your selected metrics remain the same for you between sessions in an unsaved view. To keep your settings, save your view.
    • PERIODS
      Select Months, Quarters, or Years. The timeline displays the roadmap items for the number of fiscal periods that are defined for the selected period type. For example, your default entity includes fiscal time periods for five years (60 months). When you select
      Months
      , the timeline displays roadmap items over 60 monthly columns. Zoom out to five years to view all 60 months.
    • Start Period
      Select the start period for the timeline layout. If you select a Start Period beyond the duration of the timeline, you will be able to see Roadmap items between your Start and End period.
    • End Period
      Select the end period for the timeline layout. If you select an End Period beyond the duration of the timeline, you will be able to see Roadmap items between your Start and End period.
    • Show Dependencies
      Show or hide the dependency lines between roadmap items. This option is automatically selected when you start dependency mode to add dependency lines between roadmap items.
    • Show Text Overflow
      The Show Text Overflow option allows you to have control over how much roadmap item name is displayed and allows you to better interact with roadmaps. Clearing this option will trim the roadmap item name to within the length of the roadmap item.
    • Show Agreements
      Show or hide the link (predecessor and successor relationships) between the agreement owners as a dotted line. You can review existing agreements between investments by turning on the Show Agreements toggle. Turning on the Show Agreements toggle also enables a visual indicator (an agreement icon) at the bottom of the roadmap item line to show dependencies between agreements. Turning off this toggle hides the agreement icon and the link between the agreement owners.
  4. Click
    EVENTS
    .
    The list if events that are configured appears. Events represent linked investment dates such as investment start or finish dates, Milestone Tasks or custom date attributes. By default,
    Key Milestones
    is already pre-defined. Key Milestones are the tasks that are flagged for key Task and Milestone in a project. You can leverage
    Manage Event Items
    of
    Events
    sub-tab to define item events and also aasociate the icons with relevant events. For more information, see Manage Event Items.
  5. In the
    EVENTS
    sub-tab, configure the following settings:
    • Key Milestones
      Selecting the Key Milestones option allows you see the respective images (symbols) plotted along the bars of any roadmap item events or dates that are used to measure the progress of a project.
    Some key points you need to remember are:
    • If an event falls outside the Roadmap Item start or finish date, the Event will be positioned at either the start or finish on the Roadmap Item – whichever is closest to the Event date.
    • After using ‘Import from PPM’, Events defined with a custom date attribute must be synced before they are visible and positioned on a Roadmap Item.
    • When Roadmap Items are moved (shifted left or right), Event positioning (for example: their corresponding dates) will move relative to the Roadmap Item move.
    • If a Roadmap Item has (2) Events that fall on the same date, only the Event that was created last will be displayed on the Roadmap Item.
  6. Click
    X Close
    .
Clarity
clips the metric values for the number and money attributes to match the roadmap duration. If the roadmap includes items that fall either partially or completely outside the Start Period and End Period, their metric values are clipped to match the Start Period and End Period.
Manage Item Events
Manage Item Events allows you to change the images (symbols) for key milestones that are plotted on the bars of any roadmap items with linked investments. You can also add new item events, that is, you can select a particular date attribute on the investment and indicate the dates on the bars.
Follow these steps:
  1. Open a roadmap and click
    Timeline
    .
  2. Click
    View Options
    .
  3. Click
    EVENTS.
  4. Click
    Manage Item Events.
    The
    Item Dates
    window appears that allows you to Create Item Event or change an image (symbol) against a date attribute.
  5. Select a date attribute that you want to edit.
  6. Edit the image by moving the choices up or down in the list.
  7. Click
    Create Item Event
    to add more date attributes.
    A drop-down list appears for you to select a particular date attribute on the investment.
  8. Select a date attribute from the list and then select an image that you want to indicate on the bars.
    For example, if you have a project field Launch Date that you want to indicate on all the bars linked to projects with a rocket icon. You create a new event by selecting the field from the project and the image that you want to use.
  9. When done, click
    X Close
    .
Other Actions Available on the Timeline Layout
Some of the other actions you can perform by using the Timeline layout are:
  • View more information about an investment by using the DETAILS panel
    You can view more information about each Roadmap Item by using the DETAILS panel. The panel is available as a two-column layout, and you can resize it to take up 75% of the screen. The Details layout allows you to include two fields per row. To learn more about using the DETAILS panel in the grid, see Common Components.
  • Analyze investments by using the Filter and Search options
    You can use the Search and the Filter options to identify various roadmap items based on your requirements. To learn more about using the Filter and Search options, see Common Components.
  • Personalize the grid and save your view
    Clarity
    allows you to save and modify multiple views that help you achieve your business goals. Some of the key actions you can perform are:
    • Save an existing configuration in the grid
    • Update existing views, by using the Quick Save functionality
    • Access views saved by other users
    • Mark relevant views as favorites so that you can access them easily
    • Select default views
Roadmap Color Legend
The color legend appears when you select a value in the
COLOR BY
field in the board or timeline layout options panel.
  • To collapse the legend, click
    X Collapse
    .
  • To expand it again, click
    LEGEND
    .
Compare Scenarios in the Timeline
Compare two roadmap scenarios in the timeline so you can evaluate your different
what-if
scenarios and can decide the best course of action for a given roadmap. Roadmap scenario comparisons let you analyze the same roadmap items within two different scenarios.
Linked
Follow these steps:
To compare scenarios, verify that at least one more scenario exists besides the default scenario.
  1. Open a roadmap in the timeline layout.
  2. In the Scenario drop-down list, select your first scenario. Let's call this your Compare From scenario.
  3. Click
    Compare Scenarios
    to start comparison mode.
  4. From the
    COMPARE TO
    menu, select the second (compare to) scenario.
  5. Use the following guidelines to compare the roadmap items in the two scenarios:
    1. A delta icon is displayed if there are differences between selected Roadmap Items.
    2. Scenario differences are displayed on the
      Compare
      tab of the
      DETAILS
      panel.
    3. If a roadmap item does not exist in either the “Compare From” or ”Compare To” scenario, the Details flyout Compare tab will display “Not in "Scenario Name".
    4. The following items are validated for scenario differences:
      • Roadmap Item (Name)
      • Roadmap Item Start and Finish date
      • Swimlane
      • Color
      • Metric 1, Metric 2, and Metric 3
Export the Roadmap Timeline to PDF
Linked
You can export the Roadmap timeline view to a PDF file so that you can include Timeline visuals in presentations or other documents for stakeholder communication. The Export capability is available in the
Item Actions
menu. The exported PDF includes the dependencies and events defined in the roadmap. The exported file name follows the pattern “<roadmap name>_<saved view name>.”
Follow these steps:
  1. Open a roadmap in the timeline layout.
  2. Click
    Item Actions
    and select
    Export to PDF
    .
  3. Save the PDF file on your local system or open it by using the relevant readers/browsers.
Some key points you need to remember are:
  • The exported PDF file will have default minimum dimensions of 1366 X 768 pixels (Width X Height).
    • When the exported PDF dimensions are less than the default dimensions, the PDF generated will use the default dimensions of 1366 X 768 pixels.
    • When the exported PDF dimensions are greater than the default dimensions, the PDF generated will use the dimensions of the generated file.
    • If a Roadmap Timeline exceeds the PDF limitation, you will not experience any issues when viewing the Timeline within a supported browser.
  • Clarity’s existing job (Purge CSV Downloads), originally created to clean up CSV export files, has been updated to additionally clean up PDF export files. The Purge CSV Downloads job is not available to the end-user from the (Classic PPM) and runs every day at 12:30 midnight and cleans up files older than 7 days.
Troubleshooting the PDF Export Capability
The following table describes the various error messages you may encounter while using the PDF generation capability.
Error Code
Error Message
Notes
EXP-01000
Error generating PDF export
Customer-facing message: An error condition is detected if there is an unforeseen error while exporting the PDF
EXP-01001
Invalid export file name
Customer-facing message: The client must pass a file name as part of the API. Clarity expects the file name in a certain format. An error condition is detected if an improper file format is detected
EXP-01002
Missing value for {0} parameter
The client must pass a few parameters as part of the API. An error condition is detected if the expected parameters are missing.
EXP-01003
Export is not supported for the {0} workspace
With this release, the API is restricted to the Roadmap Timeline workspace. An error condition is detected if the client passes a workspace name that is not supported.
EXP-01004
Export is not supported for the option {0}
The client must pass pdf as a file type. An error condition is detected if the supported pdf file type is not provided.
EXP-01005
Required libraries are missing. Please contact your system administrator.
Customer-facing message: An error condition is detected if required libraries are missing (e.g., libatk-bridge-2.0.so.0, libdrm.so.2 libgbm.so.1, libatspi.so.0 libxshmfence.so.1) The System Administrator can locate missing libraries by opening the installation directory $install.dir/playwright/chromium-907428/chrome-linux, run the following command ldd chrome | grep not. The output of this command shows all missing libraries. The System Administrator should install all libraries to ensure Export PDF functionality is working properly.
EXP-01006
Required binaries are missing. Please contact your system administrator
Customer-facing message: An error condition is detected if the system cannot find the required Chrome binaries in the specified location. The possibility of this error condition is rare but could occur if there are installation issues.
  • If you refresh your browser while the export is in progress, the export operation is aborted and no information is logged in the app-ca.log file.
  •   When you change a view/scenario while the export is in progress, the exported file name contains the view name that you were on before clicking the export button. However, the content is related to the view/scenario you have switched to after hitting the export button.
  • If a user with Roadmap view rights, clicks Export and switches to the grid layout, the spinner does not appear on the user interface indicating that the export is in progress.
  • You can add Debug logs to the log configuration screen (/niku/nu#action:security.loggerConfig) with debug in the priority column, and the following as part of the category's column:
    • com.ca.ppm.export
    • com.ca.ppm.export
You can tweak the following system configuration options to enhance the performance of the PDF generation capability.
Tweak System Configurations to Enhance Performance
You can tweak the following system configuration options to enhance the performance of the PDF generation capability.
PLAYWRIGHT_POOL_MAX_TOTAL_OPT - default value: 2
By increasing this value, PDF export concurrency could be increased. It is recommended this value should be half of the number of cores allocated to the system. It is possible to degrade overall Clarity system performance if this value is increased.
PLAYWRIGHT_POOL_MAX_IDLE_OPT - default value: 1
By increasing this value, users may experience a slightly faster PDF export experience. The value should be less than PLAYWRIGHT_POOL_MAX_TOTAL_OPT and greater than PLAYWRIGHT_POOL_MIN_IDLE_OPT. It is possible to degrade overall Clarity system performance if this value is increased.
PLAYWRIGHT_POOL_MIN_IDLE_OPT - default value: 1
By increasing this value, users may experience a slightly faster PDF export experience. The value should be less than PLAYWRIGHT_POOL_MIN_IDLE_OPT. It is possible to degrade overall Clarity system performance if this value is increased.
PLAYWRIGHT_NAVIG_TIMEOUT_OPT
The default value is 100,000 (milliseconds). The value should not be greater than the Gateway timeout.