PulseUno for Dimensions CM User Help

Micro Focus PulseUno for Dimensions CM version 20.1

Last updated: December 9, 2020

Introduction

About PulseUno

PulseUno is a web-based UI that enables development teams to:

What's new in 20.1

Product rename

In version 20.1, Pulse has been renamed to PulseUno. The readme is available in the Dimensions CM 14.5.2 Help Center.

PulseUno for Git

PulseUno for Git is a secure end-to-end solution for working with a Git server that enables you to use standard Git functionality through the PulseUno web interface. With PulseUno for Git, you can create and clone Git repositories, collaborate with individuals and teams, commit, review, and merge changes, and perform other common Git tasks. For details, see Configure PulseUno for Git.

PulseUno vault

PulseUno vault provides secure storage for software component binaries/artifacts and metadata with approval processes, audit trail, vulnerability and license detection, and more.  Vault integrates with Maven and NPM package managers to retrieve or store software components during build and deployment processes allowing you to store third party dependencies or your own packages, manage access to them, and review/approve them for use. For details, see Use vaults to store software components.

PulseUno for Git and Dimensions CM comparison

PulseUno for Git

Runs standalone without Dimensions CM and allows only Git repositories to be created. Includes the following modules:

PulseUno for Dimensions CM

Is integrated with Dimensions CM and allows only CM products to be registered. Includes the following modules:

New plugins

The following plugins have been added:

Chains

Other enhancements





Top Navigation

The top navigation contains:

Sidebar

The sidebar contains links that are relevant to your current location in PulseUno.

Breadcrumbs

Breadcrumbs display your current location in PulseUno.

My Work

My Work displays useful information for the user who is currently logged into PulseUno, such as their review inbox, reviews they own, and packages waiting for approval.

Spaces

Spaces are collections of related software products.

See also

Organize work

You can search in:

Examples:

TIP Searches are scoped to your current location in PulseUno.

You can search for requests and reviews wherever you are located in PulseUno.

  1. (Optional) To restrict the scope of the search, select a space, product, or a stream.
  2. Click Search on the top navigation.
  3. From the list select Reviews or Requests.
  4. Enter a search filter (you can enter part of a name, label, or title). You can search for:
    • Labels
    • Requests
    • Owners
    • Individual words in titles
    • Phrases (in double quotes, for example: "Fix API error")
  5. Click Search or press Return. The results are displayed below. Click a result to view more details.
  6. To refine your search, do one of the following:
    • Select a filter from one of the results lists. The filter appears in the Refined by box:
    • Search results refined by a review state

    • Control-click to select multiple filters from the lists. In the Refined by box click Apply. The box is updated:
    • Search results refined by multiple criteria

    The Search Results window is updated. You can further refine your search by removing filters from the Refined by box.

    Click Clear to remove all filters.

Keyword search

You can also use keywords in a search.

NOTE
  • Use keywords in this format: <keyword>:<value>
  • Separate multiple values in each keyword with commas, for example: Review:Q1,Q3
  • Separate multiple keywords with spaces, for example: Review:Q1,Q3 Event:Deliveries,Reviews
  • You can use these operators: AND, OR, NOT, - (minus), for example: Review:Q12 OR Review:Q16
  • Search is not case-sensitive.

Activity feed keywords

Keyword Searches for Examples
Event

Events and activities for spaces, products, Git repositories, streams, and branches:

Deliveries

Reviews

Votes

Comments

ExpertChains

Event:Deliveries,Reviews
Review Review labels Review:Q1,Q3
Changeset Changeset labels Changeset:123,124,125
Date A specific date. Use the format yyyy-mm-dd

Date:2017-12-04

Date Range In a date range. Use the format yyyy-mm-dd,yyyy-mm-dd

Date:2017-10-01,2017-10-31

Code history keywords

Keyword Searches for Examples
Date A specific date. Use the format yyyy-mm-dd

Date:2017-12-04

Comment Comments added by users (you can enter part of a comment), a phrase must be double-quoted. Comment:"Remove inclusion of libC.a"
User User IDs (you can enter part of a name) User:andys,david

Request keywords

Keyword Searches for Examples
Label

Request labels. You can enter part of a label.

Label:Q234,IT536,ECR_47
Title

Request titles. You can enter part of a title, a phrase must be double-quoted.

Title:install,refactor
State Request states, a state name with multiple words must be double-quoted. State:Raised,"Under Work"
Phase Request phases Phase:Create
Type Request types TYpe:CR,TASK
Stream Requests associated with specific streams or branches. Stream:Qlarius_Java
Product Requests associated with specific products and Git repositories. Product:Qlarius
External External link labels in requests External:SBM

Review keywords

Keyword Searches for Examples
Label

Review labels. You can enter part of a label.

Label:Q234,IT536,ECR_47
Title

Review titles. You can enter part of a title, a phrase must be double-quoted.

Title:install,refactor
Owner

Reviews associated with specific users (you can enter part of a name)

Owner:andys,david
Request Reviews associated with specific requests Request:Q1,Q2
Reviewer

Reviews associated with specific reviewers (you can enter part of a name)

Reviewer:andys,david
Comment Comments added by users (you can enter part of a comment). A phrase must be double-quoted. Comment:"Remove inclusion of libC.a"
State Review states, a state name with multiple words must be double-quoted. State:Assigned,"Peer Review"
Message Commit delivery messages (you can enter part of a message). A phrase must be double-quoted. Message:"Delivered SQL server fix"

Keyboard shortcuts

On Review and Changeset pages you can use these keyboard shortcuts:

TIPTo display the list of shortcuts press the '?' key.

ADM Help Center

The ADM Help Center provides comprehensive user assistance for Dimensions CM, StarTeam, and Accurev.

Quick tour

Watch a quick tour to learn more about PulseUno.

Organize work

As an administrator, you can organize work into spaces, register products (CM) and create Git repositories (PulseUno for Git).

Activity feed

The activity feed displays the following recent events:

To view activity:

  1. Select a space, product, Git repository, stream, or branch.
  2. On the sidebar select Activity.

For reviews and changesets, activity is displayed on the Conversation tab.

To filter information in an activity feed:

  1. From the Activities list, select an event type, for example, Comments.
  2. In the Search box, enter one or more keywords in the format <keyword>:<value>.
NOTE
  • Activity is scoped to the current location.
  • To clear all filters, delete the entries in the Filter box and click Apply.
  • The Filter box is not case-sensitive.

Create spaces and register products

As an administrator, you can create new spaces.

In Dimensions CM, you can register products to a space. For details, see Register a product to a space.

In PulseUno for Git, you can create Git repositories in a space. For details, see Create a Git repository.

Create a new space

  1. In PulseUno, navigate to Spaces.
  2. Click New Space (+).
  3. Enter a title for the new space.
  4. Optionally enter a description for the space. Use the tools to format, and preview, the description.
  5. Click Save.

Register a product to a space

  1. In PulseUno, navigate to Spaces and select the space where you want to register the product.
  2. Click Register (+) and select Register Single Product.
  3. Enter a title for the product. A PulseUno product is the same as a Dimensions CM product but the titles can be different.
  4. Optionally enter a description for the PulseUno product. Use the tools to format, and preview, the description.
  5. From the Repository Name list, select one of the following:
    • Select an existing Dimensions CM repository.
    • Create new repository.
  6. If you are creating a new repository, follow these steps:
    1. Enter a title for the Dimensions CM repository.
    2. Enter the network address of the Dimensions CM server, for example: dmcm-server.example.com
    3. Enter the CM base database name and connection string, for example: CM_TYPICAL@DIM14
    4. For SCM Credentials, select or clear the option Always use the following credentials. For information about using this option, see Configure access to repositories.
    5. Enter a Dimensions CM account username and password.
  7. From the Product in Repository list, select a CM product.
  8. Click Register.

Register multiple products to a space

  1. In PulseUno, navigate to Spaces and select the space where you want to register the products.
  2. Click Register (+) and select Register Multiple Products.
  3. From the Repository Name list, select one of the following:
    • Select an existing Dimensions CM repository.
    • Create new repository.
  4. If you are creating a new repository, follow these steps:
    1. Enter a title for the Dimensions CM repository.
    2. Enter the network address of the Dimensions CM server, for example: dmcm-server.example.com
    3. Enter the CM base database name and connection string, for example: CM_TYPICAL@DIM14
    4. For SCM Credentials, select or deselect the option Always use the following credentials. For information about using this option, see Configure access to repositories.
    5. Enter a Dimensions CM account username and password.
  5. From the Products in Repository list shift-click to select multiple CM products.
  6. Click Register. The new PulseUno products have the same titles as the CM products. You can edit the titles later.

Register a Dimensions CM stream to a product

Dimensions CM streams are registered automatically in a PulseUno product when anyone makes a delivery to that stream. However, administrators can manually register a stream, for example, to add a chain before the next delivery to that stream.

  1. Select the product where you want register a stream.
  2. Click Register Stream.
  3. In the Stream Name box start typing the name of a stream. PulseUno automatically displays a list of all the streams that match the string (not case sensitive).
    TIP Use wildcards to help you find a stream:
    • Type '*' at the end of a string to match specific names, for example: DEV:STREAM_A*
    • Type '*' to display all the streams in a Dimensions CM product.
  4. Select a stream.
  5. Click Save. The stream is registered with the product and you can now:

Delete spaces, products, and streams

As an administrator, you can delete spaces and products as well as unregister streams.

For details on deleting Git repositories, see Delete a Git repository.

  1. In PulseUno, navigate to Spaces.
  2. Do one of the following:
    • Select one or more spaces.
    • Select a space and then select one or more products.
    • Select a space, a product, and then select one or more streams.
  3. Click Delete and confirm.
NOTE
  • Reviews in PulseUno are not deleted when their parent location is deleted. You can search for reviews and re-register the product and/or stream to browse to them.
  • Deleting a space unregisters its products and streams from PulseUno but does not affect Dimensions CM.
  • Unregistering a product unregisters its streams from PulseUno but does not affect Dimensions CM.
  • Unregistering a stream does not affect Dimensions CM. The stream is automatically re-registered in PulseUno when deliveries are made to it in CM (unless the parent product is also unregistered).
  • Delete a product or unregister a stream if you deleted the corresponding object in Dimensions CM and do not want it to appear in PulseUno.

Modify a space or product

As an administration, you can modify the titles and descriptions of spaces and products.

For details on modifying Git repositories, see Edit a Git repository.

To edit a space or product:

  1. Open a space or product.
  2. Click Edit.
  3. Modify the title and/or description.
  4. Click Save.

Set favorite streams

You can add, or remove, a stream from your list of favorite, active streams. Favorite streams are marked with a star and are always displayed at the top of the streams list.

  1. Open a stream.
  2. To the right of the stream name toggle the star to add or remove it from your favorites.

Move a product or Git repository to another space

As an administrator, you can move a product or Git repository to another space.

To move a product or Git repository:

  1. In PulseUno, navigate to Spaces.
  2. Select a space, and then select a product or Git repository.
  3. Click Move.
  4. Select a space from the list.
  5. Click Move.

Filter the list of streams or branches

On a product or Git repository page, you can filter the list of streams and branches.

To apply a filter to streams or branches:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or Git repository.
  2. In the search box, enter a filter and press Enter. For details about using search, see Search.
    PulseUno automatically displays a list of streams and branches that match the string (not case-sensitive).

Product, stream, and branch settings

As an administrator, you can set defaults for all the streams in a product or branches in a Git repository. For example, you might want different products to show different check lists when users vote to approve reviews or request changes. You can override these settings for each stream or branch.

Configure how new reviews are created

As an administrator, you can define how new reviews are created for a product/Git repository or an individual stream/branch.

To configure review settings for a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings and then the Reviews tab.
  4. From the Creation of Reviews in Stream list, select an option for creating reviews:
    • Use the product's default setting.
    • Automatically create reviews.
    • Allow manual creation of reviews.
    • Do not allow reviews.
  5. From the Rules To Use list, select a rule.
    Rules control how reviews move from one state to another, for example, whether all reviewers must approve a review, or just one reviewer. For details, see Review rules.
  6. From the Check List To Use list, select a review check list to be used with new reviews. You also have the option of using the product's default check list or not using a review check list at all.
    For details about check lists, see Manage review check lists.
  7. Click Save.

To configure review settings for a product or a Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. In the sidebar, select Settings > Reviewing changes.
  3. On the Reviewing Changes page, in the Reviews section, define the following review settings:
    Setting Description
    Creating

    Specify options for creating reviews, such as creating reviews automatically, including pull request merges.

    Check Lists

    Select Enable check list to set the default check list for reviews. Then select the check list you want to use.

    Rules 

    Select Use custom review rules to apply a rule to reviews. Then select one of the rules.

    Rules control how reviews move from one state to another, for example, whether all reviewers must approve a review, or just one reviewer.

  4. Click Save.

Pull request settings

See Configure Pull Requests.

Configure chain runs

As an administrator, you can configure how chains run on streams or branches.

To define chain run settings:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings and then the Chain Execution tab.
  4. From the Run chains list, select one of the options:
    • Use the product's default chain execution setting.
    • Run chains on this stream.
    • Disable chains on this stream.
  5. Click Save.

Set new stream defaults

When you create a new stream you can copy the settings from the source stream.

To use the source stream setting for new streams:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product.
  2. In the sidebar, select Settings > Branches.
  3. Select Copy settings from parent branch.
  4. Click Save.

For details on how to set defaults for new Git branches, see Define new branch defaults.

Set delivery filter defaults

As an administrator, you can set the default delivery filter for a product or Git repository, which automatically assigns it to any streams or branches that do not have a filter. A product or repository can only have one default delivery filter. You can apply a different delivery filter to an individual stream or branch.

Delivery filters determine which changesets create reviews and run chains. For example, you could exclude deliveries of built artefacts made on behalf of your automated CI system in those products where CI was configured. For details on creating delivery filters, see Create delivery filters.

To set a default delivery filter for a product or a Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. In the sidebar, select Settings > Delivery Filters.
  3. On the Delivery Filters page, select the filter you want to make default for this product or repository.
  4. Click Set As Default and then Make Delivery Filter Default.

To set a delivery filter for a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Open a stream or branch.
  3. In the sidebar, select Settings.
  4. In the Filters tab, select a filter from the list.
  5. Click Save.

Configure agents

Agents are small applications that PulseUno can use to run chains:

NOTE The clocks on agents and instances of PulseUno must be synchronized.

For information about installing and configuring agents, see the PulseUno Agents Guide.

Approve agents

When an agent is associated with an instance of PulseUno it is automatically displayed in the Agents administration page. To license an agent, an administrator can approve it. You can see if an agent is licensed, or if there are licensing issues, on the Agents page.

  1. On the top navigation, click Administration.
  2. Select Agents.
  3. Select one or more agents.
  4. From the Mark As list, select Approved.
  5. To unapprove agents and release licences, select Unapproved from the Mark As list.

Manage agents

View agent information

The Agent page lists all the agents registered for your instance of PulseUno. Each agent displays the following information:

  1. On the top navigation click Administration.
  2. Select Agents.
  3. To restrict the list of agents that are displayed, select an option from the filter list. For example, you can display all agents or only agents that are online.
  4. To enable or disable memory and workspace monitoring, click Agent Monitoring.
  5. To modify an agent's title, select the agent from the list, click Edit, on the General tab enter a new title, and click Save.

View agent chains

You can view the chains that are running on an agent and the history of previous chain runs including the last run, last failure, last success, and the total number of runs.

  1. On the top navigation click Administration.
  2. Select Agents and select an agent.
  3. The Running tab displays the chain that is currently running.
  4. The Chains tab displays the history of previous chain runs. Each chain is on a separate row.

Take agents offline or online

You can take an agent offline, for example, the host machine is being updated and you want to temporarily prevent it from running chains.

  1. On the top navigation click Administration.
  2. Select Agents.
  3. Select one or more agents.
  4. From the Mark As list select Offline.
  5. To take agents back online, from the Mark As list select Online.

Upgrade and restart agents

If an agent is not responding you can restart it. If you have updated the version of a PulseUno primary, make sure to update the PulseUno subordinates that are connected to it. When you upgrade a subordinate, it downloads the agent code from the primary and installs it.

NOTE
  • Upgrade and restart abort any chains that are running on the agent.
  • You cannot upgrade or restart the embedded agent.
  1. On the top navigation click Administration.
  2. Select Agents and select an agent.
  3. Click Upgrade or Restart.

Delete agents

Administrators can delete an agent that is registered with PulseUno. Deleting an agent release any licenses held by that agent.

NOTE
  • You cannot stop or delete the embedded agent.
  • If you restart a deleted agent, it appears again in PulseUno.
  • Deleting an agent does not remove the agent from the host machine where it is installed.
  1. Stop the agent on the host machine.
  2. In PulseUno, on the top navigation click Administration.
  3. Select Agents.
  4. Select the agent and click Delete.
  5. Confirm that you want to delete the agent.

Add variables to agents

You can add variable defintions to agents. A variable provides information about agents that can be used by chain runs. For example:

Variables enable you to add steps to chains without needing to know the installation details of applications and tools on your agents.

NOTE You cannot define duplicate or empty keys.
  1. On the top navigation click Administration.
  2. Select Agents and select an agent.
  3. Click Edit and select the Variables tab.
  4. Enter a name and value pair, for example: MAVEN_HOME=/home/autobuild/maven3
  5. Click Save.

Add capabilities to agents

You can add capabilities to agents. Capabilities describe a host machine's environment, for example:

You can add multiple capabilities to agents, use them to match agents to chains, and restrict the agents that can execute chains. For example, assume you have multiple agents running Windows. If a chain requires Windows Server 2016 and 64GB of memory you can:

When the chain runs it matches its required capabilities with the capabilities of the agents; the chain only runs on the agent that is running Windows Server 2016 and has 64GB of memory.

  1. On the top navigation click Administration.
  2. Select Agents and select an agent.
  3. Click Edit and select the Capabilities tab.
  4. To add capabilities enter one or more tags. Tags cannot contain spaces.
  5. Click Save.

Browse code

You can browse the streams and branches in a product or repository and view the contents of folders and files. You can browse the current (tip) version of a stream/branch or previous versions. Each file or folder that you open displays information about:

Files also display:

Folders also display:

TIP You can you can add comments to files. Comments are attached to that version of the file and are displayed on any associated Review pages.

Browse streams and branches

  1. Open a stream or branch.
  2. On the sidebar click Code. The Content tab displays the most recent changes to the stream or branch.
  3. Navigate to a folder or file to view its contents.
TIP To view the contents of a file without the color coded syntax, click Raw.

Browse previous versions of streams and branches

  1. Open a stream or branch.
  2. On the sidebar click Code.
  3. Do one of the following:
    • To browse the entire contents of a previous changeset, select the History tab, select the checkbox for a changeset, and click View at Version. On the Content tab browse the files and folders in the changeset.
    • To view a previous version of a file or folder, on the Content tab navigate to the file or folder. Click the History tab, select a version of the file or folder and click View at Version.
    • To revert to the tip of the stream or branch, at the top right click View at Tip.
TIP
  • Enter filters to search the stream or branch, for example, user names and dates.
  • PulseUno displays the version of the stream or branch you selected until you revert to the tip.
  • Comments and findings are tied to the file version where they were added and shown when that version is displayed.
  • For Dimensions CM, you can only browse changesets created with version 14.1 or later.

Add descriptions of folder contents

(Optional) In each folder you can create a file that describes its contents. You can write the content in the following formats:

File Name Data Type Search Order
readme.md Markdown 1
package.html HTML 2
readme.txt Plain text 3
read.me Plain text 4
package-info.java Code 5

PulseUno searches each folder for one of these file types in the order specified in the table above. The first file that is found is rendered and the content displayed at the bottom of the folder page.

Add comments to files

You can add comments to files and collaborate with team members. This is similar to adding comments to files in reviews.

Review code changes

About reviews

Overview

You can use peer review to:

If you are a user with administrator rights you can also:

The review list displays all the reviews that have been created for the selected user, spaces, product, or stream. A review page displays information about a specific change. You can control how a review's state is changed with the configurable review rules.

Reviews are also displayed on the activity feed for spaces, products, Git repositories, streams, branches, and My Work.

Create reviews

If you are an administrator you can configure changesets to automatically create reviews.

Review states

PulseUno's review states and state changes are:

Review states and state changes

Reviewers vote to approve, send for rework, and abstain from a review. Depending on the configurable rules their votes may cause a state change, or contribute to a state change in the future. By default, the first reviewer to vote on a review changes its state but different rules may be configured in your environment.

The review states are:

NOTE
  • If a review's state is changed by mistake to Approved, an administrator can move the review to Rework.
  • If a problem is found while reviewing, a reviewer can request changes (which may change its state to Rework).
  • If a request's state changes from its peer review state to a previous state, the associated reviews automatically move back to Rework.
  • When a request is closed, an associated review at the Approved state automatically moves to Complete.
  • Administrators can change a review's state at any time.

Review roles

A user can hold one of the following roles on a review:

Delivery filters control which changesets automatically create reviews. In Dimensions CM, role assignments on the items in the changeset determine which users are automatically assigned as lead reviewers or are available to be assigned as optional reviewers. In PulseUno for Git, all active users are available to be assigned as lead or optional reviewers.

Review rules

A change in a review's state is triggered by one of the following:

The review rules are codified as a script that runs when one of the following significant events occur:

A rule script uses the votes of the lead and optional reviewers, and additional information, to decide whether to change a review's state. You can create or modify scripts and set the default rule script for each stream. For details, see Configure how new reviews are created.

Review rule scripts

The following table describes the review rule scripts in PulseUno.

Script Description
defaultRule.js

This script approves or rejects reviews based on the vote of the first reviewer. This is the default review rule script for reviews.

The script automatically changes the review state from:

  • Draft or Rework to In Review when a request is actioned to the Peer Review state.
  • In Review to Approved or Rework after the first vote has been cast by any reviewer.
allMustApprove.js

This script handles reviews based on the approval of all reviewers. If any of the reviewers don't approve, the review state changes to Rework.

defaultPRRule.js

This script approves or rejects pull requests based on the vote of the first reviewer. This is the default review rule script for pull requests.

The script automatically changes the review state from:

  • Draft or Rework to In Review when a request is actioned to the Peer Review state.
  • In Review to Approved or Rework after the first vote has been cast by any reviewer.
  • In Review or Approved to Rework if a new changeset is committed to the pull request’s source stream.
leadsOnly.js

This script approves or rejects reviews based on the vote of the first lead reviewer.

majorityDecides.js

This script handles reviews based on the approval of a majority, excluding reviewers with no opinion. If half or more reviewers don't approve, or if all reviewers abstain with no opinion, the review state changes to Rework.


NOTE For details about creating or modifying rule scripts, see the Dimensions CM Administration Guide.

The review list

A review list displays reviews for products, Git repositories, streams, and branches.

To open a review list:

  1. Select a space, product, stream, or branch.
  2. On the sidebar select Reviews.

Each row in a review list is a separate review and includes the following information:

You can select a filter to modify the type of reviews that are displayed.

  1. Open a review list.
  2. From the Reviews list select a filter.
NOTE Only users with an administrator role can filter reviews that are at the states Completed or Abandoned.

You can also sort the reviews by category, and in ascending or descending order.

  1. Open a review list.
  2. Click Sort by.
  3. Select a category.
  4. Optionally select, or unselect, Sort descending.

Review pages

Each review page displays the following information:

TIPYou can use keyboard shortcuts to navigate around a review page.

Activity

The recent activity on the review is displayed in the Activity section, for example:

You can filter the information that is displayed:

Requests

Related requests are displayed in the Requests section and a summary of the first one is expanded. Click the title of any review to view its details.

The results of any chains that have run on the changesets associated with the review are displayed in the Chain Runs section. Expand a chain run to view the measurements and findings of each expert.

Changesets

The changesets associated with the review are displayed in the Changesets section. Multiple changesets are associated with a review if users have made several deliveries to a stream using the same request.

If a review is associated with multiple changesets you can filter the files that are displayed.

  1. In the Changesets section select two changesets to compare with each other.
  2. Click View. The contents section and the sidebar are updated and only files that have changed between the selected changesets are now displayed.

Contents

The Contents section, and the sidebar, display all the files and folders in a review. You can view the contents of any file and add comments.

Publish a review

When a review is created its initial state is Draft. If you are the review owner, or a user with administration privileges, you can publish the review so that it is available to your team. The owner is normally the user that delivered the changeset that created the review.

  1. On the review list page select the review you want to publish.
  2. Click Publish.
  3. Click Publish Review. The review is now at the In Review state.
NOTE CM only: if you use requests to deliver files to Dimensions CM, your administrator will typically configure PulseUno to automatically publish reviews when the corresponding request is actioned to a particular state. In this case you do not need to publish reviews.

Add and remove reviewers

Each review can have reviewers with these roles:

NOTE
  • A review owner, or an administrator, can add and remove lead and optional reviewers.
  • A lead reviewer can add and remove optional reviewers.
  • An administrator can add anyone as a review owner or a reviewer.
  • A review owner or lead reviewer can only add reviewers that have a role on one of the review items' design parts.

To add reviewers to a review:

  1. Open a review.
  2. In the Reviewers section click Add and then Lead Reviewer or Optional Reviewer.
  3. Select more or more reviewers.
  4. TIP
    • Control click to select multiple users.
    • Use Search to find users.
  5. Click Add Reviewers.

To remove reviewers from a review:

  1. Open a review.
  2. In the Reviewers section select more or more reviewers.
  3. Click Remove and confirm.

Browse the contents of files in a review

The Contents section, and the sidebar, display all the files and folders in a review. Changes to files and folders, and to lines and characters in files, are displayed with these colors:

File added
Line and/or characters added
File deleted
Line and/or characters deleted
Line and/or characters deleted
File renamed

The sidebar displays the total number of files in the review.


The Contents section displays the number of files and folders that have been added, modified, renamed, and deleted.

Click a file to view its contents. Use the Show menu to control how the file contents are displayed.

TIP
  • Binary files are not displayed but you can download them.
  • If a file is marked as binary but you know it is a text file, from the Show menu select As Text. In CM, check the format and upload rules.
  • If only part of a file's contents are displayed, from the Show menu select Entire File.
  • Only the contents of the first 30 files are displayed. To display more files scroll to the bottom of the review page and click Load more.
  • To display the previous revision of a file, from the Show menu select Previous.
  • To combine the previous and current revisions of a file, from the Show menu select Unified.
  • To display the previous and current revisions of a file in separate columns, from the Show menu select Display Side by Side. The current version is displayed on the right tab and the previous version on the left tab.
  • Lines that have been added, or have new characters, start with a '+' (plus) character.
  • Lines that have been deleted, or where characters have been deleted, start with a '-' (minus) character.
  • To control how white space is displayed, from the Show menu select a white space option.
  • To open the version of the stream (in the repository browser) where a file revision was made, click its ID number on the tab.

Add comments to files in reviews

You can add comments to files in a review and collaborate with team members. Each reviewer receives an email with a snippet of the code and the review comments. This is different to adding a comment to an entire review.

  1. On a review page find a file.
  2. In the line number column, click and drag to select the lines where you want to add a comment.
  3. In the Comment box enter your comments. Optionally, format the comment using the toolbar or markdown syntax.
  4. TIP

    You can also email comments to users who are not included in a review, for example, you want the opinions of other developers.

    a. On the toolbar click Mention or enter the @ character in the comment box.

    b. Start typing the name of a registered user, PulseUno automatically displays the names of users that match.

    c. Select a user.

    d. Repeat to add additional users.

  5. To display how your comment will look, click Preview. To continue editing click Edit.
  6. To add the comment click Comment. Your comments are now visible to your team and their responses will be displayed in the same comment box.
NOTE
  • Comments are tied to the file version where they were added and shown when that version is displayed.
  • Comments are not added to the actual file versions.
  • You can add comments to reviews at specific states.
  • You can edit your own comments until there is a reply.

Vote on a review

You can vote to approve a review or request changes. Depending on how the rules script for this stream is configured, your vote may trigger the rule script to move the review to its next state.

  1. At the top of a review click Approve or Request Changes.
  2. Enter the reasons why you are voting to approve the review or requesting changes.
  3. Optionally format your comment (see the markdown reference).
  4. To display how your comment will look click Preview. To continue editing click Edit.
  5. If a check list is presented, select items that have influenced your voting decision.
  6. Click Approve or Request Changes.
NOTE Administrators can create review check lists and set the default for each product.

You can also abstain from voting. This useful if there is a rule that mandates that all reviewers must vote, but you have no opinion.

  1. Open a review.
  2. Click Action and select Abstain with No Opinion.
  3. Enter a reason for abstaining and click Abstain.

Mark a review as approved

As an administrator, you can bypass reviewer voting and mark a review as Approved.

  1. Open a review.
  2. Click Action and select Mark as Approved.
  3. Click Approve Review.

Change a review’s owner

As an administrator, you can change a review's owner.

  1. Open a review.
  2. Click Change Owner.
  3. Select a user.
  4. Click Change Owner.

Send a review for rework

If you are a review owner, or a user with an administrator role, you can send a review back to its owner for rework with suggestions for improvement, and bypass reviewer voting.

  1. Open a review.
  2. Click Action and select Send for Rework.
  3. Click Send for Rework.

Abandon a review

If you are a review owner, or a user with an administrator role, you can abandon a review. Abandoning a review indicates that it is no longer active and stops further review activity. This action cannot be reversed.

  1. Open a review.
  2. Click Action and select Abandon Review.
  3. Click Abandon Review.

Close a review

If you are a review owner, or a user with an administrator role, you can close a review. Closing a review prevents further changes being made to it. Only close a review if you are sure that no further work is required.

  1. Open a review.
  2. Click Close Review and confirm.

Add comment to an entire review

You can add comments to an entire review when it is at specific states. Comments appear in a review's activity feed. This is different to adding comments to a specific file in a review.

  1. Open a review.
  2. Click Action and select Comment on Review.
  3. Optionally format your comment. To display how your comment will look click Preview. To continue editing click Edit.
  4. When you have finished click Add Comments.

Edit a review's title

You can edit a review's title.

  1. Open a review.
  2. Click Action and select Edit Title.
  3. Enter a new title and click Save.

Set review page and pull request defaults

You can set the display defaults for the files in your reviews and pull requests:

You can also select a white space options, for example, Ignore White Space.

NOTE Customizations are only applied to your review pages and do not affect other users.
  1. Open a review or a pull request.
  2. Click Action and select Display Defaults.
  3. Select options.
  4. Click OK.

Manage review check lists

When a user votes to approve reviews, request changes, and packages they are typically required to select items from a check list. Administrators can create different types of check lists to satisfy different levels of severity. For example:

For each stream or branch the same check list is used for approvals and changes, however, you can associate a different review check list with each stream.

To create a review check list:

  1. On the top navigation click Administration.
  2. Select Check Lists.
  3. Click New Check List.
  4. Enter a name for the check list.
  5. Enter items that you want your reviewers to select when voting to approve reviews or request changes. Review check lists may contain up to ten items. For example:
    • Coding standards
    • Export compliance regulations
    • Software complexity rules
  6. Click Save.

To delete review check lists:

  1. Select Administration > Review Check Lists.
  2. Select one or more check lists.
  3. Select Delete and confirm.

You can also select the default check list for a space, product, and Git repository.

Watch a review

You can optionally watch a review when it is at specific states. When changes are made to the review you will be notified by email. You can select the notifications that you receive.

Administrators can configure changesets to automatically create reviews and run chains of experts. The first delivery of a changeset to Dimensions CM creates a new PulseUno review whose title is the same as the delivery change comment. If the review is related to a specific request, subsequent deliveries that use the same request are grouped under the same review.

To create reviews and run chains you need to:

Create delivery filters

Delivery filters enable you to control how reviews are created, and chains are triggered, for each stream or branch. Every path in a changeset is matched against the patterns in a stream's delivery filter. If one or more paths pass through the filters, the changeset delivery creates reviews and runs chains. The default delivery filter for a product or Git repository is used by any streams or branches in that product or repository that do not have an assigned delivery filter.

To create a delivery filter for a product or Git repository:

  1. Select the product or Git repository where you want to create a delivery filter.
  2. In the sidebar, select Delivery Filters.
  3. Click the New Delivery Filter icon (+).
  4. In the Title box, enter a name for the new delivery filter.
  5. In the Note box, optionally enter information about the filter.
  6. Use the Exclude Paths/Include Paths fields to control which paths create reviews and run chains.
    For Excluded paths, do one of the following:
    • To prevent specific paths from creating reviews and running chains, enter Ant-style patterns (one pattern per line), for example:
      **/.DS_Store
      **/tmp/**
    • To create reviews and run chains for the included changesets, leave empty.
    For Included paths, do one of the following:
    • To only create reviews and run chains for specific paths, enter Ant-style patterns (one pattern per line), for example:
      **/*.java
      **/*.jsp
    • To create reviews and run chains for all changesets, leave empty.
  7. If you have a system that delivers changes using specific usernames, for example a build process, you can ignore those changesets. In the Exclude authors field, enter the usernames (login IDs) on separate lines.
    For example, regbuild excludes all deliveries by the user with the login ID regbuild.
  8. To ignore changesets with specific text in their delivery comments, in the Excluded messages field, enter message patterns, where * is a wildcard character and each pattern is on a separate line.
    For example, *NO_REVIEW* excludes deliveries where the message contains the keyword NO_REVIEW.
  9. Click Save.

For details on how to apply a delivery filter to a product or a Git repository, see Set delivery filter defaults.

Automatically create reviews and run chains

Administrators can configure which changesets delivered to streams and branches automatically create reviews and run chains of experts.

  1. Select the stream or branch that you want to configure.
  2. On the sidebar select Settings.
  3. Select the Filters tab.
  4. To control which changesets delivered to this stream create reviews and run chains, from the Filter Changesets using Delivery Filter select a delivery filter.
  5. Select the Reviews tab.
  6. To specify a review check list to be used with new reviews created in this stream, from the Check list to use list select one of the following:
    • The product's default check list.
    • Any other list that has been defined.
    • No review check list.
  7. To specify the review rules for this stream, from the Rules to use list select the product's default rule or any other rule that has been defined.
  8. Select the Chain Execution tab.
  9. To configure how this stream runs chains, from the Run chains list select one of the following:
    • The product's default setting
    • Run chains on this stream
    • Disable chains on this stream
  10. Click Save.

Inspect health and quality

PulseUno enables you to inspect health of your code, including:

Chains

PulseUno includes experts that you can run in a sequence of steps called a chain. Experts enable you to:

TIP You can extend or update the set of experts available in PulseUno.

Experts

The following experts are included with PulseUno:

Build

Capture

Container

Dependency

Deployment

Fetch

Security

Analysis

Test

Other experts

For details about each expert and how to configure it see Configure Experts.

TIP You can write your own expert implementations if you have specific requirements or utilities that you want to integrate with PulseUno. For details see the Dimensions CM Administration Guide.

Expert attributes

Experts have these optional attributes:

Create and configure chains

Overview

A chain is comprised of a sequence of steps, and each step can run one expert. For example, this chain has three steps:

Chains are owned by streams or branches. You can configure multiple, independent chains to run on the same stream, for example:

Create chains

  1. Select the product or Git repository where you want to create a chain.
  2. In the sidebar, select Chains.
  3. Click New (+) .
  4. Enter a title and any other information about this chain.
  5. Click Save.

Select changesets to run chains on

You can configure the streams and changesets that a chain runs on and specify a chain run schedule. By default, a chain runs on all changesets.

To select a changeset:

  1. Select a product or Git repository.
  2. In the sidebar, select Chains, and then open a chain.
  3. Click Edit and select the Triggers tab.
  4. From the Run chain list, select how often the chain will run, for example, when every changeset is delivered, or when a pull request is published.
  5. For Matching streams, enter a pattern to specify the streams where the chain will run. Use asterisks ( * ) and commas ( , ) to specify multiple streams, for example, mainline,feature-*
  6. In the Path filtering field, enter Ant patterns (one per line) to only run changesets on paths that match the pattern. To trigger the chain, at least one path in the changeset must match the pattern. Leave empty to run the chain on all changesets.
  7. Click Save.

Add steps to chains

  1. Select a product or Git repository.
  2. In the sidebar, select Chains, and select a chain.
  3. Click Edit and select the Steps tab.
  4. From the Add Step list, select an expert or action from one of the categories.
  5. Add a name for this step.
  6. Configure the step. Each expert or action has different parameters, some of which are mandatory. For details see Configure Experts.
  7. Click Save.
  8. Add more steps as required.
  9. To change the running order of steps in the chain, drag and drop them to different positions.
  10. To remove a step from a chain, select it, and click Remove.
TIP Click a step to view and edit its parameters.

Add capabilities to chains

You can add capabilities to chains. Capabilities describe an agent's environment, for example:

You can add multiple capabilities to a chain. When the chain runs it matches its required capabilities with the capabilities of the agents. For example, if a chain requires Windows Server 2016 and 64GB of memory, add WindowsServer2016 and 64gbMemory as required capabilities on the chain. The chain only runs on the agents that match these capabilities.

NOTE Pre-requisite: add capabilities to agents.
  1. Open the chain where you want to add capabilities.
  2. Click Edit and select the Options tab.
  3. In the Required Capabilities field, enter a comma-separated list of capabilities. Leave empty to run this chain on any agent.
  4. Click Save.

Add variables to chains

You can use variables in chains to tailor how chains behave on each agent or to provide a way of reusing the same value in multiple steps. For instance, a variable is defined on an agent to describe where a compiler is installed. This allows a chain to reference that location via the variable instead of a fixed value in the step's configuration. When the chain is run on the agent, the references to the variable are replaced with the values that have been defined for the agent.  Similarly, two or more steps may need the same value, in which case you can define a variable on the chain with that value, and reference it on each step. An agent works out what a value should be for a variable in this order:

  1. The variable definition on the chain.
  2. The agent definition.

If there is no definition for the variable on the agent, it is assumed to be empty.

Example:

NOTE Pre-requisite: add variables to agents.
  1. Select the chain where you want to add variables.
  2. Click Edit and select the Variables tab.
  3. Click Add Variable.
  4. Enter a variable name and value pair, for example: MAVEN=M2_HOME
  5. Click Save.

Specify content to be analyzed

When a chain runs, you can specify the stream/branch content that will be fetched to the work area and analyzed. By default, the entire contents are fetched, which may be a slow operation depending on the size of the stream/branch.

To specify stream content:

  1. Select a stream.
  2. In the sidebar, select Chains.
  3. Open a chain and click Edit.
  4. In the Steps tab, click Fetch sources.
  5. Select from the following actions:
    • To clean the workspace where the chain will run, select Clean workspace before fetching sources.
    • To fetch no items, clear the Fetch stream content selection.
    • To analyze the entire stream or branch, select Fetch stream content and leave the content field empty.
    • To analyze part of the stream or branch, select Fetch stream content and in the content field enter Ant patterns (one per line) that match specific paths.
  6. Click Save.

View all chains in a stream or branch

You can view all the chains that have been added to a stream or branch.

To view chains:

  1. Select a stream or branch.
  2. In the sidebar, select Chains.
  3. From the list of chains, select a chain to view its results, configuration, and steps.

Share chains

You can export chains that you created and share them with your team.

  1. Open the chain that you want to export.
  2. From the Actions menu select Export Chain.
  3. Navigate to a folder and save as a .chain file.

You can import chains from members of your team:

  1. Select a stream or branch where you want to import a chain.
  2. On the sidebar select Chains,
  3. From the Actions menu select Import Chain.
  4. Navigate to the folder containing the .chain file, select the file, and click Open.
  5. Click Import.

Additional chain configurations

You can set these additional configurations:

  1. Open a stream, in the sidebar select Chains, and open a chain.
  2. Click Edit and select the Options tab.
  3. Select Stop chain on first step failure.
  4. Select Allow only one run of this chain to be in the queue.
  5. From the Retention Policy list, select a policy for keeping the logs in this chain. Retention policies are configured by your administrator.
  6. TIP You can override the retention policy for each log in a chain.

Inspect expert measurements and findings

You can inspect expert results and findings in:

Results include:

The state of each chain run is indicated by these icons and colors:

The chain run was successful

The chain run completed but failed

The chain run completed but is unstable

The chain run is in progress

The chain run has not started

The chain run was abandoned

The chain run was stopped or terminated

To inspect expert results and findings:

  1. Select a space, product, or stream.
  2. On the sidebar click Reviews or Changeset History. Scroll down to a review or changeset and select it.

The Chain Runs section displays results for all the experts that ran on this review. Expand each expert to view its measurements and findings. Some experts may include a link to a web page that provides more details.

The Contents section of a review displays a list of all the files in the review and the number of expert findings for each file.

  1. To view an expert's findings for a specific file, in the Contents section select the file.
  2. From the Show menu select Show Entire File.
  3. Scroll down the file until you see results that you want to inspect. Each line number with a result has a color that represents one of these categories:
    • Blue: information
    • Dark Orange: error
    • Orange: warning

    A line may have multiple results.

  4. Mouse over a line number to display information.
  5. A tooltip showing the contents of an expert finding

View chain run details

You can examine each chain run in detail and view expert findings.

  1. Select a stream.
  2. On the sidebar select Chains.
  3. Select a chain. A list of the chain's recent runs is displayed. Each run shows:
    • The run's state icon
    • The run ID
    • The changeset where the chain ran
    • The duration of the run
    • The instance of PulseUno that ran the chain
  4. Click a chain run ID to view more details. Click a tab to view its details:
    • Console: displays the output log for each expert in the chain. Expand an expert to view its logs. Logs are expanded by default if they include failures. Warnings and messages are color coded. To filter the information that is displayed, select a log threshold level. To download a log, from the Actions menu select Download Logs. Log files use LF line separators.
    • Findings: displays the findings for each expert in the chain, including Errors, Warnings, Failures, and Information. Expand each expert to view more details.
    • Measurements: displays the measurements for each expert in the chain. Measurements are a set of single-valued judgments about source code, For example, 24,847 might be a measurement of lines of code, and High might be a measurement of the security risk level. If any items were captured, a report is attached to this tab.
    • Activity: displays the activity for each expert in the chain including: when the expert ran, the changeset where it ran, and the associated review. Some experts include a link to a web page where you can view additional details.
    • Changesets: lists all the changesets consumed by this run.
    • Requests: lists all the requests associated with this run.
    • Contents: lists all the files that have changed since the previous run.
  5. To run this chain again on the same changeset, click Re-run.
  6. To override the default log retention policy for this chain and keep the log, click Keep Forever.

Edit and delete chains

Administrators can edit and delete chains:

  1. Select the stream containing the chain that you want to edit or delete.
  2. On the sidebar select Chains.
  3. To delete one of more chains, select them from the list, click Delete, and confirm.
  4. To edit a chain, select it, and click Edit.
  5. Edit the chain's configuration, add and remove steps, and change their running order, and add variables.
  6. Save the changes.
NOTE When you delete a chain the following information is retained:
  • Activity events involving the deleted chain.
  • Findings or measurements that the deleted chain added to reviews.
  • Any panels that contain measurements from the deleted chain.

Diagnose chains

If you are having issues with a chain you can diagnose it by running it manually.

To diagnose the latest changeset, select the stream that contains the chain that you want to diagnose and do one of the following:

To diagnose a specific changeset:

  1. Select the stream that contains the chain that you want to diagnose.
  2. On the sidebar select Chains.
  3. Select the chain.
  4. On the Runs tab select a specific run.
  5. Click Re-run.

Use pull requests to manage changes

A pull request is a special type of review that you use to evaluate and merge a set of defined changes, typically in a topic stream. Pull requests are a collaborative process that allows a team to:

Key facts about pull requests:

PulseUno administrators can configure a new pull request to be automatically created when a topic stream is created. The new pull request is automatically linked to the topic stream.

About pull requests and topic streams

Topic streams are temporary Dimensions CM streams that you use for a set of defined changes, for example, to fix a defect or develop a small feature. Topic streams enable you to isolate changes from a mainline stream. Topic streams have some limitations compared to normal streams but the main advantage is they are very quick to create.

A topic stream and its related pull request work together to help you review and merge changes:

Key facts:

Review pull requests

You can assign reviewers to a pull request before you publish it. Reviewers can add comments to the changes, identify issues, make suggestions, and answer questions. When a comment is made, the pull request author and all the reviewers receive an email with a snippet of the code and the review comments.

Merge changes in pull requests

If the parent product or stream has been configured to automatically merge pull requests, when a review moves to the Approved state, the pull request is automatically merged into its parent stream.

If automatic merge is not enabled, when changes have been reviewed and approved, and if there are no conflicts between the topic stream and its parent, you can manually merge the pull request. If there are conflicts, you must resolve them in a work area before you can merge the pull request.

If the merge is successful the pull request is automatically closed. If the merge fails a warning is displayed at the top of the pull request.

NOTE For more information about topic streams and pull requests see the Dimensions CM user help.

Use pull requests

The following topics describe how to use pull requests to review and merge changes.

Configure how pull requests are created

As an administrator, you can define how pull requests are created for a specific topic stream/branch or product/Git repository.

The default naming scheme for pull requests is PR<nn> :<title>

To configure how pull requests are created for a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings.
  4. Select the Pull Requests tab.
  5. From the Creation from Child Streams list, select one of the following options:
    Option Description
    Do not allow

    Pull requests are disabled for topic streams/branches.

    Allow manual

    Pull requests can be created manually between pairs of streams/branches.

    Automatic for Topic Streams

    Pull requests can be created manually between pairs of streams/branches. Child topic streams/branches automatically create pull requests.

    Use the product's default setting for creating pull requests

    This option applies the default setting selected for the product or repository.

  6. Click Save.

To configure how pull requests are created for a product or Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. In the sidebar, select Settings > Reviewing changes.
  3. On the Reviewing Changes page, in the Pull Requests section, select options for creating pull requests:
    1. Enable pull request creation.
    2. Allow for pull requests to be created automatically.
  4. Click Save.

Create pull requests manually

If pull requests are not configured to be created automatically for a topic stream or branch, you can create one manually. You cannot create a pull request in a non-topic stream or parent branch.

To manually create a pull request:

  1. Select the topic stream or branch where you want to create a pull request.
  2. Click New Pull Request.
  3. In the New Pull Request dialog box, select the following:
    • The product where you want to create a pull request. Default: the product to which the stream belongs, or the repository to which the branch belongs.
    • A source stream. Default: the topic stream or branch.
    • The target stream the pull request will be merged into when development is complete. Default: the parent of the topic stream or branch.
  4. Enter a title and description.
  5. Add lead and optional reviewers who can vote to approve or request changes. Choose developers who you think are most suitable to review these changes.
  6. Select a request that describes the changes to be made. This request will be used to merge the changes into the parent stream. If the topic stream or branch is already related to a request, it is automatically selected. To relate a different request, click Relate and select a request from the Relate Requests dialog box. To unrelate a request, click Unrelate.
  7. Click Create. The new pull request is now at the Draft state.

Open and modify pull requests

You can open and view a pull request. If you are the pull request author, you can also:

To modify a pull request:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. From the Reviews list, select a filter, for example, Active.
  5. Select the pull request that you want to view or modify. On the Conversation tab, you can change the following:
    • Description
    • Author (the owner of the pull request)
    • Reviewers
    • Related request
    Any changes that you make are saved automatically.
  6. To edit the title or display defaults, select an option from the Actions menu.

Publish pull requests

If you are the author of a pull request, you can publish it for review after you finish delivering your changes.

When you publish a pull request:

To publish a pull request:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Select a pull request from the list.
  5. On the pull request page, click Publish.
  6. Click Publish Review. Depending on your review rules, you may want to action the related request to its In Review state.

Run chains on pull requests

You can run chains on pull requests to help you decide if the changes in the related stream or branch are healthy. For details about chains, see Inspect health and quality.

To configure a pull request to run chains:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Select the pull request where you want to run chains.
  5. From the Actions menu, select Run Chains.
  6. Select one or more chains that have been defined for the related stream or branch.
  7. Click Run Chains. The selected chains are queued. After the chain has run, click the Chain Runs tab to view the results.

Review and approve pull requests

If you are the reviewer of a pull request, you can:

To review and approve a pull request:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Select a pull request from the list.
  5. To view the code changes, click the Changes tab. The Contents section lists all the files in the review. To review a specific file, select it from the list, or scroll down. The list of files is also displayed in the sidebar.
  6. To add comments to a file:
    • Click and drag to select the lines where you want to add a comment.
    • In the Comment box, enter your comments. Optionally, format the comment using the toolbar or markdown syntax.
    • Click Comment. Your comments are now visible to your team and their responses will be displayed in the same comment box. Each reviewer receives an email with a snippet of the code and the review comments.
  7. To vote to approve a pull request, click Approve. Enter the reasons for your approval and click Approve.

Request changes to pull requests

If you are the reviewer of a pull request, you can ask for changes to be made to the code. Depending on your review rules, the pull request can be sent back to its author for rework. The author can make additional changes and republish the pull request.

To request changes to a pull request:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Select a pull request from the list.
  5. To vote for changes to be made, click Request Changes.
  6. Enter comments and click Request Changes.

Merge pull requests automatically

As an administrator, you can enable approved pull requests to merge automatically into the target stream or branch. Automatic merging only works if there are no conflicts when the pull request moves to the Approved state.

If a pull request fails to merge automatically, you can try and merge it manually. For details, see Merge Pull Requests Manually.

NOTE If a merge fails, the pull request can be sent back to the Rework state and then approved again.
To enable the automatic merging of pull requests:
  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, click Settings and then select the Pull Requests tab.
  4. From the Merge rule list, select a rule that enables automatic merges. For details about merge rules, see Create Merge Rules.
  5. Click Save.

Merge pull requests manually

If the parent stream or branch has not been configured to automatically merge approved pull requests, you can do a manual merge if there are no conflicts between the contents of the topic stream/branch and its target stream/parent branch.

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Open the pull request that you want to merge into the target stream or branch.
  5. Click Merge Pull Request.
  6. Add a merge comment and click Merge. If the merge is successful, the pull request is automatically closed. If the merge fails, a warning is displayed at the top of the pull request.

Abandon pull requests

As an administrator, you can abandon reviews if they are no longer required. This stops further review activity and cannot be reversed.

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Open the pull request that you want to abandon.
  5. From the Actions menu, select Abandon Review.
  6. Click Abandon Review.

Update pull requests

The latest changesets in a topic stream or branch are automatically attached to pull requests. However, to check that the pull request is current, you can scan for the latest changes.

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Open the pull request that you want to update.
  5. From the Actions menu, select Scan for New Changesets.
  6. Click Scan.

Change ownership of pull requests

As an administrator, you can change the ownership of pull requests.

To change the ownership (author) of a pull request:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Select a pull request from the list.
  5. On the Conversation tab, in the Author section, click Change Owner.
  6. Select the user who will be the new author.
  7. Click Change Author.

Mark pull requests as approved

As an administrator, you can bypass the review of pull requests and mark them as approved. If the parent stream or branch has been configured to automatically merge, the pull request is merged into its parent stream or branch.

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Open a pull request.
  5. From the Actions menu, select Mark as Approved.
  6. Click Approve Review.

Send pull requests for rework

As an administrator, you can bypass the review of pull requests and send them to the author for rework.

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. (Optional) To restrict the scope of the search, select a stream or branch.
  3. In the sidebar, click Reviews.
  4. Open a pull request.
  5. From the Actions menu, select Send for Rework.
  6. Click Send for Rework.

Configure pull requests

The following topics explain how to configure pull requests settings such as merge rules and check lists.

Create merge rules

As an administrator, you can manage the rules that control who can merge pull requests.

NOTE In PulseUno for Git, merge rules are not the same as merge strategies. Merge rules control who can merge pull requests, while merge strategies control how pull requests are merged. For details, see Use merge strategies for pull requests.

To create a merge rule:

  1. In PulseUno, navigate to Administration > Merge Rules.
  2. On the Merge Rules pages, click the New Merge Rule icon (+).
  3. On the New Merge Rule page, provide the following details:
    Field Description
    Title

    Enter a name for the new merge rule.

    Automatically merge

    To enable pull requests to be merged automatically, select Automatically merge when a pull request is approved. The automatic merge is performed by the repository’s system user in the background.

    Conversations

    Define how pull request conversations affect the merge:

    • Ignore conversations (default).
    • Do not verify conversations.
    • All pull requests must be Resolved and Accepted.
    • All pull requests must be Resolved.
    Check lists

    Select All check list items must be checked to enable merging only after all items on the check list are selected.

    Who can merge

    To display the Merge button in pull requests, select the author and/or reviewers. These users must have the correct privileges to perform a merge.

    Merge gatekeepers

    To add other users who can see the Merge button, click the New icon (+) and add merge gatekeepers. These users also require the correct privileges.

  4. Click Save.

Apply merge rules

As an administrator, you can apply rules for merging pull requests to a stream/branch or a product/Git repository.

Before you can use a merge rule, you need to create it. For details, see Create merge rules.

To apply a merge rule to a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings.
  4. Select the Pull Requests tab.
  5. From the Merge Rule list, select a rule. To use the product's or repository’s setting, select Use the product’s default rule.
  6. Click Save.

To apply a merge rule to a product or a Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. In the sidebar, select Settings > Reviewing Changes.
  3. On the Reviewing Changes page, in the Pull Requests section, select Use custom merge rule. Then select a rule from the list.
  4. Click Save.

See also

Create delivery filters

Set pull request rules

As an administrator, you can set the default review rules used by pull requests.

Rules control how reviews move from one state to another, for example, whether all reviewers must approve a review, or just one reviewer. For more details, see Review rules.

To set a pull request rule for a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings.
  4. Select the Pull Requests tab.
  5. From the Rules To Use list, select a rule.
  6. Click Save.

To set a pull request rule for a product or a Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or Git repository.
  2. In the sidebar, select Settings > Reviewing changes.
  3. On the Reviewing Changes page, in the Pull Requests section, select Use custom pull request rules.
  4. From the list of rules, select a rule.
  5. Click Save.

Set default check lists

As an administrator, you can set the default review check lists used by pull requests. You can also specify no check list. For details about check lists, see Manage review check lists.

To set a default check list for pull requests in a stream or branch:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. Select a stream or branch.
  3. In the sidebar, select Settings.
  4. Select the Pull Requests tab.
  5. From the Check List To Use list, select a check list.
    To apply no check list, select Do not use review check lists for reviews in this stream.
  6. Click Save.

To set a default check list for pull requests in a product or a Git repository:

  1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
  2. In the sidebar, select Settings > Reviewing changes.
  3. On the Reviewing Changes page, in the Pull Requests section, select Enable check list.
  4. From the list, select the check list you want to use.
  5. Click Save.

Set display defaults

You can set the display defaults for your pull requests. For details, see Set review page and pull request defaults.

Map pull request states to Dimensions CM request states

Administrators can map the following PulseUno pull request states to Dimensions CM request states:

NOTE
  • Mappings are optional.
  • To disable a mapping leave the field blank.
  • Leave all fields blank unless your CM request lifecycle includes an In Review state.
  1. On the top navigation click Administration.
  2. Select Repositories and then a CM repository
  3. Select Defaults and then the Pull Requests tab.
  4. In the state name in CM fields, enter CM states.

Set the Dimensions CM reviewer role

Administrators can set the default Dimensions CM role for pull requests. Users that hold this role can be selected as reviewers for pull requests. Default role: REVIEWER

  1. On the top navigation click Administration.
  2. Select Repositories and a CM repository
  3. Select Defaults and then the Pull Requests tab.
  4. In the Reviewer role name in CM section, enter a Dimensions CM role.

Use vaults to store software components

About PulseUno vaults

What are vaults?

A PulseUno vault is a secure repository for collections of software components such as binaries, artifacts, and meta data. A collection of software components is also called a package.

Vaults provide a central library for your packages and integrate with build and development pipelines. Vaults are used by package managers such, as Maven, to retrieve components during build and deployment processes.

Vaults have audit trails, reviews, and approvals that enable you to manage your own, and third-party, packages.

TIP Vaults are located at the Spaces level in PulseUno.

Vault types

PulseUno has the following types of vaults:

Key features of PulseUno vaults

See also

Create, configure, and delete vaults

Give roles on vaults to users and teams

Populate vaults with packages

Publish packages

Review and approve vault packages

Vaults home page

On the vaults home page you can view:

To open the vaults home page:

  1. On the top navigation click Spaces and select a space.
  2. On the sidebar click Vaults. The Vaults tab displays all the current vaults. You can filter the list by vault type, package type, and creation date. The Activity tab displays the recent activity for all vaults.
  3. Select a vault to view its packages, details, and activities.
  4. Select the Packages tab. The vault's URL is displayed at the top right. Click Copy to paste the URL into your IDE or build scripts.
  5. Select a package version. Information about the package version is displayed, such as its contents, licenses, and any vulnerabilities that were detected.
  6. To display the users who have access to the vault and the roles they hold, for example, developer and approver, on the sidebar click Members.
  7. To view a vault's general settings, on the sidebar click Settings.

Create, configure, and delete vaults

This topic describes how to:

NOTE
  • You cannot change a vault's package and storages type after you create it.
  • Micro Focus recommends using a single stream, or branch, per vault.

Create local vaults

You can create a local vault on a local file system or repository.

To create new local vaults:

  1. Open the vaults home page.
  2. Click Add (+) and select Local.
  3. On the Connection Details tab enter a name for the local vault and a description.
  4. From the Package type list select a vault package type.
  5. Select the access permission:
    • Authenticated: any logged in user has full access to the vault.
    • Anonymous: no login authentication required, read-only access to the vault.
  6. Select Enable automatic checking of packages for vulnerabilities if required.
  7. Select the Storage tab.
  8. Select a storage type:
    • Filesystem: the vault will be stored on your local machine.
    • Dimensions CM: the vault will be stored in a local CM repository. Select a connection to an existing repository or create a new connection. Administration rights are required to create a new connection.
  9. Click Save.

Create remote vaults

You can create a remote caching vault on a remote file system or repository.

To create new remote vaults:

  1. Open the vaults home page.
  2. Click Add (+) and select Remote.
  3. On the Connection Details tab enter a name for the remote vault and a description.
  4. From the Package type list select a vault package type.
  5. Select the access permission:
    • Authenticated: any logged in user has full access to the vault.
    • Anonymous: no login authentication required, read-only access to the vault.
  6. Select Enable automatic checking of packages for vulnerabilities if required.
  7. For Remote URL enter the URL of the remote repository that is going to be cached, for example:
    https://repo1.maven.org/maven2/
  8. Enter a user name and password for the remote vault.
  9. Select the Storage tab.
    • Filesystem: the vault will be stored on your local machine.
    • Dimensions CM: the vault will be stored in a local CM repository. Select a connection to an existing repository or create a new connection. Administration rights are required to create a new connection.
  10. Click Save.

Create virtual vaults

You can create a virtual vault, a collection of local and remote vaults. The order of the vaults in a virtual vault is important: they are consumed in descending order, starting from the first vault. After you have created a virtual vault, change the order of the vaults as required.

To create new virtual vaults:

  1. Open the vaults home page.
  2. Click Add (+) and select Virtual.
  3. On the Connection Details tab enter a name for the virtual vault and a description.
  4. From the Package type list select a vault package type.
  5. Select the access permission:
    • Authenticated: any logged in user has full access to the vault.
    • Anonymous: no login authentication required, read-only access to the vault.
  6. Select Enable automatic checking of packages for vulnerabilities if required.
  7. Click Save.

To add vaults to virtual vaults:

  1. On the vault home page select a virtual vault.
  2. On the Vaults tab click Add (+). The Add vaults dialog box opens.
  3. Enter a search string and click Enter.
  4. In the results list select vaults and click Add.
  5. On the Vaults tab, optionally change the order of the vaults.

Specify the vault to be populated in a virtual vault

Virtual vaults contain multiple vaults. When you populate a virtual vault, the published vault is the one that is populated with packages.

To specify the vault to be populated in a virtual vault:

  1. Open a virtual vault.
  2. Select a vault.
  3. Click Publish.

Edit vault settings

You can edit settings and configurations for existing vaults.

To edit the settings for vaults:

  1. Open the vaults home page and select a local or remote vault. You can also select vaults in virtual vaults.
  2. On the sidebar click Settings.
  3. Edit the settings and click Save.

Delete vaults

You can delete vaults. Deleted vaults are kept for 7 days before being permantly deleted. You can cancel a deletion anytime during that period.

To delete a vault:

  1. Open the vaults home page.
  2. Select the vault you want to delete.
  3. On the sidebar select Settings > Advanced.
  4. Click Delete this vault.
  5. Confirm the deletion.

To cancel the deletion of a vault:

  1. Open the vaults home page.
  2. Select the vault whose deletion you want to cancel.
  3. On the sidebar select Settings > Advanced.
  4. Click Stop deletion.
  5. Confirm the cancellation.

Give roles on vaults to users and teams

This topic describes how to add members (individual users and teams) to vaults and give them roles. Roles have these capabilities:

For information about creating teams see Create and edit teams.

NOTE Members can only have one role at a time.

Add users to vaults and give them roles

You can add individual users to vaults and give them a role.

  1. Open the vaults home page and select a local or remote vault. You can also select vaults in virtual vaults.
  2. On the sidebar click Members.
  3. Select the Individuals tab.
  4. To add users click Add Individual (+). The Add Individuals dialog box opens.
  5. Select a role from Role to assign.
  6. Search for users and click Enter.
  7. Select users and click Add.

Add teams to vaults and give them roles

You can add teams to vaults and give them a role.

  1. Open the vaults home page and select a local or remote vault. You can also select vaults in virtual vaults.
  2. On the sidebar click Members.
  3. Select the Teams tab.
  4. To add users click Add Team (+). The Add Team dialog box opens.
  5. Select a role from Role to assign.
  6. Search for teams and click Enter.
  7. Select teams and click Add

Delete members from vaults

You can delete users and teams from vaults.

  1. Open the vaults home page and select a local or remote vault. You can also select vaults in virtual vaults.
  2. On the sidebar click Members.
  3. Select the Individuals or Teams tab.
  4. Select users and teams.
  5. Click Delete and confirm.

Change the roles for members

You can change the role for members.

  1. Open the vaults home page and select a local or remote vault. You can also select vaults in virtual vaults.
  2. On the sidebar click Members.
  3. Select the Individuals or Teams tab.
  4. Select users and teams.
  5. Click Change Role and select a role.

Use vault approval checklists

This topic describes how to:

Use checklists when approving vaults

When approvers review packages, you can mandate an approval checklist for each vault. For example, you can require an approver to verify that a package has an Apache 2.0 license and no security issues. For information about checklists and how to create them, see Manage review check lists.

To use checklists when approving vaults:

  1. Open the vaults home page select a local or remote vault. You can also select vaults inside virtual vaults.
  2. On the sidebar click Settings > Approving changes.
  3. Select Enable check list.
  4. Select a package approval checklist for this vault.
  5. Click Save.

Set the default approval checklist across all vaults

You can mandate the use of package approval checklists and set the default checklist, across all vaults.

To set the default approval checklist:

  1. Open the Space containing the vaults.
  2. Select Settings > Vault defaults.
  3. Select Enable check list.
  4. Select the default package approval checklist for all vaults.
  5. Click Save.

Populate vaults with packages

There are many reasons to store binaries in a vault, but there are two common use cases:

When building software, you need to specify the URLs for the vaults you are publishing packages into or pulling packages from. The configuration of these URLs depends on the package types, build systems, and IDEs that you are using.  See your package manager's user help for details.

Vault URL format

Use the following URL format to specify the location of vaults in PulseUno:

http://<hostname>:<port number>/vault-server/<vault type>/<space name>/<vault name>

where:

Parameter Description Example values
<hostname>:<port number>

Specifies the machine name and port number where the PulseUno vault is located.

dev:8080
vault-server You must specify this parameter. n/a
<vault type> Specifies the vault type.

maven

npm

<space name>

Specifies the name of the PulseUno space where the vault is located.

app
<vault name>

Specifies the name of the vault that will be populated with the contents of the package.

dev-cache

 

Example URL:

http://dev:8080/vault-server/maven/app/dev-cache

TIP To find and copy a vault's URL:
  1. Open the Vaults home page.
  2. Select the vault. The URL is displayed at the top right of the Vaults tab for a virtual vault and the Packages tab for local and remote vaults.
  3. Click Copy to copy the URL to your clipboard, you can then paste it into your IDE or build scripts.

Publish packages

This topic describes how to publish packages so that they can be reviewed by approvers. For information about adding approvers see Give roles on vaults to users and teams.

  1. Open the vault containing the package that you want to publish.
  2. Select the package and then a package version.
  3. On the Conversation tab, on the right-hand side, click Approver.
  4. Select approvers for this package and click Save.
  5. To publish the package so that it can be reviewed and approved, click Publish, and then Publish Package.

Review and approve vault packages

This topic describes how to:

Review package contents

You can inspect the contents of a package, review its details, and send comments to team members.

NOTE PulseUno's built in experts automatically detect issues with package contents, such as licensing and vulnerabilities.

To review package contents:

  1. On the top navigation click My Work.
  2. On the sidebar click Package approvals. A list of all the packages for which you are an approver are displayed. Filter the list as required, for example, by package version or the users who deployed the packages.
  3. Select a package.
  4. On the Conversation tab, send comments and questions to other members of your team about this package. Replies from your team are displayed on this tab.
  5. To view information about the package, select a tab:
    • Details: displays the package's details such as the vault URL and package type.
    • Content: displays the contents of all the files and folders in the package.
    • Activity: displays the recent activity for the package.
    • Licenses: displays licenses for the package, for example, Apache 2.0.
    • Vulnerabilities: displays vulnerabilities detected by PulseUno including: name, Common Weakness Enumeration (CWE, software weakness types), severity, and a description.

Approve vault packages

You can approve packages so that they can be consumed by development teams in their build and deployment processes.

You can reject packages if they violate your organizations standards such as licensing, performance, and security. When a package is rejected, it cannot be used. The developer who added the package must fix the issue, for example, use a different version.

To approve or reject packages:

  1. Open the package that you want to approve or reject.
  2. Click Approve or Reject.
  3. Enter the reasons for approving or rejecting the package.
  4. Select items from the checklist.
  5. Click Approve or Reject.

Specify vault approval rules

PulseUno includes the following example vault automated approval rules:

TIP Teams can write their own approval scripts.

You can specify the approval rule for all vaults or each vault.

To specify vault approval rules:

  1. Navigate to Spaces and select a product.
  2. Do one of the following:
    • All vaults: on the sidebar select Settings > Vault Defaults.
    • Individual vaults: on the sidebar select Vaults. In the content pane select a vault. On the sidebar select Settings > Approving Changes.
  3. In the Approval Rules section select Enable automated approval and rejection using rule scripts.
  4. Select a rule from the list.
  5. Click Save.

Specify how long vault packages are kept

Retention policies define how long vault packages are kept. You can create multiple retention policies and specify a different one for each vault. For details about creating policies, see Create chain and vault retention policies.

To specify how long vault packages are kept:

  1. Navigate to Spaces.
  2. On the sidebar select Vaults and select a vault in the content pane.
  3. On the sidebar select Settings > Retention Policy.
  4. In the Retention policy section select Enable automatic deletion of packages using retention policy.
  5. Select a policy from the list.
  6. Click Save.

Subscribe to vault notifications

You can subscribe to vault email notifications. For details, see Subscribe to email notifications.

Configure experts

PulseUno includes bundled and built-in experts:

Except where specified all experts are either bundled or built-in.

Each expert section below contains some, or all, of the following information:

The notation ${dataDir} refers to the PulseUno data directory on the PulseUno server, for example, C:\ProgramData\Micro Focus\Dimensions CM\Pulse or /opt/microfocus/dimensions/14.5.1/pulse_data.

NOTE In .properties files you can specify the path of a file using either '/' (Windows & UNIX) or '\' (Windows only) as a filename separator. If you use '\' as a separator you must escape it using another '\' character. For example, "file.path=C:\\TEMP\\myfile.bin".

Manage experts

The Plugins page displays all the experts that are currently installed in your environment. The plugins are separated into these categories:

As asn administrator, you can:

  1. On the top navigation, click Administration.
  2. Select Plugins.
  3. For each plugin, do the following:
    • Enable or disable the plugin.
    • View the last runs.

For details about installing additional plugins, see the Dimensions CM Administration Guide.

NOTE If you disable an expert that is included in a chain, the expert will be skipped when the chain runs.

Capture to DA CodeStation

Overview

Captures built artefacts to Deployment Automation CodeStation. These represent deployable items such as files, images, databases, configuration materials, or anything else associated with a software project. For details about configuring and using Deployment Automation, visit the Deployment Automation Help Center.

Prerequisites

This expert supports DA version 6.1.5.

Configure

Configure expert settings

Field Name Description Example Value Required
Step Name The name of this expert step.

Capture to DA CodeStation

Yes
Username The name of the user that will log into DA.   Yes
Password The user's password.   Yes
DA server URL The URL of the DA server.   Yes
Component name Enter name of a DA component. The components that are available are listed in the field. ${EXPERT_RUN_ID}  
Version name Enter the version of the DA component. The versions that are available are listed in the field. ${EXPERT_RUN_ID}  
Artefact directory The path to the directory where built artefacts will be captured.    
Include patterns To only capture specific files, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Exclude patterns To exclude specific files from being captured, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Flatten files Capture all the files into one flat directory.    

Capture to Dimensions CM

Overview

Captures built artefacts to a Dimensions CM stream.

Configure

Field/Option Description Example Value Required
Step Name The name of this expert step.   Yes
Use the chain's stream to capture targets Capture targets to the stream that owns this chain.    
Target stream Enter the name of the product and stream where the targets will be captured. Only displayed if you do not select the previous option. QLARIUS:JAVA_BRANCHA_STR Yes
Request Enter the name of the CM request that will be related to the targets.    
Source Directory Enter the path to the source directory where the built artefacts are located.    
Target Directory Enter the path to the target directory in the stream where you want the built artefacts to be captured.    
Include patterns To only capture specific files, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Exclude patterns To exclude specific files from being captured, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Commit message Enter a message that describes this commit to the CM stream. Committed using the expert Capture To Dimensions CM  
Flatten files Capture all the files into one flat directory.    

Capture to Directory

Overview

Captures built artefacts to a directory.

Configure

Field/Option Description Example Value Required
Step Name The name of this expert step.   Yes
Source relative directory Enter the path to the source directory where the built artefacts are located. This is the path that is relative to the root of the stream that owns this chain.   Yes
Destination directory

Enter the absolute path to the target directory where you want the built artefacts to be captured. You can use tokens, for example:

  • SUITE_NAME
  • PRODUCT_NAME
  • STREAM_NAME
  • STREAM_VERSION
  • CHAINNUM
  • EXPERT_RUN_ID
  • CHANGESET_ID
‘D:\destinationDir\${SUITE_NAME}\${PRODUCT_NAME}
\${STREAM_NAME}\${CHANGESETT_ID}\’
Yes
Include patterns To only capture specific files, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Exclude patterns To exclude specific files from being captured, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Flatten files Capture all the files into one flat directory.    

Capture to SCP/SFTP

Overview

Captures built artefacts to a workspace using secure copy (SCP) or to remote network server using Secure File Transfer Protocol (SFTP).

Configure

Field/Option Description Example Value Required
Step Name The name of this expert step.   Yes
SCP/SFTP Select a method for capturing artefacts.    
Host Enter the name of the machine where the artefacts will be captured.

localhost

dev7_unit_test

Yes
Port Enter the port number on the machine.   Yes
Username Enter the name of a user who has permission to access the machine.   Yes
Password Enter the user's password.    
Source directory Enter the path to the source directory where the built artefacts are located.    
Target directory

Enter the relative path to the target directory where you want the built artefacts to be captured.

   
Include patterns To only capture specific files, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Exclude patterns To exclude specific files from being captured, enter one or more Ant patterns (one per line). To capture all files leave this field blank.    
Flatten files Capture all the files into one flat directory.    

Changeset Summary

The Changeset Summary expert is a built-in expert that counts the number of files added, deleted, and modified in each changeset. To track of the number of changes, which indicates the level of code churn, you can configure this expert to run on every changeset.

This expert has no prerequisites or configuration and does not require a workspace because it uses the changeset information.

Checkstyle

Overview

The Checkstyle expert is a bundled expert that uses the Checkstyle development tool to check that Java code adheres to a defined coding standard.

Use Checkstyle to help you comply with Java coding standards by automating code checking. Checkstyle is highly configurable and can support most coding standards. For more information, see the Checkstyle documentation.

This expert has no prerequisites (the Checkstyle 5.7 libraries are embedded in the expert so there are no external tools to install).

Configure

Create server configuration file

To customize the Checkstyle rules to be checked by this expert, create an XML configuration file in ${dataDir}/conf/experts/com.serena.starlight/checkstyle/ on the PulseUno server. The default filename is config.xml.

The Checkstyle expert searches for a configuration file in the following sequence:

  1. If the field Configuration File Name specifies a filename, looks for that file in ${dataDir}/conf/experts/com.serena.starlight/checkstyle/.
  2. If the field Configuration File Name is empty, looks for config.xml in the same directory on the PulseUno server.
  3. If the field Configuration File Name is empty, and config.xml does not exist, uses a built-in configuration based on Sun Coding Conventions.
NOTE Checkstyle (not the expert) has properties that you can configure using system properties. Checkstyle expert passes system properties used to start the JVM hosting PulseUno through to the Checkstyle tool.

Configure expert settings

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description
Step Name Enter a name for this step in the chain.
Configuration location Select one of the following options:
  • Use the default configuration file.
  • A local configuration file (specified in the Configuration File Name field).
  • A configuration file stored in a stream (specified in the Configuration File Name field).
Configuration File Name Specify the path and filename of a configuration file that you created on the PulseUno server.

Checkstyle operates on source code files so add the Checkstyle expert to a chain that populates a workspace.

CM Build

Overview

If your team uses Dimensions Build and you have existing build configurations, the bundled CM Build expert enables you to run the configurations in PulseUno. Dimensions Build is a build management, execution, and monitoring tool that is part of Dimensions CM. For details, see the Dimensions CM Build Help.

Prerequisites

A build configuration, created in Dimensions Build, for each stream that you are going to build.

Configure

When you add this expert to a chain configure it as follows:

  1. Enter a name for this step in the chain.
  2. Select a CM user account to be used to run the build:
    • Service account: use the account and credentials of the user current logged into PulseUno. This is the account that was used to populate the work area associated with the stream.
    • Custom account: use a different CM user account. Specify the user name and password.
  3. Set Configure using command line to one of the following:
Field Name Description Required Example
Build based on request(s) Restrict the build to sources that are related to CM requests that you specify. Enter a comma separated list of requests. Leave blank if you do not want to restrict the build.   QLARIUS_CR_21,QLARIUS_CR_56
Area type

Select a Dimensions CM area type:

  • Work: a location on your local drive, a remote node, or a network drive that is associated with a stream or project.
  • Deployment: an area defined for a project or stream for deploying item files that have reached a particular stage in the Global Stage Lifecycle.
   
Area name Specify the area to be used for this build. Default: all areas associated with the build configuration or stage.    
Stage

Specify the stage where the targets will be built.

Only displayed if you select a Deployment area.

  DEV
Build configuration name Specify the build configuration, and version, that you want to build. If you do not specify a version, by default the latest is used. Yes ANT_JAVA_BUILD;6
Build area user

Enter a Dimensions CM credential set that has access to the build area.

Only displayed if you select a Work area.

  MY_CREDENTIAL_SET
Populate the work area with all files

Select this option to populate the work area with all the files that are related to the build.

Only displayed if you select a Work area.

   

Check in built items

 

Select one of the following options:

  • None: do not check in built items to Dimensions CM.
  • Use default request(s): check in the built items and use the same request that the sources are related to.
  • Use custom request(s): check in the built items and relate to the custom requests specified in Relate build items to requests.
   
Target stream name

Specify the stream where the collected and built items will be delivered. Default: the same stream as the sources.

Only displayed if you are checking in built items.

  QLARIUS:JAVA_BRANCHA_STR
Relate built items to requests

Specify a comma separated list of requests to which new items created from the final build targets will be related.

Only displayed if you are checking in built items related to custom requests.

  QLARIUS_CR_24,QLARIUS_CR_18
Build options

Select one of these options:

  • Clean area(s) before build: run the clean script specified in the build configuration before the build.
  • Audit area(s) before build: produce an audit report for the build areas associated with the Dimensions CM project or stream. The report is generated before the build.

Only displayed if you select a Deployment area.

   
Target selection
  • Dependency analysis: control the selection of build targets.
  • Configuration analysis: analyze the build configuration.
  • Final targets only: return intermediate and final targets.
  • Predicted: return predicted targets based on a previous revision of the item. Is relevant when the selected revision has not yet been built.
  • Foreign: include targets that are related to items in a different project or stream.
  • Side effect: request side effect targets from dependency analysis.
  • All targets: return all targets.

For details see the BLD command in the Dimensions CM Command-Line Reference.

   
Poll rate Specify how often (in seconds) that the expert checks if the build has completed. Yes 50

CM Build manages its own workspaces so you can add it to a chain that does not populate a workspace.

DA Deployment

Overview

The DA Deployment expert is a bundled expert that allows you to integrate PulseUno with Deployment Automation (DA) and to publish and deploy artefacts from a Dimensions CM stream.

You can use the DA Deployment expert to automate the path to production for your application. For example, the expert can support continuous delivery by:

Prerequisites

The Deployment Automation server must be installed on your network, but not necessarily on the PulseUno server, where this expert can connect to it. The DA Deployment expert has been tested with Deployment Automation server version 6.1.1.

You will need a working application process configured in your Deployment Automation server for the DA Deployment expert to invoke.

Configure

Create server configuration file

The following DA Deployment expert properties file is usually required: ${dataDir}/conf/experts/com.serena.starlight/sdadeploy/sda-pulse-expert.properties

The property below identifies the location of the Deployment Automation server, if the default value shown is correct you do not need to edit it:

Property Name Description Required Example
sdaServerUrl URL to the Deployment Automation server web application Yes http://localhost:8080/da

Configure expert settings

When you add this expert to a chain in PulseUno modify the following configuration fields:

Field Name Description Example Required
Step Name Enter a name for this step in the chain. DA Deployment Yes
Username Enter the username of a Deployment Automation server administrator. admin Yes
Password Enter the password of the Deployment Automation server administrator. admin Yes
Component Name Specify the name of the Deployment Automation component that will be published. my_component_1.5 Yes
Version

A new version of a Deployment Automation component is created each time this expert runs. Use this option to specify the format of the version name and make it easier to identify its source. You can include the following variables by using the syntax '${<variable_name>}' in the value:

  • CHAINNUM
  • CHANGESET_ID
  • EXPERT_RUN_ID
  • PRODUCT_NAME
  • STREAM_NAME
  • STREAM_VERSION
  • SUITE_NAME
VERSION_NAME-${CHANGESET_ID} Yes
Artefact directory Specify the relative path in the stream where assets are located. target\ Yes
Include To only publish specific files, enter one or more Ant patterns (one per line). To publish all files leave this field blank. *.war
*.jar
No
Exclude To exclude specific paths from being published, enter one or more Ant patterns (one per line). To publish all files leave this field blank. *.java
*.html
*.xml
No
Add Status Select this option to display the field Status Name.   No
Status Name (Visible if Add Status is selected) Specifies the Deployment Automation status to move the new component version to. STATUS_SUCCESS Yes (if Add Status is selected)
Deploy Select this option to display fields that specify how the new component version will be deployed.   No
Application Name Specify a Deployment Automation application (contains a component to be deployed). my_application Yes (if Deploy is selected)
Application Process Name Specify the Deployment Automation application process to be executed. my_deploy_app_process Yes (if Deploy is selected)
Environment Name Specify the Deployment Automation environment to deploy to. my-environment Yes (if Deploy is selected)
Deploy Properties Specify deploy properties that will be used to run the Deployment Automation application process.
Enter one pattern per line in this format: <property_name>=<prop_value>
set_up_db=true
use_logging_level=trace
No

Deployment Automation normally operates on binary files so add the DA Deployment expert to a chain that populates a workspace with built artefacts.

DA Generic Process

Overview

The DA Generic Process expert is a bundled expert that allows you to integrate PulseUno with Deployment Automation (DA) and run a DA global process on a specific resource. For example, you can use this expert to run a regular, repeated process when updated artefacts are delivered.

Prerequisites

The Deployment Automation server must be installed on your network, but not necessarily on the PulseUno server, where this expert can connect to it. The DA Generic Process expert has been tested with Deployment Automation server version 6.1.1.

You will need a working global process configured in your Deployment Automation server for the DA Generic Process expert to invoke.

Configure

Create server configuration file

The following DA Generic Process expert properties file is usually required: ${dataDir}/conf/experts/com.serena.starlight/sdaprocessexecutor/sda-pulse-expert.properties

The property below identifies the location of the Deployment Automation server, if the default value shown is correct you do not need to edit it:

Property Name Description Required Example
sdaServerUrl URL to the Deployment Automation server web application Yes http://localhost:8080/da

Configure expert settings

When you add this expert to a chain in PulseUno modify the following fields:

Field Name Description Example Required
Step Name Enter a name for this step in the chain. DA Generic Process Yes
Username Enter the username of a Deployment Automation server administrator. admin Yes
Password Enter the password of the Deployment Automation server administrator. admin Yes
Generic Process Name Specify the name of the Deployment Automation global process to be run on the Deployment Automation server. setup_net_process Yes
Resource Name Specify the name of the Deployment Automation resource on which the global process will be run. machine_without_net_resource Yes
Process Properties Specify properties that will be used to run the Deployment Automation global process.
Enter one pattern per line in this format: <property_name>=<property_value>
set_up_db=true
use_logging_level=trace
No

Deployment Automation normally operates on binary files so add the DA Generic Process expert to a chain that populates a workspace with built artefacts.

Dependency Vulnerabilities

Overview

The Dependency Vulnerabilities expert is a bundled expert that integrates the Open Web Application Security Project (OWASP) dependency-check tool that can scan Java, .NET, and Python applications and their dependent libraries.

This expert identifies vulnerable dependencies in the analyzed stream and displays the findings in the Experts section of a PulseUno Review page. One finding per vulnerability is displayed and there can be multiple vulnerabilities for each dependency. Each finding contains the ID of the vulnerability and the name of the dependency where it was found. A report file can be viewed from the Review page.

Prerequisites

There is no external software to install (the dependency-check 1.3.6 library is embedded in the Dependency Vulnerabilities expert). However, the expert relies on data from the National Vulnerabilities Database (NVD) web site to find vulnerabilities and requires access to the internet to download and update data.

On the first run the expert creates:

Configure

Create server configuration file

The properties file is optionally located in ${dataDir}/conf/experts/com.serena.starlight/dependencyvulnerabilities/dependencycheck-pulse-expert.properties. It contains configuration properties for both the Dependency Vulnerabilities expert and its embedded dependency-check library. You only need to create this file if you need to override one of the default values.

Property Name Description Example Value Default Value Required
pulseWarningCvssThreshold Vulnerabilities with a CVSS score less than the specified value are treated as a WARNING. 3.0 4.0 No
pulseErrorCvssThreshold Vulnerabilities with a CVSS score less than the specified value are treated as an ERROR. The value must be bigger than that specified for pulseWarningCvssThreshold. 9.0 7.0 Yes
pulseAutoUpdate

Automatically updates the CVE data. The possible values are:

  • ALWAYS
  • NEVER
  • ON_NEED
  ALWAYS  

NOTE All vulnerabilities with a CVSS score bigger than that specified for pulseErrorCvssThreshold are treated as FATAL. You should configure both, or none, of these properties.

Configure expert settings

When you add this expert to a chain in PulseUno modify the following fields:

Field Name Description Example Value Default Value Required
Step Name Enter a name for this step in the chain. Dependency Vulnerabilities Dependency Vulnerabilities Yes
Application name Enter the application name to be displayed in the report file. My-App   Yes
Include patterns To only include specific paths, enter one or more Ant patterns (one per line). To include all paths leave blank. *.war
**/*.jar
**/* No
Exclude patterns To exclude specific paths, enter one or more Ant patterns (one per line). To include all paths leave blank. target/*.class   No
Suppression file Enter the relative path in the stream to the suppression file. conf/suppression.xml   No
CVE Suppression List Enter a comma-separated list of CVE IDs to suppress. CVE-2008-0732,CVE-2011-5034   No
Enable Archive analyzer Scans these files types: ZIP, EAR, WAR, JAR, SAR, APK, NUPKG, TAR, GZ, TGZ   Yes No
Enable Jar analyzer Scans these files types: JAR, WAR   Yes No
Enable Assembly analyzer Scans these files types: EXE, DLL   Yes No
Enable Nuspec analyzer Scans the NUSPEC file type.   Yes No
Enable Python package analyzer Scans these files types: py, zip, PKG-INFO, METADATA   Yes No
Enable Python distribution analyzer Scans these files types: whl, egg, zip   Yes No
Enable CMaker analyzer Scans these files types: CMakeLists.txt, *.cmake     No
Enable NodeJS analyzer Scans this file type: package.json     No
Enable OpenSSL analyzer Scans this file type: opensslv.h     No
Enable Ruby analyzer Scans these files types: rakefile, *.gemspec     No
Enable Composer Lock analyzer Scans this file type: composer.lock     No
Enable Autoconf analyzer Scans these files types: configure, configure.in, configure.ac     No
Enable Central analyzer Checks for Maven GAV (Group/Artefact/Version) information in the scanned area.   Yes No
Enable Nexus analyzer Checks for Maven GAV (Group/Artefact/Version) information in the scanned area.   Yes No
Unstable threshold If there are vulnerabilities with a CVSS score higher than the value you specify, the expert result is UNSTABLE. If no value is set the result is SUCCESS. 7.0   No
Failure threshold If there are vulnerabilities with a CVSS score higher than the value you specify, the expert result is FAILURE. If no value is set the result is SUCCESS. 9.0   No

Automatically update CVE DB

Select an update option for the CVE database:

  • Never: never check for updates.
  • On need: only download if no database is present when the expert is initialized.
  • Always: check if an update is available before the expert runs.
     

For more information about analyzers, see the File Type Analyzers page.

The Dependency Vulnerabilities expert may report false-positive dependencies. For example, you consume a vulnerable library but you do not use the vulnerable functionality, or the vulnerability only applies in circumstances that does not apply to you. You can suppress any CVE by passing the suppression XML file with CVE suppressions (Suppression file property) or the CVE ID list (CVE suppression list property). For more information about suppression, see the Suppressing False Positives page.

The dependency-check analyzers operates on binary files so add the Dependency Vulnerabilities expert to a chain that populates a workspace with built artefacts.

Run a Docker container

Overview

Creates a Docker container, which is a runtime instance of a Docker image.

Configure

Field/Option Description Example Value Required
Step Name The name of this expert step.   Yes
Docker image name Enter the name of the Docker image that will be created.    
Pull image from registry Pull image from registry.    
URL

Enter the URL that matches the directory in the Docker engine from which you want to access a remote Docker Registry.

https://registry.company.com/  
Username Enter the name of the user who can access the Docker Registry.    
Password Enter the user's password.    
Email Enter the email of the Docker Registry user.    
Start container Start container.    
Attach container Attach container.    
Container name Enter the name of the Docker container that will be created.

 

 
Port mappings Bind the port number from the Docker host engine into the container. host_port:container_port, 80:8080  
Environment variables to pass to container. PULSE_USER=user  
Command to run in container (exec) The command to run in the Docker container. bash  
Container working directory Working directory inside the container. /app  
Volumes to mount into container Volumes to mount into container. /app/src:/app  
Mount volumes from another container.    
Verify TLS certificates Verify TLS certificates.    
Local file path on Agent to certificates.    
Configuration directory on Agent.    
Remote Docker API version.    

Build a Docker image

Overview

Creates a Docker image, which is an ordered collection of root filesystem changes and the corresponding execution parameters that you can use in a container runtime. An image typically contains a union of layered filesystems stacked on top of each other. You can optionally push the image to a Docker repository.

Configure

Field/Option Description Required
Step Name The name of this expert step. Yes
Root context directory for script The root context directory normally contains the dockerfile for the image.
Docker image name The name of the Docker image that will be created. Yes
Specify Dockerfile contents

The path to a Dockerfile.

Docker can build images automatically by reading the instructions from a Dockerfile. A Dockerfile is a text document that contains commands to be called at the command line.

 
Use cache when building the image You can cache the image layers inside the registry to avoid fetching the same content from the server to the registry on every pull operation. Set this parameter if your registry is remote from your Dimensions CM server.  
Push image to registry Push image to registry.  
URL

The URL that matches the directory in the Docker engine from which you want to access a remote Docker Registry.

 
Username The name of the user who can access the Docker Registry.  
Password The user's password.  
Email The email of the Docker Registry user.  
Verify TLS certificates Verify TLS certificates.  
Local file path on Agent to certificates.  
Configuration directory on Agent.  
Remote Docker API version.  

Run script in Docker container

Overview

Enables you to use a command to execute a script in a Docker container that is running, without logging into that container.

Configure

Field/Option Description Required
Step Name The name of this expert step. Yes
Docker image name Enter the name of the Docker image where the script will run.  
Mount workspace path Mounts a workspace in the container.  
Type of script

Select one of the following:

  • Use inline script
  • Use file path
 
Script language

Select a script language:

  • Shell Script
  • Windows Batch
Yes
File path Enter the path to the file that contains the command. Use single quotes to escape spaces in the path name.  
Command line Enter the command that you want to execute.  

 

Halt on failure

This expert does not have any parameters.

Fortify SCA

Overview

The Fortify SCA expert is a bundled expert that analyzes the source code of an application for security issues. Static Code Analyzer (SCA) identifies the root causes of software security vulnerabilities and delivers accurate, risk-ranked results with line-of-code remediation guidance.

Prerequisites

The Fortify SCA expert requires Fortify SCA (and any tools that it will use, such as Microsoft Visual Studio) to be installed and configured correctly for the named user account that Tomcat will run as.

NOTE Fortify SCA may not work if Tomcat is run as a Windows service under the LocalSystem account.

Configure

Create server configuration file

The Fortify SCA expert's server configuration file is mandatory and is located in: ${dataDir}/conf/experts/com.serena.starlight/hpfortify/hpfortify-pulse-expert.properties

Property Name Description Required Example
sourceAnalyzerPath

Specifies one of the following:

  • The full path to Fortify SCA sourcecodeanalyzer executable.
  • A wrapper script that sets extra parameters such as memory size.
Yes C:\\Program Files\\HP_Fortify\\HP_Fortify_SCA_and_Apps_4.30\\bin\\sourceanalyzer.exe
reportGeneratorExecutablePath Specifes the full path to the Fortify SCA report generator. Yes C:\\ProgramFiles\\HP_Fortify\\HP_Fortify_SCA_and_Apps_4.30\\bin\\ReportGenerator.bat
visualStudioExecutablePath Specifies the full path to Microsoft Visual Studio. No C:\\Program Files (x86)\\Microsoft Visual Studio 10.0\\Common7\\IDE\\devenv.exe

Example server configuration file:

sourceAnalyzerPath=C:\\Program Files\\HP_Fortify\\HP_Fortify_SCA_and_Apps_4.30\\bin\\sourceanalyzer.exe
reportGeneratorExecutablePath=C:\\ProgramFiles\\HP_Fortify\\HP_Fortify_SCA_and_Apps_4.30\\bin\\ReportGenerator.bat 
visualStudioExecutablePath=C:\\Program Files (x86)\\Microsoft Visual Studio 10.0\\Common7\\IDE\\devenv.exe

Configure expert settings

When you add this expert to a chain configure it as follows:

  1. Enter a name for this step in the chain.
  2. Select a custom translation option:
    • Yes: use a custom translation string. Enter a string in Custom translation options but only include phase options and exclude '-b'.
    • No: select translation options (see the table below).
  3. For Analysis phase optionally enter additional rulepack files or folders, one per line. You can specify an absolute path or one that is relative to the root of the stream. Use the sourceanalyzer Ant task rules attribute.
  4. To create a PDF of the report select Generate PDF report and enter the path of a report template. You can specify an absolute path or one that is relative to the root of the stream. If you do not specify a report template the default is used. Use the ReportGenerator utility's template option.
Translator type Option Description
Java sources Sources include pattern

Enter patterns for Java sources, for example: src/**/ *.java

Default pattern: **/*.java

 

Classpath

Enter a Java class path. The format is the same as javac (colon or semi-colon separated list of paths). Use the sourceanalyzer Ant task classpath attribute.
  Resolution source path Enter a path to a Java resolution sources folder. Sources are used for resolution not analysis. Use the sourceanalyzer Ant task sourcepath attribute.
 

Java version

Specify the JDK version the Java code is written for. Use the sourceanalyzer Ant task source attribute.
.NET sources Solution file path Enter the relative path to a solution file.
Other sources

Include pattern

Enter an 'include' pattern for other sources, for example: **/ *.sql

Jenkins

Overview

The Jenkins expert is a bundled expert that can invoke a Jenkins job on a remote Jenkins server. For example, use it to run a continuous integration build against each changeset as it is delivered and report the build time.

Prerequisites

The Jenkins server must be installed on your network, but not necessarily on the PulseUno server, for this expert to connect to. See the Jenkins documentation for more information about installing.

You must define a job on your Jenkins server that the expert will invoke.

Optionally add build parameters to the job so that information about the Dimensions CM stream and changeset are available in your build. Alternatively, allow the Jenkins expert to make any configuration change to the Jenkins job automatically (no manual changes to your Jenkins job are needed).

If you add the build parameters manually, select the option This build is parameterized in your Jenkins job configuration page and add each build parameter as a String Parameter. The values Default Value and Description in Jenkins are not important.

Jenkins Build Parameter Name Description Required
cmkey An opaque value that uniquely identifies the build run to the Jenkins expert.
Although shown here as Required, the Jenkins expert can automatically add this parameter to your Jenkins job and no manual job configuration is needed.
Yes
repo An opaque value that is different for each SCM repository. No
stream The name of the stream or project to which there was a delivery. No
version The stream or project version that the delivery created. No
changeset The repository (forest) version of the changeset for the delivery. No

NOTE The notification plugin required by PulseUno 14.1 is no longer needed by the Jenkins expert. You can remove it from your Jenkins jobs. If you allow the Jenkins expert to configure your PulseUno 14.1 Jenkins jobs, it adds the cmkey build parameter automatically (no other configuration is needed).

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Required
Step Name Enter a name for this step in the chain. Yes
Jenkins Job Location Specifies the URL for the Jenkins job (the location of the continuous integration server, including the job name). Yes
Username Specifies a Jenkins username. May be required if you are using Jenkins authentication. No
Password Specifies a Jenkins password or API token of the Jenkins user. May be required if you are using Jenkins authentication. No
Automatically add build parameters to Jenkins Job Automatically reconfigure the Jenkins job to add the mandatory build parameter cmkey. You can also add parameters manually (see above) if you prefer that the Jenkins expert does not touch your job. No
Record Jenkins Job build result Specifies whether the Jenkins expert should monitor the job and record its state it completes. No
Check Jenkins Job status every (seconds) If Record Jenkins Job build result is selected, specifies how often the Jenkins expert checks if the job has completed. No

TIP To find the value of the API token for a Jenkins user, log into your Jenkins server and open the user configuration page:
  1. Select your name at the top-right of the Jenkins page.
  2. From the Actions menu select Configure.
  3. Click Show API Token.
We recommend using the API token instead of a password, but you can use either value in the Jenkins expert.

If your Jenkins job requires a build authentication token before it can be triggered (see this Jenkins wiki page for details) add the token to the end of the Jenkins URL, for example: http://hostname:port/jenkins/job/MyProject/?token=buildtoken

The Jenkins expert:

Jenkins manages its own workspaces so you can add the Jenkins expert to a chain that does not populate a workspace.

Configure the output log

By default, the last 100 lines from the Jenkins log are displayed in the output log of a chain run and stored in the database.

TIP To reduce the database storage requirements for output logs, decrease the number of lines stored (for example, 20).

To change the number of lines that are displayed and stored:

  1. Open the Jenkins property file: ${dataDir}/conf/experts/com.serena.starlight/jenkins/jenkins-pulse-expert.properties
  2. Modify the value of this property: jenkins.console.lines.count 

Kiuwan

Overview

The Kiuwan expert is a bundled expert that integrates with Kiuwan Software Analytics in the Cloud, an online code quality and security service. If you are signed up to the Kiuwan service use this expert to:

Prerequisites

You must have an active account (username and password) for the Kiuwan service, have logged into the service, and configured an application name for your stream.

You must install the Kiuwan Local Analyzer on the PulseUno server.

Configure

Create server configuration file

The Kiuwan expert's server configuration file is mandatory and is located in: ${dataDir}/conf/experts/com.serena.starlight/kiuwan/kiuwan-pulse-expert.properties

Property Name Description Required Example
kiuwan.agent.command Specifies the full path to the Kiuwan Local Analyzer's agent launcher (agent.cmd or agent.sh not kiuwan.cmd or kiuwan.sh). Yes C:\\KiuwanLocalAnalyzer\\agent.cmd
kiuwan.poll.interval Specifies how often to check whether an analysis has completed (seconds). Yes 180
kiuwanUsername Specifies the username (email) used to log into the Kiuwan service. No cibuild@example.com
kiuwanPassword Specifies the password to log into the Kiuwan service. No I@m!S3cR3t
kiuwanAnalysisApplication Specifies the application name that has been configured in the Kiuwan account. No Qlarius

NOTE
  • You can specify the properties kiuwanUsername and kiuwanPassword when you add the Kiuwan expert to a chain. However, if you always use the same account it is more convenient to specify them in the server configuration file.
  • Normally the property kiuwanAnalysisApplication will vary based on the stream. However, if you always use the same application name you can specify it globally in the server configuration file.

Configure expert settings

When you add this expert to a chain in PulseUno modify the following fields:

Field Name Description Required Example
Step Name Enter a name for this step in the chain. Yes Kiuwan
Username Specifies a username for the Kiuwan account. No cibuild@example.com
Password Specifies the password for the Kiuwan account. No I@m!S3cR3t
Application Specifies the application name to register analysis results against in your Kiuwan account. No Qlarius

The properties Username, Password and Application are only optional if they have been configured in the server configuration file.

The Kiuwan Local Analyzer operates on source code files so add the Kiuwan expert to a chain that populates a workspace.

Maven

Overview

The Maven expert is a bundled expert that executes Maven goals.

Prerequisites

Maven must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Required
Step name Enter a name for this step in the chain. Yes
Execution goals Enter the goals to be executed, for example: Clean install Yes
Relative directory The path, relative to the stream’s root, where the build will run. No
Advanced Maven options

Specifies additional maven options (MAVEN_OPTS), for example:

-Xdiag -XshowSettings:all

No
Environment properties

Specifies pairs of 'key value' environment properties to use with this chain. Enter each pair in the format <key>=<value> on a separate line, for example:

  • JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,address=127.0.0.1:52515,suspend=y,server=n
  • JAVA_HOME=/usr/user1/java_1.8
No

Ant

Overview

The Ant expert is a bundled expert that runs Apache Ant builds. Apache Ant is an open-source build automation tool.

Prerequisites

Ant must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Example Required
Step name The name for this step in the chain.   Yes
Path to Ant

The location of the Ant executable. To use the location defined in your path, leave this field blank.

   
Targets A list of Ant targets, separated by spaces. To use the default target, leave blank.    
The path to the Ant build script relative to the checkout directory.    
The working directory if different from the location of the Ant build script.    
Optional list of Ant command-line parameters, separated by spaces. -dbug -DmyValue=1  
Location of the Java JDK. To use the system JAVA_HOME leave blank.    
Java options, separated by spaces. -Xms200m -Xmx700m  

Gradle

Overview

The Gradle expert is a bundled expert that runs Gradle builds. Gradle is an open-source build automation tool.

Prerequisites

Gradle must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Example Required
Step name The name for this step in the chain.   Yes
Select the Gradle runner type to use for this build.   Yes
Gradle task names, separated by spaces. To use the default task, leave blank. clean build  
The build path relative to the stream's root.    
The location of the Gradle installation.    
Gradle version to use. 4.5.1  
Gradle distribution to use. https://services.gradle.org/distributions/gradle-4.6-bin.zip  
Command-line build arguements.    
Log debug messages Logs debug messages (equivalent to -d)    
Print stacktrace Prints the stacktrace (equivalent to -s)    

Specify environment variables that will override other settings for this chain. Enter each variable on a seperate line in this format:

KEY=VALUE

   
Location of the Java JDK. To use the system JAVA_HOME leave blank.    
Java options, separated by spaces. -Xms200m -Xmx700m  

Makefile

Overview

The Makefile expert is a bundled expert that runs GNU Make builds. Make is an open-source build automation tool.

Prerequisites

Makefile must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Example Required
Step name The name for this step in the chain.   Yes
The location of the Make executable. To use the location defined in your path, leave this field blank.    
Makefile name. If left blank, the default one will be run. Makefile-1  
The location of the working directory if it is different to the checkout directory. Relative to the stream's root.    
Goals The Makefile goals to be executed. To use the default goal, leave this field blank.    
Options Additional flags -d  
Variables Additional variables, separated by spaces. myValue=1 myOtherValue=2  

MSBuild

Overview

The MSBuild expert is a bundled expert that runs the Microsoft Build Engine, a platform for building applications.  

Prerequisites

MSBuild must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Example Required
Step name The name for this step in the chain.   Yes
Project File Builds the targets in the project file that you specify. If you do not specify a project file, MSBuild searches the current working directory for a file name extension that ends in "proj" and uses that file. You can also specify a Visual Studio solution file for this argument.    
Options

Addtional options.

MSBuild Command-Line Reference

/t:Build /p:Configuration=Debug  

Specify environment variables that will override other settings for this chain. Enter each variable on a seperate line in this format:

KEY=VALUE

   

Visual Studio Build

Overview

The Visual Studio Build expert is a bundled expert that uses Microsoft Visual Studio to build applications and to create assemblies and executable programs. 

Prerequisites

Visual Studio Build must be installed on an agent and added as a capability.

Configure

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Example Required
Step name The name for this step in the chain.   Yes
Project File The path to the Visual Studio project file (.proj or .sln) relative to the stream's root.   Yes
Task Goal of the Visual Studio execution. Build Yes
Options Additional or custom options for Visual Studio. /p:Configuration=Release Yes

Specify environment variables that will override other settings for this chain. Enter each variable on a seperate line in this format:

KEY=VALUE

   

Fetch from Dimensions CM

Overview

A bundled expert that checks out source items from a Dimensions CM repository.

Configure

Field/Option Description Example Value Required
Step Name The name of this expert step.   Yes
Dimensions CM repository URL. scm:dimensions//dimensions-server/cm_typical@dim14  
User name The name of a registered CM user.    
Password The user's password.    
Stream The stream to fetch sources from. QLARIUS:QLARIUS_TEST  
Paths You can fetch specific folders instead of the entire stream. Specify each folder path on a new line. Leave blank to fetch the entire stream.

src/subdirectory-1

src/subdirectory-2

 
Clean workspace before fetching sources Clean the local work area before fetching sources.    

The version (changeset ID) of the stream to fetch.

Default: the latest (tip) version.

   

The sub directory to fetch sources to.

Default: the entire content of the local work area is replaced with the sources you are fetching.

   

Notification

Overview

Sends notifications by email if a chain succeeds or fails.

Configure

Field/Option Description Required
Step Name The name of this expert step. Yes
Failed Enter the emails (one per line) of users you want to be notified if the chain fails.  
Succeeds Enter the emails (one per line) of users you want to be notified when the chain succeeds.  

PMD

Overview

The PMD expert is a bundled expert that scans Java source code (and other languages) and looks for potential problems such as bugs, dead code, suboptimal code, overcomplicated expressions, and duplicate code. You can use it to find common programming flaws during your code review process. PMD is configurable and can find many different issues, for more information, see the PMD web site.

This expert has no prerequisites (the PMD 5.3.7 libraries are embedded in the expert so there are no external tools to install).

Configure

When you add this expert to a chain in PulseUno modify the following configuration fields:

Field Name Description Required Example PMD command line option Notes
Step Name Enter a name for this step in the chain. Yes PMD    
Source folder Enter the relative stream folder to run the analysis against. Yes src/main/java -dir Should be a relative path.
Rulesets location

Select a ruleset location:

  • Built-in rulesets
  • Local rulesets
  • Stored in the stream
Yes      
Rulesets Enter a comma separated list of rulesets names to use. Yes rulesets/internal/all-java.xml -rulesets For a full list of possible rulesets, see the PMD documentation. You can also use a custom ruleset.
Project classpath Specify the classpath for libraries used by the source code. No commons-collections.jar;derby.jar -auxclasspath  
Source encoding Specify the source code encoding. No UTF-8 -encoding  
Source language Specify the source code language. No Java -language  
Language version Specify the language version. No 1.7 -version  
Show suppressed Show suppressed findings. No false -showsuppressed  
Suppress marker Specify the suppress marker. No NOPMDNEWMARKER -suppressmarker  

The PMD command line option column shows how each PMD expert configuration field maps to the PMD command-line tool. For details, see the PMD documentation.

TIP The PMD expert and PMD command line tool both use the PMD core library. Any options that you can pass to the PMD command line tool you can also pass to the PMD expert.

PMD operates on source code files so add the PMD expert to a chain that populates a workspace.

Script

Overview

The Script expert is a bundled expert that enables you to specify one of the following:

TIP Store your script files in CM (paths should be relative to the stream root).

Configure

When you add this expert to a chain, configure it as follows:

  1. Enter a name for this step in the chain.
  2. From the Script Type list select one of the following:
    • Use inline command and enter an operating system command in the Command line box.
    • Use file path and enter the path in the File path box.
  3. From the Script Language list select Windows Batch or Shell Script.

You can use the following environment variables:

All the variables in the environment.properties file are available to the script as environment variables.

If the script exits with an exit code of 0, it is a SUCCESS. If the script exits with a non-zero exit code, it is a FAILURE.

SonarQube

Overview

The SonarQube expert is a bundled expert that runs static analysis against source code in a repository and reports findings and metrics. You can use it to analyze your source code on every changeset, or on a regular schedule, and optionally record the defects and metrics in your SonarQube server.

Prerequisites

The SonarQube expert requires SonarQube Runner, a command line application, to be installed and configured on the PulseUno server. A SonarQube server must be installed on your network (not necessarily on the PulseUno server) for this expert to connect to. For details see the SonarQube web site.

SonarQube expert uses the Web Service Java Client to make REST requests to a SonarQube server and has been tested with SonarQube server versions 5.6.x (Long Term Support) and 6.x.

The server configuration file ${dataDir}/conf/experts/com.serena.starlight/sonarqube/sonarqube-pulse-expert.properties must be present and set up correctly before you can use SonarQube expert.

Configure

Create server configuration file

The SonarQube expert properties file is mandatory and is located in: ${dataDir}/conf/experts/com.serena.starlight/sonarqube/sonarqube-pulse-expert.properties

Property Name Description Required Example
sonar.host.url Specifies the SonarQube Server URL. Yes http://localhost:9000
pulse.sonar.agent.path Specifies the full path to the SonarQube Runner application. Yes C:\\sonarrunner\\bin\\sonar-runner.bat
sonar.jdbc.url Specifies the JDBC connection URL for the SonarQube database. No jdbc:h2:tcp://localhost:9092/sonar
sonar.jdbc.username Specifies the database user for the JDBC connection. No sonar
sonar.jdbc.password Specifies the database password for the JDBC connection. No sonar
pulse.results.delay When SonarQube analyzes code that produces a large number of findings (2000) a short delay is needed before the results can be fetched. This delay is normally only required on the first run. On subsequent runs only the delta needs to be updated. Default: 30 seconds No 30

If you do not specify an optional property SonarQube Runner uses the default value specified in ${SONAR_RUNNER_HOME}/conf/sonar-runner.properties.

You can configure additional supported parameters in ${SONAR_RUNNER_HOME}/conf/sonar-runner.properties.

Configure expert settings

When you add this expert to a chain in PulseUno modify the following properties:

Field Name Description Required Example
Step Name Enter a name for this step in the chain. Yes SonarQube
Username Specifies the username for the web server connection. No admin
Password Specifies the password for the web server connection. No admin
Analysis mode Select an analysis mode:
  • publish
  • preview
  • issues
Yes publish
Project name Specifies the name of the SonarQube project that will be displayed in the web browser. Typically this is the value defined for <name> in Maven. Yes my_project
Project key Specifies the unique SonarQube project key. Typically this is the value defined for<groupId>:<artefactId> in Maven. Yes example-key
com.example:project1
Project version Specifies the SonarQube project version. Typically this is the value defined for<version> in Maven. Yes 1.0
Source folder Specifies the relative stream folder in the workspace to run the analysis against. Yes src/main/java
Full path to the SonarQube Scanner application Full path to the SonarQube Scanner application. No C:\\sonar-scanner\\bin\\sonar-scanner.bat

The properties Username and Password are optional and are only required in specific security situations, see the SonarQube web site for details.

The SonarQube Runner operates on source code files so add the SonarQube expert to a chain that populates a workspace.

WhiteSource

Overview

The WhiteSource expert is a bundled expert that identifies all the open source components and dependencies in your build, reports any known security vulnerabilities, and lists their licenses.

Prerequisites

Configure

Create server configuration file

The WhiteSource expert's server configuration file is located in: ${dataDir}\conf\experts\com.serena.starlight\whitesource\whitesource-pulse-expert.properties

Property Name Description Required Example
whitesourceServerUrl Specifies the URL to the WhiteSource server. Only change this URL if you are using the on-premise version of WhiteSource. No whitesourceServerUrl=https://saas.whitesourcesoftware.com

Example server configuration file:

whitesourceServerUrl=https://saas.whitesourcesoftware.com

Configure expert settings

When you add this expert to a chain in Pulse, specify the following fields:

Field Name Description Example Value Default Value Required
Step Name The name of this expert step.

WhiteSource

WhiteSource Yes
Api key The API key of a product registered in WhiteSource (also known as organization token). Copy the value from WhiteSource.     Yes
Product token The product token generated when registered in WhiteSource. Copy the value from WhiteSource.     No
Project token The project token generated when the product was registered in WhiteSource. Copy the value from WhiteSource.     Yes
Include pattern Use Ant patterns to include specific resources. Separate each pattern with a space. **/*.jar    
Exclude pattern Use Ant patterns to exclude specific resources. Separate each pattern with a space. **/*sources.jar **/*javadoc.jar    
Poll delay Specify how often, in seconds, the expert polls the WhiteSource database. 120 30  
Update Inventory Select this option to update the WhiteSource project dashboard with new information that was found. If not selected, the information is only reported in PulseUno.      

Changesets

About changesets

PulseUno uses changesets to visualize information about changes. A changeset is a logical grouping of changes that is automatically created every time you deliver changes in a stream/branch to a repository. A changeset enables you to identify, work with, and track, sets of changes. Every changeset that you deliver creates a new version of a stream/branch.

There are multiple ways that you can view the information in changesets:

You can view changeset information for spaces, products, streams, and branches. My Work displays changeset information specific to the user who is currently logged in.

You can filter the changeset graph, or any information view, to:

  1. Select a space, product, stream, or branch.
  2. Open the changeset graph or one of the information views.
  3. At top right click the date filter.
  4. (CM only) In the Stream Name box enter a wildcard to match stream and project names, for example: QLARIUS:JAV*
  5. TIP
    • You can enter multiple wildcard strings; separate each wildcard with a comma.
    • To hide specific streams or branches, add a minus '-' character at the start of the string, for example: -*JAV*
    • To only display streams or branches that you have marked as favorites, select Show favourites only.
  6. From the Start Date and End Date lists do one of the following:
    • Select a predefined date range.
    • Select Since or Until and use the date picker to manually select a date range.
    TIP
    • Start Date displays all data that matches the wildcard from the date that you specify.
    • End Date displays all data that matches the wildcard up to and including the date that you specify.
  7. Select other options as required, for example, show parent streams.
  8. Click Apply. The graph or view refreshes and displays data that matches the filters that you specified.

View changesets

Overview

A changeset graph visualizes streams and branches and their change history across multiple releases. The graph provides development teams and release managers with a visual understanding of what changes are being worked on, where, and why. Experts provide an opinion on the health of changes and an indication of release readiness. A changeset graph enables you to:

Changeset health

Changeset health is displayed visually using a combination of the expert opinions of the changes and the review state:

The changeset is currently healthy and the review was successful

The changeset is not healthy or the review failed

The changeset is unstable

Experts are running on the changeset

Experts are scheduled to run on the changeset

No experts were run on the changeset and no review is available

The changeset was stopped

When the review and experts are completed, a changeset icon has a solid border, for example:

When the review or any experts are in progress, a changeset icon has a border that is not solid, for example:

Display a changeset graph

  1. Select a space, product, stream, or branch.
  2. On the sidebar select Changeset Graph.
  3. (Optional) Filter the information that is displayed.
  4. Use the following methods to display the information on a changeset graph:
    • Mouse over a stream's label to display its changeset history.
    • Click a stream's label to display an overview.
    • Mouse over, or select, a changeset to highlight all the merge lines that connect it to other changesets.
    • Control-click changesets to highlight multiple merges.
    • Mouse over a changeset to display a summary.

    • Mouse over a changeset group to display the stream version range, and the result of the chains that ran on the most recent changeset.

View changeset details

Click a changeset to view its details. A pane at the bottom displays information including:

TIP
  • Control-click to select and view the details of multiple changesets.
  • Click a review to open the review page associated with a changeset.
  • (Administrators only) If a changeset did not create a review automatically, click Create Review to create one manually.

Group changesets

You can view changesets individually or grouped by days or weeks. Groups take up less space on the graph and look like this: The number of changesets contained in a group is displayed at the top right.

  1. Open a changeset graph.
  2. From the Changesets Graph list select one of the following:
    • Individual Changesets
    • Grouped by Days
    • Grouped by Weeks
TIP You can use keyboard shortcuts to navigate around this page.

Sort streams and branches on changeset graphs

On the changeset graph you can sort streams and branches by:

You can also sort streams and branches in ascending or descending order.

  1. Open a changeset graph.
  2. From the Streams sorted by list, select a sort option and a sort order.

View changeset history

The changeset history view displays changes to spaces, products, streams, and branches in chronological descending order. For each changeset the following information is displayed:

  1. Select a space, product, stream, or branch.
  2. On the sidebar, select Changeset History.
  3. (Optional) Filter the information that is displayed.
  4. Select a changeset to view its details.

View changeset pages

A changeset page displays information about a specific changeset including:

NOTE
  • Comments and findings are tied to the file version where they were added and shown when that version is displayed.
  • To display this changeset on the Changeset Graph click Show on graph.
  • To browse the contents of the parent stream at the time the changeset was delivered, click Code.
  1. Select a space, product, or stream.
  2. On the sidebar, select Changeset History.
  3. Select a changeset to view its details.

Customize Changeset Pages

You can customize if the following elements are displayed by default on a changeset page:

You can also select a white space option for viewing file differences, for example, Ignore White Space.

  1. Open a changeset page.
  2. Click Action and select Display Defaults.
  3. From the Show by Default select options.
  4. From the White Spaces list select an option.
  5. Click OK.

Run reports

Dashboard reports

Dashboard reports display statistics and trends that are generated from the activity in your streams and branches. Reports are scoped to the space, product, or stream from where you run them. If you are an administrator you can create and manage reports.

NOTE
  • Spaces can only run reports created at the space level.
  • Streams and branches can run all reports created at all levels.

Create reports

You can create a new report and add multiple panels. Each panel can have one of the following:

Metric panel icon  Metric: a chart with a single value, for example, the number of deliveries made.

Line chart panel icon  Line Chart: an illustration of data points at successive time intervals. Mouse over a time interval to display the data for each value.
Pie chart panel icon  Pie Chart: a circular statistical graphic that is divided into sectors to illustrate numerical proportion. Mouse over a sector to display its value. The value in the middle is the first metric's numeric value as a percentage of the total.
Bar chart panel icon  Bar Chart: a diagram in which the numerical values of variables are represented by the height or length of lines, or rectangles of equal width.
Table panel icon  Table: a set of data arranged in rows and columns.
  1. Select the level where you want to create the report (a space, product, or stream/branch).
  2. On the sidebar select Reports.
  3. From the Actions menu and select Create View.
  4. In the Title box enter a name for the new view.
  5. In the Note box optionally enter information about the report.
  6. Click Save.
  7. To add a panel to the report do the following:
    1. Click Add panel.
    2. Enter a name for the panel.
    3. Select a display type.
    4. Select Report on difference from previous value to show how a value has changed over time. For example, to show a trend such as the number of defects.
    5. Select a width for the display (as a percentage of the width of the main window).
    6. Select one of these metric types:
      • Review Metrics
      • Expert Metrics (only available for streams and branches)
    7. Click Add metric and select one from the list. You can add multiple metrics to these display types: pie charts, bar charts, and tables.
    8. Click Save.
  8. To add more panels repeat the previous step.
  9. Drag and drop panels to change their positions in the report.

Run reports

  1. Select the level at which you want to run the report (a space, product, or stream/branch).
  2. On the sidebar select Reports.
  3. From the Reports list select a pre-defined report.
  4. (Optional) Select a time period for the report (start and end dates).
  5. To refresh the report click Refresh.

Manage Reports

Administrators can delete and edit reports.

  1. Select the space, product, or stream/branch where the report is located.
  2. On the sidebar select Reports.
  3. From the Reports list select a report.
  4. To delete the report, from the Actions menu select Delete and confirm.
  5. To edit the report's title and description, from the Actions menu select Edit Title & Notes.
  6. To edit a report panel click Edit in its title bar. Modify the settings and click Save.
  7. To remove a panel click Delete in its title bar and confirm.
  8. Drag and drop panels to change their position in the report.

Changeset reports

The Changeset report displays information about changeset creation and health.

  1. Select the level where you want to display the report (a space, product, or stream).
  2. On the sidebar select Reports and then Changesets.
  3. Select a date range from the filter on the top right. The default is the last 3 months.

The Changesets Delivered section displays:

The Changesets by State section displays:

The Changesets Details section lists all the changesets delivered over the date range. Click a changeset or review label to view more details.

Request reports

The requests report displays information about request creation.

  1. Select the level where you want to display the report (a space, product, or stream).
  2. On the sidebar select Reports and then Requests.
  3. Select a date range from the filter on the top right. The default is the last 3 months.

The Requests Creation graph displays the creation of requests over time. There is a tab for each request type.

The Requests by state section lists the total number of requests per state. Click a state to display a list of all the associated requests. Click a request to view its details.

Review reports

The review report displays information about reviews created by changeset deliveries.

  1. Select the level where you want to display the report (a space, product, or stream).
  2. On the sidebar select Reports and then Reviews.
  3. Select a date range from the filter on the top right. The default is the last 3 months.

The Reviews tab displays:

The Top Reviewers tab displays the users who reviewed the most reviews.

The Top Owners tab displays the users who own the most reviews.

The Top Rework tab displays the users who have had the most reviews sent for rework.

Contributor reports

You can display a list of all the developers that have made deliveries. The tiles display the number of changesets delivered and the health of their chains:

Mouse over a colored section of a contributor's bar to display its percentage of the total number of changesets that have been delivered. The contributor's total number of deliveries is displayed to the right of their bar. The total number of contributors and deliveries for all developers is displayed at the top of the page.

  1. Select the level where you want to display the report (a space, product, or stream/branch).
  2. On the sidebar select Reports and then Contributors.
  3. Select a date range from the filter on the top right. The default is the last 3 months.

Delivery activity reports

You can display the days and hours when deliveries were made. Larger circles indicate higher activity.

  1. Select the level where you want to display the report (a space, product, or stream/branch).
  2. On the sidebar select Reports and then Punch Card.
  3. Select a date range from the filter on the top right. The default is the last 3 months.

Configure user preferences

Subscribe to email notifications

You can select the review, pull request, and vault email notifications to which you are subscribed. Notifications are sent when an event takes place, for example:

NOTE The list of review notifications is managed by your PulseUno administrator.
  1. On the top navigation click My Work.
  2. On the sidebar select Preferences > Email Subscriptions.
  3. Select the Review or Vault tab.
  4. Select, or unselect, notifications.
  5. Click Save.

Set changeset graph defaults

You can set defaults for how the changeset graph is displayed.

  1. On the top navigation click My Work.
  2. On the sidebar click Preferences.
  3. In the Changeset Graph Defaults section, from the Display Scale list select one of the following:
    • Changeset: display individual changesets.
    • Daily: groups changesets by days.
    • Week: groups changesets by weeks.
  4. Select a Zoom Level.
  5. Click Save.

Set view defaults

You can set defaults for how Views are displayed. Views include Reports, the Changeset Graph, Changeset History, Contributors, and Punch Card.

  1. On the top navigation click My Work.
  2. On the sidebar click Preferences.
  3. In the Default Time Period for Views section select the default Start Date and End Date range for the data that is displayed.
  4. Click Save.

Administer

To administer PulseUno you must be logged in as a user with administrator privileges.

Configure the avatar server

Avatars help to build a community between your users by providing them with a graphical alter ego. Administrators can configure where PulseUno obtains user avatar images.

  1. On the top navigation click Administration.
  2. Select User Data and Avatars.
  3. Select one of the following sources for avatar images and user data:
    • Disabled: all avatars display the default user picture.
    • Repository: use a repository to find avatar images, full names, and email addresses for your users. Select a respository from the Repository Details list.
    • Solutions Business Manager: use an SBM server to find avatar images and full names.
      NOTE To use SBM avatars, PulseUno and SBM must be configured to use the same SSO server.
    • LDAP Server: use the LDAP settings to find avatar images, full names, and email addresses. See the instructions in the next step.
    • Gravatar: use an email address suffix.
  4. If you selected LDAP, specify the following information:
    • Server URL
      The URL of the LPAP server, for example:
      ldap://domain-controller.example.com:389
    • Username
      The bind user to perform searches as, for example:
      cn=binduser,ou=Organizational Unit 1,ou=Organizational Unit 2,dc=example,dc=com
    • Password
      The password of the LDAP bind user.
    • Base DN for search
      The base DN to search from, for example:
      dc=example,dc=com
    • Avatar image attribute
      The LDAP attribute containing avatar image data, for example:
      thumbnailPhoto
    • Search filter
      The LDAP search filter to match objects, for example:
      (&(objectClass=person)(sAMAccountName={0}))
    • Follow LDAP referrals
      To enable searches to follow LDAP referrals, toggle Follow LDAP referrals to Yes.

Configure Special Services

Administrators can configure the servers that provide specialized services to PulseUno, such as Solutions Business Manager.

  1. On the top navigation click Administration.
  2. Select Servers.
  3. In the Solutions Business Manager URL box enter the URL for the SBM user workspace, for example:
    http://sbm-server.example.com/tmtrack/tmtrack.dll?
  4. In the Email Address Domain Suffix box enter the suffix that is automatically appended to user names to form email addresses, for example:
    @example.com.
  5. Click Save.

Administer email notifications

Administrators can manage the review email notifications that users can subscribe to, and unsubscribe from. If a notification is disabled, users will not see the notification listed in their subscription preferences. If a notification is available, users can choose to subscribe to it.

  1. On the top navigation click Administration.
  2. Select Notifications.
  3. For each notification type select one of the following:
    • Disabled: the notification is not available for users to subscribe to.
    • Send notification: the notification is sent to users by default though they can unsubscribe from it.
    • Do not send notification: the notification is not sent to users by default though they can subscribe to it.
  4. If you do not want users to receive code fragments in email notifications, unselect the option Include code fragments.
  5. Click Save.

Manage users

This section explains how to add new users, lock, disable, and delete existing users, and assign or remove an administrator role.

A user can be one of the following types:

Assign or remove an administrator role

NOTE In PulseUno for Dimensions CM, users are registered automatically when they log in. Administrators only need to configure which users have administrator privileges.
In PulseUno for Git, if internal authentication is used (default), administrators can add and remove users as well as change passwords. For details, see Change a user's password to PulseUno. If PulseUno for Git is configured for external authentication, for example, with LDAP, these functions are restricted.

To assign or remove an administrator role:

  1. In PulseUno, navigate to Administration > Users.
    A list of users is displayed including their user name, full name, email address, and user type.
  2. To assign administrator permissions, select one or more standard users. In the Actions menu, select Add administrator privilege.
  3. To remove administrator permissions, select one or more administrators. In the Actions menu, select Remove administrator privilege.

Add users

As an administrator, you can add new users if your PulseUno for Git instance uses standard password authentication.

To add a user:

  1. In PulseUno for Git, navigate to Administration > Users.
  2. On the Users page, click the New User (+) icon.
  3. In the Add User dialog box, specify the following user details:
    Field Description
    User Name

    Enter a username for logging in.

    Full Name

    Enter a user’s first and last name.

    Email Address

    Enter a user’s main email address.

    Secondary Email

    (Optional) For increased security, enter an additional email address.

    Role (Administrator)

    Select this option to assign a user an administrator role.

  4. Click Add.
    To add another user, click Add & Another.

After you have added a new user, proceed to set the user's password. For details, see Change a user's password to PulseUno for Git.

Lock and disable users

As an administrator, you can lock, unlock, disable, and enable user accounts.

A locked user can no longer access PulseUno but can still be added as a reviewer and receives notifications. Use this option if you need to temporarily prevent a user from logging in to PulseUno.

A disabled user can no longer access PulseUno, be added as a reviewer, and receive notifications. Use this option if you need to permanently deactivate a user's account.

To lock a user:

  1. In PulseUno, navigate to Administration > Users.
  2. On the Users page, select a user from the list. Use search to help you find users.
  3. From the Actions menu, select Lock.

To unlock a user's account, select Unlock from the Actions menu.

To disable a user:

  1. In PulseUno, navigate to Administration > Users.
  2. On the Users page, select a user from the list. Use search to help you find users.
  3. From the Actions menu, select Disable.

To activate a disabled account, select Enable from the Actions menu.

Delete users

As an administrator, you can remove users from PulseUno for Git.

NOTE Deleting a user is permanent. You cannot restore a deleted account.

To delete a user:

  1. In PulseUno, navigate to Administration > Users.
  2. On the Users page, select a user from the list. Use search to help you find users.
  3. Click the Delete icon and then confirm your action.

Deleted users are removed from the list of users in the UI, and their previous activity is displayed under anonymized names, for example, Deleted user 123.

See also

Manage members and teams

Create chain and vault retention policies

By default, chain findings and vault packages are kept for 30 days. Administrators can create custom retention policies and apply them to chains and vaults.

NOTE In the following procedure, items refers to:
  • Chain findings
  • Vault packages
  1. On the top navigation click Administration.
  2. Select Retention Policies.
  3. Click New Retention Policy.
  4. Enter a title and description for the new retention policy.
  5. Specify the number of items to be retained in the log, for example: 100
  6. Specify how many days items in the log will be retained, for example: 365 (one year)
  7. Specify the maximum size of the log in megabytes, for example: 1024 (a gigabyte). When the log reaches the defined size the oldest items are purged.
  8. Click Save.

Configure connections to Dimensions CM repositories

As an administrator, you can add and modify connections to Dimensions CM repositories (base databases).

NOTE During installation or upgrade of PulseUno a CM repository should automatically be registered. If no repositories are listed you need to add one.
To create or edit a Dimensions CM connection:
  1. On the top navigation click Administration.
  2. Select Connections.
  3. Do one of the following:
    • To add a new repository select New Connection (+) and select Dimensions CM.
    • To edit the connections for an existing repository, select it from the list.
  4. In the Title field, enter or modify the name of the Dimensions CM repository.
  5. In the Server box field, enter or modify the network name of the Dimensions CM server, for example: dm-server.example.com
  6. In the Base database name field, enter or modify the database connection, for example: CM_TYPICAL@DIM14 These two values, separated by the @ symbol, are the same information that you enter in the DB name and DB connection boxes when you log into a Dimensions CM client.
  7. Enter a Dimensions CM account username and password.
  8. Select or clear the Always use the credentials option. For details about using this option, see Configure access to repositories.
  9. Click Save.

Configure access to repositories

When PulseUno accesses a Dimensions CM repository, it presents a set of credentials. The credentials used for each repository depend on how you set the option Always use the following credentials in the repository connection:

Set integrations with roles and request states

Administrators can set PulseUno integrations with Dimensions CM roles and request states.

NOTE
  • Actioning a request to In Review causes the review rules to run and will typically change the review's state to In Review.
  • Apart from Reviewer role name in CM, the integrations are optional. Leave an integration blank to disable it. Leave all boxes blank unless your CM request lifecycle includes an In Review state.
  • If you do not want to automatically copy role assignments to PulseUno, or push states from PulseUno, do not use this integration. Users can make changes manually in PulseUno and Dimensions CM without this integration.
  1. On the top navigation click Administration.
  2. Select Connections.
  3. Select a Dimensions CM repository.
  4. Select the Reviews or Pull Requests tab.
  5. For Reviewer role name in CM enter a Dimensions CM role. Users that hold this role can be selected as reviewers in PulseUno. If you do not specify a role, the default REVIEWER is used.
  6. For In Review state name in CM enter a comma separated list of CM request states that can add reviewers to associated PulseUno reviews. PulseUno listens for Action Request notifications from Dimensions CM. When a request enters one of these named states in CM, its Reviewer role assignment is copied to PulseUno, and its review rules are executed.
  7. For Rework state name in CM enter the CM state to which requests are actioned when any associated PulseUno review is sent for rework.
  8. For Approved state name in CM enter the CM state to which requests are actioned when any associated PulseUno review is sent for rework or marked as approved.
  9. (Pull requests only) For Completed state name in CM enter the CM state to which associated PulseUno requests are actioned when any pull request is merged.
  10. Click Save.

Clear PulseUno caches

If you have made a configuration change and it is not visible, try clearing the relevant cache.

To clear a cache:

  1. In PulseUno, navigate to Administration.
  2. In the sidebar, select Caches.
  3. Click Clear to empty a cache.
  4. To clear all caches click Clear All.

Other administrative tasks

For information about the following PulseUno administration tasks, see the Dimensions CM Administration Guide:

Markdown syntax reference

Markdown is a syntax used to format information in plain text. You can use Markdown in any external text editor and copy the contents to PulseUno, retaining a consistent look for all comments. The formatting is created with special sequences of punctuation characters in plain text.

Character formatting

*This is italicized*, and so is _this_ This is italicized, and so is this
**This is bold**, and so is __this__ This is bold, and so is this
***Italics and bold*** together, as is ___this___ Italics and bold together, as is this

Inline code and code blocks

`Back-quote character` (also known as backtick
or grave) is used for inline code
___
Back-quote character (also known as backtick or grave) is used for inline code
Use 4 space indent for code blocks.

    Some code line 1
    Some code line 2
Back to normal text again.

Use four space indent for code blocks.

Some code line 1
Some code line 2

Back to normal text again.

Line breaks and paragraphs

Normally a single newline
is ignored.
___
Normally a single new line is ignored.
End a line with two spaces  
to cause an explicit line break.
___
End a line with two spaces
to cause an explicit line break.
Separate paragraphs.

With a blank line.
___

Separate paragraphs.

With a blank line.


Add a > to the beginning of a line to create
a block quotation
> Multiple quoted lines will
> wrap together.
Add a > to the beginning of a line to create a block quotation
Multiple quoted lines will wrap together.

Simple lists

- Use a minus sign for a bullet
+ Or a plus sign
* Or an asterisk
___
  • Use a minus sign for a bullet
  • Or a plus sign
  • Or an asterisk

1. Numbered lists can use
9. Any numbers
7. The steps will be renumbered
  1. Numbered lists can use
  2. Any numbers
  3. The steps will be renumbered
Basic link to http://example.com.
___
Basic link to http://example.com.
Inline link to [An Example Web Site](http://example.com/).  
Numbered reference link to [An Example Web Site][1].  
Named reference link to [An Example Web Site][example].

  [1]: http://example.com.
  [example]: http://example.com/
Inline link to An Example Web Site.
Numbered reference link to An Example Web Site.
Named reference link to An Example Web Site.

Headers and rules

Header 1
=========

Header 1

Header 2
---------

Header 2

A horizontal rule is three or more hyphens,
asterisks or underscores on the same line with no other characters.
___
A horizontal rule is three or more hyphens, asterisks, or underscores on the same line with no other characters.

Agile request management

About requests

Requests are used to track and approve the changes your team is making. A request is a single unit of work, equivalent to a story in Agile planning, that can report a defect, suggest an enhancement, or detail other work for a particular product. You use story points to estimate the size of a request. Each request type has a lifecycle assigned to it that determines which users may work on the request. For information about request lifecycles see the Dimensions CM Process Configuration Guide.

The request catalog displays all the requests in a CM product or stream. You can open any request and view its details.

View the request catalog and open requests

  1. Select a product or stream.
  2. On the sidebar click Request Catalog. Each row displays information about a request including its owner, lifecycle state, and any backlogs and iterations to which it belongs.

  3. TIP You can sort the list and search for specific requests.
  4. To open a request select it.
    • General tab: displays information about the request, including:
      • A summary of the request
      • The request's acceptance criteria
      • Attachments
      • Related requests
      • Associated reviews
      • Associated changesets
      • Total and remaining story points
      • A burndown chart (if the request is included in an iteration)
      • An external link, for example, the URL of an external web site or the value of an SBM ticket related to the request. If the value is a hyperlink, it opens in a new tab or window. This field only displays a value if it has been mapped to request attributes. An external link may look similar to this:
      • The request owners and their capabilities
      • Any iteration, backlog, or epic to which the request belongs
      • The related stream and design part
      • NOTE The fields that are displayed can be configured by your PulseUno administrator.
    • Attributes tab: each request type has different user defined attributes, which record important information about the request. For example, Estimated completed date, Raised by, and Severity. Some attributes may be required.
    • Action History tab: displays information about when the request was actioned to different states in its lifecycle and the users that performed the action. To filter the action history, select a lifecycle state.

Configure request types

Administrators can:

  1. Select the product where you want to enable request types.
  2. On the sidebar select Product Settings and then Request Types.
  3. Select the request type that you want to configure.
  4. Select or deselect Enable request type.
    • Enable: existing requests of this type are visible and you can create new requests.
    • Disable: existing requests of this type are visible but you cannot create new requests.
  5. In the Attributes Mappings section, map this request type's attributes to request attributes defined in CM (see below).
  6. Click Save.

Administrators can configure request types to display external links, see the next section.

Map PulseUno attributes to CM request attributes

To enable Agile planning, PulseUno requires additional fields. You can store these fields in PulseUno or map them to CM request attributes:

PulseUno attribute Description Default mapping Can be mapped to
Summary

A detailed description of the request. You can display the text in this field as:

Detailed description Single-value character field or Detailed description
Acceptance Criteria Specifies the criteria to be met before the request is considered to be complete. Not mapped (stored only in PulseUno database) Single-value character field or Detailed description
Remaining Story Points The estimated effort left to complete the request (in arbitrary units, such as story points). Used to generate the burndown charts. Not mapped (stored only in PulseUno database) Single-value number field
Total Story Points The total effort estimated to complete the request (in arbitrary units, such as story points). Used to generate the burndown charts. Not mapped (stored only in PulseUno database) Single-value number field
Blocked Specifies if a request is blocked and cannot be progressed. Typically a Yes/No attribute. Not mapped (stored only in PulseUno database) Single-value character field with a valid set that has at least two values. You must specify which value means Yes and which value means No.
Define an External Link

Defines an external link, for example, a link to an SBM ticket or an external URL. The link you define is displayed in the External Link section of a request.

   
Attribute Containing the Visible Value

Select a request attribute to display the value of an external link. For example, select the attribute that displays the value of a specific SBM ticket that is related to this request. The attribute may be similar to SBM Issue. Ask your CM administrator for the correct attributes to use.

Not mapped (stored only in PulseUno database) Single-value character field
Attribute Containing the URL

Select a request attribute that contains the link to an external item. For example, select the attribute that displays the URL of a specific SBM ticket that is related to this request. The attribute may be similar to SBM Hyperlink. Ask your CM administrator for the correct attributes to use

Not mapped (stored only in PulseUno database) Single-value character field
 

Notes:

  • Request attributes can be customized by your CM administrator.
  • If you do not define Attribute Containing the URL, the displayed value will be static (not a hyperlink).
   

About backlogs

Backlogs enable you to organize your team’s work and group requests into a prioritized hierarchy of epics and features. An epic is a large unit of work that is typically broken down into smaller units of features and requests.

NOTE
  • Epics, features, and requests can only belong to one backlog, but you can move them between backlogs.
  • Epic and features are optional and you can plan a flat backlog that only contains requests.
  • Backlogs are located at the product level in PulseUno.
  • You can view a backlog as a hierarchy or a flat view.

About iterations

An iteration is one development cycle, commonly known as a sprint, which is typically a few weeks. An iteration includes the requests your team are confident they can complete during the sprint. As an iteration progresses, the remaining effort required to complete the requests should decrease. You can view an iteration as a list or a card wall. Iterations are located at the product level in PulseUno.

The Content tab displays the content of an iteration in a flat list and includes information such as:

TIPYou can show or hide request labels and closed requests.

On a Card Wall tab each card displays information about a specific request such as:

Cards are grouped in rows by request type with a separate column for each lifecycle state. Each request type displays the number of requests that are blocked, hidden, and unassigned.



A card wall also displays metrics about the progress of the current iteration:

The History tab displays changes made during an iteration, for example, requests that were added.

Create new requests

  1. Do one of the following:
    • Open the backlog where you want to add the request. Optionally select the epic or feature that will contain the request. To add the new request at the top level of the backlog, do not select an epic or feature.
    • Open the request catalog.
  2. Click New and select a request type, for example, ECR.
  3. On the General tab do the following:
    • Give the request a title and summarize its purpose.
    • For Acceptance Criteria specify the criteria to be met before the request is considered to be complete.
    • For Story Points estimate the total number of points required to complete the work and the points remaining until will be finished. Story points are an estimation of a request’s relative complexity compared to other requests, and the effort required to complete it.
    • Optionally relate the new request to a stream and design part.
  4. On the Attributes tab specify or select values. Each request type has different attributes and some may be mandatory. The attributes are similar to those in the other CM clients.
  5. TIP
    • You can hide read-only attributes.
    • Only attributes that you have the privilege to edit are displayed.
    • The fields that are displayed depend on the request type and how it has been customized by the CM administrator.
  6. Click Save.

Create a new request based on an existing request

You can also create a new request based on the properties of an existing request. In CM this is known as priming a request. The new request can be:

NOTE The request on which you are basing the new request must have a priming relationship. For details see the Dimensions CM Process Configuration Guide.
  1. Open the request catalog.
  2. Open the request that you want to prime.
  3. Click Prime To and select a request type.
  4. Select a relationship type, for example, Duplicate.
  5. Click Prime.
  6. Complete the form the same as for a new request.

Add an action description to a request

You can add an action description to a request without actioning it.

  1. Open the request where you want to add a description.
  2. Click Action and select Add Action Description.
  3. Enter a description and click Add.

Plan and manage a backlog

You typically start backlog planning by:

NOTE You must be an administrator or a backlog owner.

Create a request backlog

If you are an administrator, you can create a new backlog and assign backlog owners. A backlog owner can manage its content, for example: add, remove, and rank items. The backlog owners can be changed by an administrator or another owner.

  1. Select the product where you want to create the new backlog.
  2. On the sidebar select Backlog.
  3. Click New.
  4. Give the backlog a name and summarize its purpose.
  5. (Optional) To assign one or more owners:
    • Click Add. The Add Owner dialog box is displayed.
    • In the Search box enter a string that matches registered PulseUno users.
    • Select one or more users and click Add Owner.
  6. Click Save.

Open a backlog

  1. Select the product containing the backlog.
  2. On the sidebar select Backlogs.
  3. Select a backlog or search for one by title or ID#.
TIP
  • Select these options at the bottom of a backlog page:
    • Planned requests that are already included in an iteration
    • Request labels
    • Closed requests
  • To display the requests as a flat, ranked list, click .

Create an epic or feature

  1. Open the backlog where you want to create a new epic or feature.
  2. (Optional) Click New and select Epic or Feature.
  3. Give the epic or feature a title and summarize its purpose.
  4. Click Save.
  5. Add additional epics and features as required.
  6. To change the hierarchy, drag and drop epics and features in the backlog.

Add a request from the request catalog

You can add an existing CM request that originated from inside or outside your team.

  1. Open the backlog where you want to add a request.
  2. Click to show the right panel and select Request Catalog.
  3. Select a request and drag it to a specific place in the backlog hierarchy on the left panel.
TIP
  • You can search for a request using various criteria, for example, title or ID.
  • A backlog or iteration's label is displayed if the request is already included in one.
  • The request catalog displays all the requests in the current CM product.

Move epics, features and requests between backlogs

You can move epics, features, and requests between backlogs. An object can only belong to one backlog; if you move one to the target backlog it is removed from the source backlog. When you move a feature its child requests are also moved.

  1. Open the backlog where you want to move an object to.
  2. Click to show the right panel and select Backlogs.
  3. Select a backlog or search for one by title or ID.
  4. Select an epic, feature, or request and drag it to a specific place in the backlog hierarchy on the left panel.
TIP
  • A backlog hierarchy automatically expands when you drag an object over it.
  • You can also move objects from the backlog on the left to the one on the right.

Prioritize and rank requests in a backlog

In each backlog, requests are ranked in descending order of priority in their parent epic or feature. You can rank and prioritize requests in the structured or flat view.

TIPTo hide epics and features, display the flat view.
  1. Open the backlog where you want to prioritize and rank requests.
  2. Click to display the flat view.
  3. Select a request and drag it to a different position in the hierarchy.

Mark a request as blocked

If you cannot continue working on a request you can mark it as blocked.

  1. Open the backlog containing the request you want to block.
  2. Select the request.
  3. Select Mark Blocked. In the backlog the request is now labeled as Blocked.

Delete an epic, feature or request

You can delete an epic, feature, or request from a backlog. If you select an epic that has child features they are also removed. Any requests contained in an epic or feature are removed from the backlog and made available to the team.

NOTE Requests removed from a backlog are not deleted from Dimensions CM.
  1. Open the backlog where you want to delete objects.
  2. Select one or more epics, features, or requests. Multiple objects that you select must be at the same level in the backlog hierarchy. For example, you can only select requests and features that are at the same level in an epic.
  3. Click Delete.

Plan and manage an iteration

Create an iteration from a backlog

You can create a new iteration from a backlog if you are an administrator or the backlog owner. The new iteration can only include requests that are not already assigned to another iteration. Requests that you can add have a green circle next to their label . If you select an epic or feature, its child requests are included in the new iteration.

  1. Open a backlog.
  2. Select one or more epics, features, and requests. Multiple objects that you select must be at the same level in the backlog hierarchy. For example, in an epic you can only select requests and features that are at the same level.
  3. Click Create Iteration.
  4. In the Create Iteration dialog box do the following:
    • Give the iteration a name and summarize its goals.
    • Specify the duration of the iteration and a start date.
  5. Click Save.

Create an iteration from an existing iteration

You can create a new iteration containing requests from an existing iteration if you are its owner or an administrator. This is useful when you have finished a sprint and want to move uncompleted requests to a new iteration. The owner of the source iteration becomes the owner of the new iteration and the selected requests are moved to the new iteration.

  1. Select the product where you want to create the new iteration.
  2. On the sidebar select Iterations.
  3. Select the iteration that will be the source for the new iteration.
  4. Select one or more requests.
  5. From the Move To menu select New Iteration.
  6. In the Create Iteration dialog box do the following:
    • Give the iteration a name and summarize its goals.
    • Specify the duration of the iteration and a start date.
  7. Click Start.

Create a new empty iteration

If you are an administrator you can create a new, empty iteration.

  1. Select the product where you want to create the new iteration.
  2. On the sidebar select Iterations.
  3. Click New.
  4. Give the iteration a name and summarize its goals.
  5. Specify the duration of the iteration and a start date.
  6. (Optional) To add an owner:
    • Click Add. The Add Owner dialog box is displayed.
    • In the Search box enter a string that matches registered PulseUno users.
    • Select one or more users and click Add Owner.
  7. Click Save.

Open an iteration

  1. Select the product containing the iteration you want to view.
  2. On the sidebar select Iterations.
  3. From the list select one of the following: Recent, Owned by me, Current, Future, Previous
  4. Select the iteration.
TIPYou can search for a request using various criteria, for example, title or ID.

Add a request from a backlog

You can add a request from a backlog to an iteration if you are the owner of the iteration or an administrator. You can only add requests that are not already assigned to another iteration. Requests that you can add have a green circle next to their label .

  1. Open the iteration where you want to add a request.
  2. Click the Content tab.
  3. Click to show the right panel.
  4. On the right panel select Backlogs.
  5. Select a backlog or search for one by title or ID.
  6. Select a request and drag it to any position in the iteration on the left.

Move a request from another iteration

You can move a request from another iteration if you are the owner of both iterations. The request is removed from the source iteration and added to the target iteration.

  1. Open the iteration where you want to add a request.
  2. Click the Content tab.
  3. Click to show the right panel.
  4. On the right panel select Iterations.
  5. Select an iteration or search for one by title or ID.
  6. Select a request and drag it to any position in the iteration on the left.

Prioritize and rank requests

In each iteration, requests are ranked in descending order of priority. To change a request's position, do one of the following:

Move requests to another iteration

You can move requests to another iteration if you are the owner of both iterations.

  1. Open the iteration from where you want to remove requests.
  2. Click the Content tab.
  3. Click to show the right panel.
  4. On the right panel select Iterations.
  5. Select a target iteration or search for one by title or ID.
  6. In the source iteration on the left select the requests that you want to move.
  7. Select Move To and then Iteration on Right <iteration ID>.

Move requests to a new iteration

You can move requests from an existing iteration to a new iteration.

  1. Open the iteration from where you want to remove requests.
  2. Click the Content tab.
  3. Select the requests that you want to move.
  4. Select Move To and then New Iteration.
  5. Give the new iteration a name and specify its duration and start date.
  6. Click Start.

Edit an iteration

You can edit an iteration if you are the owner or an administrator.

  1. Open the iteration that you want to edit.
  2. Click Edit.
  3. Edit the iteration.
  4. Click Save.

Remove requests from an iteration

You can remove requests from an iteration if you are the owner or an administrator. After you remove a request it can be added to other iteration.

  1. Open the iteration from where you want to remove requests.
  2. Select one or more requests.
  3. Click Remove and confirm.

Delete iterations

You can delete one or more iterations if you are the owner or an administrator.

  1. Select the product containing the iterations.
  2. On the sidebar select Iteration.
  3. Select one of these tabs: Current, Future, Previous
  4. Select iterations.
  5. Click Delete and confirm.

View request details on a card wall

When the card wall is displayed you can view a request's details.

  1. Open an iteration and display the card wall.
  2. Select a card. The request's details are displayed on the right.

Create space on a card wall

You can create space on a card wall and only display the information that you require by:

Compact card wall example

  1. Open an iteration and display the card wall.
  2. To collapse a request type, toggle the arrow on the left.
  3. To collapse a lifecycle state, hover over the column title and click
  4. At the bottom of the card wall, click Show charts and/or Show compact cards.

Group requests on a card wall

You can group requests on the card wall by users. This enables you to:

  1. Open an iteration and display the card wall.
  2. At the bottom of the card wall, click Group by user.

Display off-normal request states

Off-normal request lifecycle states are not displayed by default.

NOTE Normal states follow a progressive path through a lifecycle. Off-normal states are not located on that path.
  1. Open an iteration and display the card wall.
  2. At the bottom of the card wall select Show off normal states. If an off-normal state column is collapsed, click to expand it.

Action requests

You can action a request to a new lifecycle state if it is in your Inbox or you are a Dimensions CM administrator.

NOTE
  • Normal Dimensions CM roles and privileges apply.
  • You can only action to the Approved state when all the related reviews are approved.

Action a request from a backlog or iteration

  1. Open the request that you want to action.
  2. Click Action To and select a lifecycle state from the list. The Action Request dialog box is displayed.
  3. On the General tab optionally modify the total and remaining story points.
  4. Click the Owners tab and optionally add users who will own the request after it is actioned:
    1. Click Add. A dialog box displays a list of all the users that can be added as owners.
    2. From the Role to assign list, select the role with which to assign the new owners, for example, Developer.
    3. From the Capability of users list, select a capability for the new owners. For more information see the Dimensions CM Process Configuration Guide.
    4. Select one or more users and click Add.
  5. When you action a request you may need to provide additional information on the Attributes tab, some of which might be required.
  6. Click Action.

Action a request from a card wall

  1. Open the iteration containing the request that you want to action.
  2. Click the Card Wall tab.
  3. Drag a request to another lifecycle column. The Action Request dialog box is displayed.
  4. When you action a request you may need to provide additional information on the Attributes tab, some of which might be required.
  5. On the Owners tab, optionally select the user who will become the request owner after it is actioned.
  6. Click Action. The request’s state is changed and it moves to the next lifecycle column on the card wall.

Delegate a request

Delegate a request when you want to assign it to other users. When you delegate a request you can change the role assignments for it, for example, Developer. You can also select a Dimensions CM capability, for example:

NOTE For more information about role assignments and capabilities see the Dimensions CM Process Configuration Guide.
  1. Open the request catalog and select the request.
  2. On the General tab, in the Owners section click Add.
  3. From the Role to assign list, select the role to be delegated to the users.
  4. From the Capability of users list, select a capability for the users.
  5. From the Users to assign section select one or more users.
  6. Click Delegate.

Edit requests

You can edit a request's details if it is in your Inbox or you are a Dimensions CM administrator. After you edit a request its new values are displayed in all CM clients.

NOTE Dimensions CM privileges, attribute update rules, and other process restrictions may apply.
  1. Open the backlog or iteration containing the request that you want to edit.
  2. Select the request and click Edit.
  3. On the General tab do the following:
    • Edit the title, summary, and acceptance criteria
    • Edit the story points
    • Add and remove attachments
    • Add and remove relationships to other requests
    • Relate the request to a different stream or project
    • Add and remove relationships to design parts
  4. Select the Attributes tab and edit the values. The attributes vary between request types but are the same as in the other CM clients. Each request type has different attributes. Attributes that are required for the next state are indicated.
  5. TIP
    • You can hide read-only attributes.
    • Only attributes that you have the privilege to edit are displayed.
  6. Click Save.

Add owners to requests

You can add owners to a request if the request is in your Inbox or you are a Dimensions CM administrator.

NOTE For information about user roles and capabilities see the Dimensions CM Process Configuration Guide.
  1. Open the request from the request catalog, a backlog, or an iteration.
  2. On the General tab, in the Owners, section click Add.
  3. From the Role to assign list select a role, for example, Developer.
  4. From the Capability of users list select a capability, for example, Secondary.
  5. In the Users to assign box search for, and select, one or more users.
  6. Click Add and then Save.

You can also remove owners from requests if their role was not inherited.

  1. Open the request from the request catalog, a backlog, or an iteration.
  2. On the General tab, in the Owners, select one or more owners.
  3. Click Remove and then Save.

Troubleshooting

Administration issues

See also the PulseUno troubleshooting chapter in the Dimensions CM Administration Guide.

Database not accessible

If PulseUno fails to start because it cannot connect to its database, a detailed exception message is displayed instead of the login page. A common reason is a missing or inaccessible database at application start up time. The logs in the PulseUno data directory on the server contain more information. For information about configuring the JDBC URL, see the PulseUno chapters in the Dimensions CM Administration Guide.

Reviews not created automatically

Reviews are not created automatically when deliveries are made to CM:

User avatar images not displayed

Try the following:

Chains do not start

If chains do not start when deliveries are made to CM check:

Chain results not displayed

If chains run successfully but results are not displayed, check that the parameters in Jenkins are configured correctly. Builds will run in Jenkins even if parameters are not configured correctly, but the results will not be sent to PulseUno. You can also view chain logs.

For more information about configuring Jenkins, see the Dimensions CM Build Help.

Other issues

See also the PulseUno troubleshooting chapter in the Dimensions CM Administration Guide.

Reviewers not as expected

If the reviewers assigned to a new review are not as expected:

NOTE
  • A PulseUno administrator can configure the Reviewer role for each repository.
  • PulseUno assigns reviewers differently to the way that roles are assigned to CM requests:
    • PulseUno takes a union of the users holding the role on the items' owning design parts.
    • CM requests take the role assignments from a common ancestor design part in the design part hierarchy.

Item content not displayed in reviews

If item content is not displayed correctly in reviews, in the Dimensions CM administration console check that:

Requests are actioned but PulseUno reviews do not change state

If CM requests are actioned but the corresponding PulseUno reviews do not change state, try the following:

  1. On the top navigation click Administration.
  2. Select Repositories.
  3. Select the review's repository and click Defaults.
  4. In the Reviewer role name in CM field see what CM role that has been specified. Users that hold this role can be selected as reviewers in PulseUno.
    • If the CM request does not have a user that holds this CM role, no changes are made in PulseUno.
    • If the CM request does have a user hold this CM role, the role assignment should have been copied to the review. However, the review rule script for the stream also determines if the review changes its state.
    All reviews at the Draft and Rework states that are associated with the actioned request will have their reviewers updated. Reviews not at Draft or Rework are not affected by the request.

Check the ALF event configurations and PulseUno server logs, see the Dimensions CM Administration Guide for details.

PulseUno reviews change state but requests are not actioned

If PulseUno reviews change state but the corresponding CM requests are not actioned, try the following:

  1. On the top navigation click Administration.
  2. Select Repositories.
  3. Select the review's repository and click Defaults.
  4. In the Approved state name in CM and Rework state name in CM boxes check the state names are correct.
  5. Click Cancel.
  6. On the sidebar click Connection Details.
  7. In the Credentials section check that the specified user can log into Dimensions CM and that the user account has privileges in Dimensions CM to action requests to the necessary states.
NOTE
  • If a request in Dimensions CM requires mandatory attributes, enter them manually. PulseUno cannot automatically populate the attributes unless the credentials on the repository are for an account that has privileges in Dimensions CM to bypass this requirement.
  • Delegate any role assignments on requests in Dimensions CM that are required before the request can be actioned to the next state. PulseUno does not change the role assignments on requests in Dimensions CM, even for the Reviewer role of the repository.
  • Only reviews that change their state from In Review to Rework, or from In Review to Approved or Completed, cause their corresponding CM requests to be actioned. If a review is associated with multiple requests, all the requests are actioned. If a request is associated with multiple reviews, the request is actioned more than once.
  • Check the PulseUno server logs at the DEBUG level, see the Dimensions CM Administration Guide for details.

Unexpected formatting in review comments

IIS 403 error

If you have configured IIS using AJP and are getting an IIS 403 error page instead of the Pulse login page when you open http://<server-name>/pulse/, do the following:

  1. Open IIS Manager.
  2. In the Connections pane, expand Default Web Site, and select the /jakarta folder.
  3. In the Management section of the Features view, double click Configuration Editor.
  4. In the From list select Default Web Site/jakarta Web.config.
  5. In the Section list select system.webServer/httpErrors from the tree.
  6. Change the value of the property existingResponse from Auto to PassThrough.
  7. In the Actions panel click Apply.

PMD expert

If the compilation unit (*.java file):

SonarQube expert

If you have problems with SonarQube Runner see the web site.

If you receive the state Stopped check that:

Check the PulseUno log file.

Deployment Automation experts

Check the following:

Dependency Vulnerabilities expert

Check the following:

StarTeam

StarTeam supports older versions of AutoPass License Server. If you are having licensing problems, try updating to version 10.9.2 or later.

Support

Contact Micro Focus support


© 2014-2020 Micro Focus or one of its affiliates. All Rights Reserved.