PulseUno for Git User Help

Micro Focus PulseUno for Git version 20.1

Last updated: December 9, 2020

Introduction

About PulseUno

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

• Continually build and inspect the health and quality of code using plugins such as dependency checkers and static analysis. Teams can use this information to help decide when changes are ready to be merged, deployed, and released.
• Use PulseUno vaults to secure collections of packages such as binaries, artifacts, and meta data. Vaults provide a central library for your packages and integrate with build and development pipelines.
• Visualize team activity.
• Explore the codebase.
• Use pull requests to review, evaluate, and merge a set of defined changes. Pull requests are a collaborative process that allows teams to review proposed code changes, add review comments, approve changes, and merge changes into a mainline.
• Collaborate on development projects using requests, backlogs, and iterations, to plan, track, and execute work.

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 application
• Git server
• Vault server

PulseUno for Dimensions CM

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

• PulseUno application
• Vault server

New plugins

The following plugins have been added:

• Dimensions CM command-line (dmcli)
• Git Fetch
• Micro Focus UFT One
• Micro Focus LoadRunner
• CycloneDX
• NPM and Maven dependency finders

Chains

• Chains are now at the product level, in previous versions they were at the stream level. When you upgrade, existing chains are moved to the product level.
• If a step fails you can disable it. The next time the chain runs, the step is skipped. This option is useful when you are developing and testing chains.
• The console output has additional views such as: word wrap, elapsed time, and plug in name.
• The control options for each step are located in a separate section.
• You can set fail and unstable criteria for each step. For example, the severity level is equal to, or more severe than, than a specific level.
• Variables can be private and/or read-only, for example, a password can be private. Variables that are not read-only can be overridden when you run a chain manually.
• A single chain can run multiple chains. For example, a chain can run nightly builds on AIX, Windows, Solaris, and Linux. Each build is a separate child chain.
• A chain can pass variables to other chains. For example, a parent chain can pass a common build number or release version to its child chains.
  

Other enhancements

• PulseUno uses Jira issues if Dimensions CM is configured to use Jira as an external request provider.
• Suites have been renamed to spaces.
• Links to My Work, Spaces, and Administration are on the top navigation.
• The activity feeds for spaces, products and streams have moved to separate subpages, which have links on the sidebar.

Navigate

Top Navigation

The top navigation contains:

• Links to My Work, Spaces, and Administration.
• A search field.
• A link to the online help.

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

Search

You can search in:

• Activity feeds
• History tabs when you are browsing the contents of streams or branches.
• Backlog and iteration lists
• Request catalogs

Examples:

• A review label: Q234
• A request label: QLARIUS_CR_44
• A backlog title: "Performance backlog"

Search for requests and reviews

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:



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



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.

Activity feed keywords

Code history keywords

Request keywords

Review keywords

Keyboard shortcuts

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

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).

• A space is a collection of related CM products or Git repositories, for example, Insurance. A space can contain one or more products or Git repositories, for example, Life Insurance and Health Insurance.
  In PulseUno for Dimensions CM, you can register products so that they respond to events produced from those products.
  In PulseUno for Git, you create and maintain Git repositories.
• A product is a major unit of software development. It is a collection of streams or branches. For example, the product Life Insurance can contain these streams:
  • LIFE
  • DISCOUNTS
  • PROMOTION
  A product may sometimes refer to a Git repository, and the terms product and Git repository may be used interchangeably. 
  
• A stream is the same as a Dimensions CM stream or project and represents a single line of development.
• A branch is the same as a Git branch and represents a single line of development.
  In PulseUno, the terms stream and branch may be used interchangeably.

Activity feed

The activity feed displays the following recent events:

• Deliveries of changesets to the streams or branches that create reviews
• Reviewers added to a review
• Changes to reviews' states
• Review comments
• The results of chains and experts than ran on changesets

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>.

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:
   • Configure the stream to automatically create reviews and run chains.
   • Add experts to chains.

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.

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 PulseUno for Git

About 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.

This section provides instructions on how to administer PulseUno for Git:

• Install PulseUno for Git on Windows and Linux. See Install PulseUno for Git.
• Create Git repositories. See Create, modify, and delete Git repositories.
• Create templates from Git repositories. See Create a Git repository template.
• Fine-tune branch settings. See Manage branches.
• Set branch protections. See Define branch policies.
• Set methods for merging pull requests. See Use merge strategies for pull requests.
• Control individual and team access to Git repositories. See Manage members and teams.
• Connect request providers such as Atlassian Jira and Micro Focus ALM Octane. See Integrate with external request providers.
• Change passwords and set up SSH authentication. See Manage authentication.

For information on the basics of Git workflow, see the Git documentation.

Install PulseUno for Git

This section provides the prerequisites, considerations, and instructions for installing PulseUno for Git on Windows and Linux.

You can install PulseUno for Git in several ways:

Before you install

Before installing PulseUno for Git, review the following requirements and considerations:

System requirements

This topic describes the necessary hardware and software requirements for PulseUno for Git.

Installation components

PulseUno for Git includes the following modules:

• The PulseUno server. The main server with the PulseUno web application. This is where PulseUno stores its configuration information. The database is accessed through this server.
• The Vault server. The server for the library of software components (packages). For details about vaults, see Use vaults to store software components.
• The Git server. The server for Git repositories. For details about Git repositories, see Create, modify, and delete Git repositories.

You can install all the modules on the same system, or use different machines and install each module separately. For example, you might consider having Vault on a separate machine to ensure enough disk space for your packages.

Run the installation wizard on Windows

Before installing PulseUno for Git, ensure that you have fulfilled all the prerequisites. For details, see Before you install.

The PulseUno installation wizard for Windows guides you through the installation process step-by-step.

To install PulseUno for Git on Windows:

1. Download the installation zip file and extract the installer.
2. As a local system user, launch the installer.
3. Read and accept the license agreement.
4. Enter the installation path or accept the default location:
   C:\Program Files\Micro Focus\PulseUno
5. Select the modules to install:
• PulseUno server
• Vault server
• Git server

By default, all modules are selected.

6. Enter an encryption passphrase to connect the modules.
   NOTE If you are installing each module separately, you must use the same passphrase for all the modules. You can later connect other Git and Vault instances to PulseUno using this passphrase. The passphrase is case-sensitive.
7. (Optional) If you are installing only the PulseUno server, enter the hostname and port for the Git and Vault servers. This way, you can connect to these instances later. If installing only the Git server or the Vault server, specify the hostname and port for the PulseUno server.
   
   NOTE You can add the Git and Vault connection details after you install the PulseUno server. To do this, edit the startup.properties file in the pulse_data\conf directory and then restart Common Tomcat.
   Use this example to edit the gitserver.url and vaultserver.url properties:
   

   gitserver.url=http\://localhost\:8080/git-server
   vaultserver.url=http\://localhost\:8080/vault-server

8. Enter the root directory for the data directories or accept the default location:
   C:\ProgramData\Micro Focus\PulseUno
9. Select the database from the following options:
   • Create new database. Select this option to install an embedded PostgreSQL 12 database.
   • Use existing PostgreSQL installation.
   • Use existing Oracle installation.
   • Use existing MSSQL installation.
10. Provide the database details:
    Embedded PostgreSQL:
    

    Setting	Description
    PostgreSQL DB admin user	The PostgreSQL admin’s username.
    DB admin password	The PostgreSQL admin’s password.
    Port	The port for the PostgreSQL instance. Default: 5432

    
    Existing PostgreSQL, Oracle, or MS SQL:
    

    Setting	Description
    Host	The hostname for the database server. Default: localhost
    Port (PostgreSQL only)	The port number for the PostgreSQL server. Default: 5432
    Database	The database name.
    User	The username to connect to the database.
    Password	The password to connect to the database.

11. Enter the port for Common Tomcat.
    Default: 8080
12. Enter the hostname and port for the mail server you want to use for sending notifications.
    Default host: localhost
    Default port: 25
13. Click Install.
14. When the installation is finished, click Done.

Next steps

Post-installation steps

Install from a command line on Windows

Before installing PulseUno for Git, ensure that you have fulfilled all the prerequisites. For details, see Before you install.

To install PulseUno for Git from a command line, run the installation in console mode.

The default installation path is C:\Program Files\Micro Focus\PulseUno

This command runs the PulseUno installer:

setup-windows.exe -i  console

To install PulseUno for Git from a command line on Windows:

1. Download the installation zip file and extract the installer.
2. From a command line, as a local system user, change to the directory with the installation file.
3. Run the installer in console mode:
   

   setup-windows.exe -i console

   A new shell for the console installation opens.
4. In console mode, read and accept the license agreement.
5. Enter the installation path or press Enter to accept the default location:
   C:\Program Files\Micro Focus\PulseUno
6. Select the modules for installation:
• PulseUno server
• Vault server
• Git server

To install all modules (default), press Enter.
To install specific modules, enter their corresponding numbers separated by a comma and press Enter. For example, to install PulseUno and Git, enter: 1,3

7. Enter an encryption passphrase to connect the modules.
   NOTE If you are installing each module separately, you must use the same passphrase for all the modules. You can later connect other Git and Vault instances to PulseUno using this passphrase. The passphrase is case-sensitive.
8. (Optional) If you are installing only the PulseUno server, enter the hostname and port for the Git and Vault servers. This way, you can connect to these instances later. If installing only the Git server or the Vault server, specify the hostname and port for the PulseUno server.
   
   NOTE You can add the Git and Vault connection details after you install the PulseUno server. To do this, edit the startup.properties file in the pulse_data\conf directory and then restart Common Tomcat.
   Use this example to edit the gitserver.url and vaultserver.url properties:
   

   gitserver.url=http\://localhost\:8080/git-server
   vaultserver.url=http\://localhost\:8080/vault-server  

9. Enter the root directory for the data directories or press Enter to accept the default location:
   C:\ProgramData\Micro Focus\PulseUno
10. Select your database:
    • To create an embedded PostgreSQL database, enter 1.
    • To use an existing PostgreSQL database, enter 2.
    • To use an existing Oracle database, enter 3.
    • To use an existing SQL server, enter 4.
11. Enter the database details:
    Embedded PostgreSQL:
    

    Setting	Description
    PostgreSQL DB admin user	The PostgreSQL admin’s username.
    DB admin password	The PostgreSQL admin’s password.
    Port	The port for the PostgreSQL instance. Default: 5432

    
    Existing PostgreSQL, Oracle, or MS SQL:
    

    Setting	Description
    Host	The hostname for the database server. Default: localhost
    Port (PostgreSQL only)	The port number for the PostgreSQL server. Default: 5432
    Database	The database name.
    User	The username to connect to the database.
    Password	The password to connect to the database.

12. Enter the port for Common Tomcat.
    Default port: 8080
13. Enter the hostname and port for the mail server you want to use for sending notifications.
    Default hostname: localhost
    Default port: 25
14. Press Enter to install.
15. When the installation is finished, press Enter to exit the installer.

Next steps

Post-installation steps

Run the installation wizard on Linux

Before installing PulseUno for Git, ensure that you have fulfilled all the prerequisites. For details, see Before you install.

The PulseUno installation wizard for Linux guides you through the installation process step-by-step.

To install PulseUno for Git on Linux:

1. Download the installation tar file.
2. As a root user, navigate to the location of the tar file and extract the installer.
   To extract the installer using a command line, run this command:
   

   tar xvf <PulseUno-installer>.tar

3. Launch the installation wizard. To launch from a command line, run this command:
   

   ./setup-linux.bin

4. Read and accept the license agreement.
5. Enter the installation path or accept the default location:
   /opt/microfocus/PulseUno
6. Select the modules to install:
• PulseUno server
• Vault server
• Git server

By default, all modules are selected.

7. Enter an encryption passphrase to connect the modules.
   NOTE If you are installing each module separately, you must use the same passphrase for all the modules. You can later connect other Git and Vault instances to PulseUno using this passphrase. The passphrase is case-sensitive.
8. (Optional) If you are installing only the PulseUno server, enter the hostname and port for the Git and Vault servers. This way, you can connect to these instances later. If installing only the Git server or the Vault server, specify the hostname and port for the PulseUno server.
   
   NOTE You can add the Git and Vault connection details after you install the PulseUno server. To do this, edit the startup.properties file in the pulse_data/conf directory and then restart Common Tomcat.
   Use this example to edit the gitserver.url and vaultserver.url properties:
   

   gitserver.url=http\://localhost\:8080/git-server
   vaultserver.url=http\://localhost\:8080/vault-server  

9. Enter the root directory for the data directories or accept the default location:
   /opt/microfocus/PulseUno/data
10. Select the database from the following options:
    • Oracle
    • PostgreSQL
11. Provide the database details:
    

    Setting	Description
    Host	The hostname for the database server. Default: localhost
    Port (PostgreSQL only)	The port for the PostgreSQL server. Default: 5432
    Database	The database name.
    User	The username to connect to the database.
    Password	The password to connect to the database.

    
    
12. Specify the Common Tomcat network settings:
    

    Setting	Description
    Owning user name	The username for the existing user whom you authorize to run Tomcat and have write access to the Tomcat directories. Note: For security, do not use the root user to own and run Tomcat.
    Port number	The port for Common Tomcat. Default: 8080

13. Enter the hostname and port for the mail server you want to use for sending notifications.
    Default hostname: localhost
    Default port: 25
14. Click Install.
15. When the installation is finished, click Done.

Next steps

Post-installation steps

Install from a command line on Linux

Before installing PulseUno for Git, ensure that you have fulfilled all the prerequisites. For details, see Before you install.

To install PulseUno for Git from a command line, run the installation in console mode.

The default installation path is /opt/microfocus/PulseUno

This command runs the PulseUno installer:

setup-linux.bin -i console

To install PulseUno for Git from a command line on Linux:

1. Download the installation tar file from the link provided by Micro Focus.
2. As a root user, change to the location of the tar file and extract the installer using this command:

tar xvf <PulseUno-installer>.tar

3. Run the installer in console mode:
   

   setup-linux.bin -i console

4. Read and accept the license agreement.
   Press any key other than Enter to move through the license agreement. Then press Enter to accept the terms.
5. Enter the installation path or press Enter to accept the default location:
   /opt/microfocus/PulseUno
6. Select the modules for installation:
• PulseUno server
• Vault server
• Git server

To install all modules (default), press Enter.
To install specific modules, enter their corresponding numbers separated by a comma and press Enter. For example, to install PulseUno and Git, enter: 1,3

7. Enter an encryption passphrase to connect the modules.
   
   NOTE If you are installing each module separately, you must use the same passphrase for all the modules. You can later connect other Git and Vault instances to PulseUno using this passphrase. The passphrase is case-sensitive.
8. (Optional) If you are installing only the PulseUno server, enter the hostname and port for the Git and Vault servers. This way, you can connect to these instances later. If installing only the Git server or the Vault server, specify the hostname and port for the PulseUno server.
   
   NOTE You can add the Git and Vault connection details after you install the PulseUno server. To do this, edit the startup.properties file in the pulse_data/conf directory and then restart Common Tomcat.
   Use this example to edit the gitserver.url and vaultserver.url properties:
   

   gitserver.url=http\://localhost\:8080/git-server
   vaultserver.url=http\://localhost\:8080/vault-server  

9. Enter the root directory for the data directories or press Enter to accept the default location:
   /opt/microfocus/PulseUno/data
10. Select the database you have set up for PulseUno:
    • For Oracle, enter 1.
    • For PostgreSQL, enter 2.
11. Enter the database details:
    

    Setting	Description
    Host	The hostname for the database server. Default: localhost
    Port (PostgreSQL only)	The port for the PostgreSQL server. Default: 5432
    Database	The database name.
    User	The username to connect to the database.
    Password	The password to connect to the database.

    
    
12. Enter the Common Tomcat network settings:
    

    Setting	Description
    Tomcat user name	The username for the existing user whom you authorize to run Tomcat and have write access to the Tomcat directories. Note: For security, do not use the root user to own and run Tomcat.
    Tomcat port	The port for Common Tomcat. Default: 8080

13. Enter the hostname and port for the mail server you want to use for sending notifications.
    Default hostname: localhost
    Default port: 25
14. Press Enter to install.
15. When the installation is finished, press Enter to exit the installer.

Next steps

Post-installation steps

Install PulseUno for Git in silent mode

Before installing PulseUno for Git, ensure that you have fulfilled all the prerequisites. For details, see Before you install.

Silent mode enables you to run an installation in the background without the need to follow wizard steps and select options. Silent mode uses a response file containing all the configuration properties for your installation.

Before you can run an installation in silent mode, you need to create a response.properties file in a text editor.

Set the installation properties using the following syntax: PROPERTY_NAME=value

The following table provides a list of available response properties:

For examples of how to set the properties in a response.properties file, see Response file examples.

To install PulseUno in silent mode:

1. Download and unpack the installation file.
2. Prepare a response.properties file using the properties described earlier.
3. From a command line, change to the directory containing the installer.
4. Run the command for the silent mode installation:
   • On Windows, as a local system user:
     

     <installer-location>\setup-windows.exe -f <response-file-location>\response.properties -i silent

   • On Linux, as a root user:

     <installer-location>/setup-linux.bin -f <response-file-location>/response.properties -i silent

     where:
     <installer-location> is a full path to the PulseUno installation file.
     <response-file-location> is a full path to the response.properties file.

Next steps

Post-installation steps

Response file examples

This topic provides several examples of how to create a response.properties file for installing PulseUno in silent mode.

Example 1 (Windows). Installing the PulseUno server with an embedded PostgreSQL database. The Git and Vault servers are not installed.

USER_INSTALL_DIR=C:\\Program Files\\Micro Focus\\PulseUno 
FEATURE_PULSEUNO=1 
FEATURE_VAULTSERVER=0 
FEATURE_GITSERVER=0 
PULSE_PASSPHRASE=my-secret 
GITSERVER_URL=http://remotehost:8080/git-server 
VAULTSERVER_URL=http://remotehost:8080/vault-server
PULSE_DATA_DIR=C:\\ProgramData\\Micro Focus\\PulseUno 
DB_EMBEDDED_POSTGRES=1 
DB_POSTGRES=0 
DB_ORACLE=0 
DB_MSSQL=0 
PG_E_ADMINUSER=postgres-username
PG_E_ADMINPASS=postgres-password
PG_E_PORT=5432 
TC_PORT=8080 
MAIL_SERVER_HOST=localhost
MAIL_SERVER_PORT=25

Example 2 (Windows). Installing only the Vault server.

USER_INSTALL_DIR=C:\\Program Files\\Micro Focus\\PulseUno 
FEATURE_PULSEUNO=0 
FEATURE_VAULTSERVER=1 
FEATURE_GITSERVER=0 
PULSE_PASSPHRASE=my-secret
PULSE_HOSTNAME=remotehost
PULSE_PORT=8080
PULSE_DATA_DIR=C:\\ProgramData\\Micro Focus\\PulseUno 
DB_EMBEDDED_POSTGRES=0 
DB_POSTGRES=0
DB_ORACLE=0 
DB_MSSQL=0 
TC_PORT=8080

Example 3 (Linux). A full installation using an existing Oracle database.

USER_INSTALL_DIR=/opt/microfocus/PulseUno 
FEATURE_PULSEUNO=1 
FEATURE_VAULTSERVER=1
FEATURE_GITSERVER=1 
PULSE_PASSPHRASE=my-secret
PULSE_DATA_DIR=/opt/microfocus/PulseUno/data
DB_ORACLE=1 
DB_POSTGRES=0
DB_NAME=oracle-database
DB_HOST=localhost
DB_USER=oracle-username
DB_USER_PWD=oracle-password
TC_PORT=8080
TC_USER=tomcat-username
MAIL_SERVER_HOST=localhost
MAIL_SERVER_PORT=25

Example 4 (Linux). Installing only the Git server.

USER_INSTALL_DIR=/opt/microfocus/PulseUno 
FEATURE_PULSEUNO=0 
FEATURE_VAULTSERVER=0 
FEATURE_GITSERVER=1 
PULSE_PASSPHRASE=my-secret
PULSE_HOSTNAME=remotehost
PULSE_PORT=8080
PULSE_DATA_DIR=/opt/microfocus/PulseUno/data
DB_ORACLE=0
DB_POSTGRES=0
TC_PORT=8080
TC_USER=tomcat-username

Post-installation steps

After the installation, verify the following:

Next steps

Log in to PulseUno for Git

Log in to PulseUno for Git

To open the PulseUno web interface, launch the application from your desktop or navigate to the following URL in a browser:

http://<PulseUno-hostname>:<PulseUno-port>/pulse

Out of the box, PulseUno is configured to use internal authentication. To access the PulseUno web interface for the first time, you need the root user credentials:

After you have logged in, we recommend that you create an administrator account and set its password. The password for the root user is randomly generated every time Common Tomcat is started. To avoid looking up the password in the logs, create a new user, for example, gitsys. For details, see Add users.

See also

Create, modify, and delete Git repositories

Uninstall PulseUno for Git

When you uninstall PulseUno for Git, only the product’s features are removed.

The uninstaller doesn't remove:

• Files and folders created after the installation
• Micro Focus Common Tools
• Database objects

To uninstall PulseUno on Windows:

1. As a local system user, stop Common Tomcat.
2. Depending on your Windows version, navigate to the Apps & features or Programs and Features control panel.
3. Select PulseUno in the list of apps/programs.
4. Click Uninstall.

To uninstall PulseUno on Linux:

1. Log in as a root user.
2. From a command line, run this command:

   sh <PulseUno-installation-path>/Change\ PulseUno\ Installation

After uninistalling PulseUno, you can manually delete PulseUno objects from your database. For assistance, contact Support.

See also

Run the installation wizard on Windows

Run the installation wizard on Linux

Create, modify, and delete Git repositories

This topic explains how to create, edit, and delete Git repositories in PulseUno for Git.

As an administrator or space owner, you can organize Git repositories into groups of related repositories by putting them in a space.

Create a Git repository

As an administrator or space owner, you can create and initialize local Git repositories in PulseUno for Git.

To create a Git repository:

1. In PulseUno for Git, navigate to Spaces and select the space where you want to add a repository.
2. Click Create Git Repository.
3. On the New Git Repository page, provide the following details:

   Field	Description
   Repository name	Enter a name for your repository. The name becomes a part of the path to your repository.
   Repository URL	(Already provided) The full path to your repository.
   Description	(Optional) Enter additional information about the repository.
   Initialize repository	Select how you want to initialize the repository: As an empty repository. Create an empty repository with no branches. With a Readme file. Create a repository with a default branch. With content from a built-in template. Create a repository with the same content and structure as the selected template. For details about templates, see Create a Git repository template.
   Default branch	If you’re initializing a repository with a Readme file or with content from a template, specify the default branch, for example, main or development.
   Visibility level	Set the visibility level to define who has access to the repository: Private (default). Only authenticated users who have member permissions to the repository can acess it. Internal. Authenticated users without member permissions have guest access and can clone or pull the repository. Unauthenticated users have no access. Public. Authenticated users without member permissions as well as unauthenticated users have guest access and can clone or pull the repository.
   Builds	Keep this option selected to run builds using chains.
   Requests provided by	(Optional) If you set up a connection to a request provider such as Atlassian Jira or Micro Focus ALM Octane, you can select it to integrate with the repository. For details about integrations, see Integrate with external request providers.
   Reviews	Keep this option selected to automatically create reviews when delivering changes.
   Pull Requests	Keep this option selected to automatically create pull requests.
   Check Lists	Select this option to use a check list for reviews and pull requests. Then select the check list you want to use.

4. Click Save.

Edit a Git repository

As an administrator, you can modify the name and description of a repository.

To edit a Git repository:

1. In PulseUno for Git, navigate to Spaces and select the space containing the repository.
2. Open the repository.
3. In the sidebar, select Settings. Your repository's general settings open.
4. Change the repository's name and description. Use the tools to format and preview the description.
5. To modify access to the repository, change the visibility level:

   Visibility level	Description
   Private	Only authenticated users who have member permissions to the repository can acess it.
   Internal	Authenticated users without member permissions have guest access and can clone or pull the repository. Unauthenticated users have no access.
   Public	Authenticated users without member permissions as well as unauthenticated users have guest access and can clone or pull the repository.

6. Click Save.

Delete a Git repository

As an administrator, you can delete Git repositories.

PulseUno enables you to remove a repository instantly or schedule to delete it in 7 days. During those 7 days, you can cancel the deletion anytime.

To delete a Git repository:

1. In PulseUno for Git, navigate to Spaces and select the space containing the repository you want to delete.
2. Open the repository.
3. In the sidebar, select Settings > Advanced.
4. On the Advanced page, click Delete This Product and then confirm your action.
   The repository is now scheduled to be deleted in 7 days.
5. To delete the repository instantly, click Complete Deletion Now.
6. In the warning dialog box, enter the name of the relevant space and repository.
7. Click Complete Deletion Now.
   The repository is permanently removed.

To stop the repository deletion:

1. In PulseUno for Git, navigate to Spaces and select the space containing the repository.
2. Open the repository scheduled to be deleted.
3. In the sidebar, select Settings > Advanced.
4. On the Advanced page, click Stop Deletion and then confirm your action.

Create a Git repository template

This topic explains how to generate a Git repository template that you can later use as a blueprint for new repositories. A template is an exact copy of a repository's structure and content.

To create a Git repository template:

1. Compress the repository's directory with all of its contents into a zip file. By default, you can find the repository's files in your Git server's git_data directory, for example:
   C:\ProgramData\Micro Focus\PulseUno\git_data\repositories\<autogenerated-repository-name>
2. Copy the zip file to the gitserver-templates directory on your PulseUno server, for example:
   C:\ProgramData\Micro Focus\PulseUno\pulse_data\conf\gitserver-templates
3. To make the template available in the web interface, restart Common Tomcat.

For details about creating Git repositories, see Create a Git repository.

Manage branches

This topic explains how to change the default branch of your Git repository and define settings for new branches.

PulseUno for Git adds and removes branches automatically. The option of manually creating branches, similar to registering products in Dimensions CM, is not needed in Git.

Change the default branch

When creating a Git repository, you define a default branch, which is your main development branch where all pull requests land by default. As an administrator, you can change a repository's default branch.

To change a default branch:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Settings > Branches.
3. On the Branches page, select a default branch from the list of branches.
4. Click Save.

Define new branch defaults

When creating new branches, you can copy the settings from either the parent branch or the repository.

To set the defaults for new branches:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Settings > Branches.
3. On the Branches page, select one of the options:
• Copy settings from parent branch. Create new branches using the settings of a parent branch.
• Inherit settings from product. Create new branches using the repository settings.
4. Click Save.

Define branch policies

Branch policies protect branches in your repository from unwanted actions, such as force pushing commits or deleting branches. With branch policies, you set the conditions for creating branches and submitting commits.

Branch policies enable you to control the following:

• Force pushing to a branch
• Creating a branch with the same name
• Deleting a branch
• Requesting a ticket (request identifier) for a commit or branch

Create a branch policy

You can define a branch policy for a specific branch or a set of branches in your Git repository.

To create a branch policy:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Settings > Branch Policies.
3. Click the Add button (+).
4. On the New Branch Policy page, specify the following details:

   Field	Description
   Branch name pattern	Enter a branch name or a name pattern. Use the wildcard * to match a set of branches in a repository.
   Commits	Select this option to require valid request identifiers in commit messages and branch names. Select Apply to Owners as well to enforce this option on all users, including owners.
   History	Define the following options: Enforce a linear history by preventing merge commits from being pushed. Select Apply to Owners as well to enforce this option on all users, including owners. Permit force pushes for all users with push access. Select Apply to Owners as well to enforce this option on all users, including owners.
   Branches	Define the following options: Prevent all users from creating matching branches. Prevent all users from deleting matching branches.

5. Click Create.

You can create as many branch policies as you need. In the Branch Policies list, rearrange policies in the order you want them to be applied to branches. The top policy takes precedence over those under it.

Use merge strategies for pull requests

Out of the box, PulseUno for Git provides several methods for merging commits. As an administrator, you can apply these merge strategies to all pull requests in a repository.

The following table describes available merge strategies:

git merge --no-ff

git merge --squash

git merge --ff

Set the default merge strategy for automatic merges

As an administrator, you can set the default merge strategy for all automatic merges in a repository.

To set the default merge strategy:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Settings > Reviewing Changes.
3. On the Reviewing Changes page, in the Pull Requests section, select the merge strategy you want to use.
4. Click Save.

PulseUno applies the default merge strategy to all pull requests that are merged automatically.

Enable merge strategies

As an administrator, you can enable merge strategies to let users choose a merge strategy when they merge pull requests.

To enable merge strategies for pull requests:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Settings > Reviewing Changes.
3. On the Reviewing Changes page, in the Pull Requests section, select the merge strategies you want to enable.
4. Click Save.

You can now choose one of the enabled merge strategies when you merge a pull request.

See also

Create merge rules

Apply merge rules

Manage members and teams

This section explains how to manage access to Git repositories in PulseUno by assigning user roles, creating teams, and adding teams and members to repositories.

About roles and permissions

PulseUno for Git provides several roles that you can use to control individual and team access to Git repositories. Permissions for each role are predefined and cannot be customized.

To assign or change roles, you need to be an administrator.

The following table describes PulseUno roles and permissions.

Create and edit teams

Teams enable you to grant repository access to groups of users rather than each user individually. All team members share the same permissions.

You create teams and assign them a default role at the space level. You add teams to Git repositories at the repository level.

You can change or remove a team's access as needed. To manage teams, you need to be an administrator or space owner.

To create a team and assign users to it:

1. In PulseUno for Git, navigate to Spaces and select a space.
2. In the sidebar, select Teams.
3. On the Teams page, click the Add Team icon (+).
4. Enter a name and an optional description for the new team.
5. Select the default role for the team.
   A team's default role applies to all repositories in a space. For example, if a team is assigned the Owner role as default, the team's members become space owners.
6. Click Create. The new team's page opens.
7. Click the Add (+) icon to add users to the team.
   
8. In the Add User to Team dialog box, search for the user you want to add. Enter a keyword in the search field and press Enter.
9. Select a user from the list of search results and then select a role to assign. For details about available user roles, see About roles and permissions.
10. Click Add.

To edit a team:

1. In PulseUno for Git, navigate to Spaces and select a space.
2. In the sidebar, select Teams.
3. On the Teams page, click the team's name. The team's page opens.
4. (Optional) To change the team's name, default role, or description, click Edit. Make changes and click Save.
5. (Optional) To remove a member from the team, select a user from the list of team members. Then click the Delete icon and confirm your action.

Add a member to a repository

You can share access to a private repository with individual users.

To add a member to a repository:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Members.
3. On the Members page, under the Individuals tab, click the Add Individual icon (+).
   
4. In the Add Individuals dialog box, search for a user. Enter a keyword in the search field and press Enter.
5. Select a user from the list of search results and then select a role to assign. For details about available user roles, see About roles and permissions.
6. Click Add.

NOTE You cannot share access to a repository with disabled users. For details on how to add, lock, or disable users, see Manage users.

Add a team to a repository

You can share access to a private repository with the team you created earlier.

To add a team to a repository:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Members.
3. On the Members page, select the Teams tab.
4. Click the Add Team icon (+).
   
5. In the Add Teams dialog box, search for a team. Enter a keyword in the search field and press Enter.
6. Select a team from the list of search results and then select a role to assign. For details about available user roles, see About roles and permissions.
7. Click Add.

Change individual and team access to a repository

You can control the level of access to your repository for members and teams.

To change individual or team permissions:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Members.
3. To change a member's permissions, select the Individuals tab.
   To change a team's permissions, select the Teams tab.
4. Select one or more members or teams and click Change Role.
5. Select a new role.
   For details about user roles, see About roles and permissions.

Remove members and teams from a repository

You can revoke a member's or team's access to a private repository.

To remove a member or team from a repository:

1. In PulseUno for Git, navigate to Spaces, select a space, and then select a Git repository.
2. In the sidebar, select Members.
3. To remove an individual member, select the Individuals tab.
   To remove a team, select the Teams tab.
   
4. Select one or more members or teams and click the Delete icon. Then confirm your action.

See also

Manage users

Integrate with external request providers

PulseUno for Git supports integrations with external request systems such as Atlassian Jira and Micro Focus ALM Octane. This feature enables you to pull tickets from Jira and ALM Octane and use them with commits to create reviews and pull requests.

Before you can integrate an external request provider with a particular Git repository, you need to connect the provider to PulseUno for Git.

Connect to Atlassian Jira

To integrate your repository with Atlassian Jira, first connect your Jira instance to PulseUno.

To set up a connection to Jira:

1. In PulseUno for Git, navigate to Administration > Connections.
2. Click the Add button (+) and select Jira from the list.
3. On the New Jira Connection page, add the following details:

   Field	Description
   Title	Enter the name for the Jira connection.
   Web URL	Enter the base path to the Jira instance, for example, https://jira.example.com.
   Jira API URL	For Jira Server, provide the base path to the Jira instance API, for example, https://jira-api.example.com, or enter the web URL again. For Jira Cloud, leave this field empty or enter the web URL again.
   Username/Email	For Jira Server, enter a username for connecting to your Jira instance. For Jira Cloud, enter an email for connecting to your Jira instance.
   Password/API token	For Jira Server, provide your Jira instance password. For Jira Cloud, provide an API token created from your Atlassian account. For details about creating API tokens for Atlassian cloud products, see the Atlassian documentation.

4. Click Save.

Connect to Micro Focus ALM Octane

To integrate your repository with Micro Focus ALM Octane, first connect your ALM Octane space to PulseUno.

To set up a connection to ALM Octane:

1. In PulseUno for Git, navigate to Administration > Connections.
2. Click the Add button (+) and select Octane from the list.
3. On the New Octane Connection page, add the following details:

   Field	Description
   Title	Enter the name for the ALM Octane connection.
   Web URL	Enter the base path to the ALM Octane space, for example, https://octane.example.com.
   API Token	Enter the Client ID key generated in ALM Octane. For details about creating API access keys in ALM Octane, see the ALM Octane documentation.
   Secret	Enter the Client Secret key generated in ALM Octane. For details about creating API access keys in ALM Octane, see the ALM Octane documentation.
   Shared space	Enter the ID of the ALM Octane space to which you want to connect, for example, 1001.

4. Click Save.

After you set up a connection, PulseUno tests it and displays the status:

• Connected. The connection is successful.
• Problems connecting. The system couldn't connect to a request provider. In this case, make sure the connection details are correct.

Integrate a request provider with your repository

After connecting a request provider, you can integrate it with your repository.

To integrate with an external request provider:

1. In PulseUno for Git, open Spaces and select the repository for which you want to request integration.
2. In the sidebar, navigate to Settings > Request Integration.
3. On the Request Integration page, add the following details:
   For Atlassian Jira:
   

   Field	Description
   Connection	Select the connection to the Jira instance you have set up earlier.
   Project keys	Enter the Jira project keys to link specific projects in Jira, for example, AA or AB. To link all projects, leave the field empty.
   Issue key pattern	Enter the Jira issue key pattern to associate with specific issues. The default pattern is "((?<!([A-Za-z]{1,10})-?)[A-Za-z]+-\\d+)".

   
   For Micro Focus ALM Octane:
   

   Field	Description
   Connection	Select the connection to ALM Octane you have set up earlier.
   Workspace	Enter the ALM Octane workspace to integrate with.
   Commit patterns	Specify message patterns to associate commits with ALM Octane defects, user stories, and quality stories. The default message patterns are: Defects: defect\s*#(\d+) Represents the string defect<any number of spaces>#<defect id>. Quality stories: quality story\s*#(\d+) Represents the string quality story<any number of spaces>#<quality story id>. User stories: user story\s*#(\d+) Represents the string user story<any number of spaces>#<user story id>.

4. Click Save.

Manage authentication

By default, PulseUno for Git uses standard password authentication and provides an option to set user passwords. If PulseUno for Git is configured for external authentication, such as LDAP, you must set passwords in the external system.

You can also configure secure SSH authentication that enables you to access the Git server from a Git command line.

Change a user's password to PulseUno for Git

As an administrator, you can set and change passwords of PulseUno users, including your own password. This option is available only if PulseUno for Git uses standard password authentication.

To change a PulseUno password:

1. In PulseUno for Git, navigate to Administration > Users.
2. Select a user from the list. Use search to help you find users.
   
3. Click Change Password.
4. In the change password dialog box, enter a new password and confirm it.
5. Click Change Password.

Configure SSH key-based access

As an administrator, you can set up secure passwordless access to your Git server.

To configure SSH, you need a pair of SSH keys:

• A public key, which you add to PulseUno to verify the SSH connection.
• A private key, which you store in a secure place on your local system.

If you don't have SSH keys, generate a new pair. For details, see the SSH documentation.

To set up SSH authentication:

1. In PulseUno for Git, navigate to My Work > Preferences > SSH Keys.
2. On the SSH Keys page, click the New SSH Key icon (+).
3. Add the public key from the SSH key pair by providing the following details:

   Field	Description
   Title	Enter a name for the public key.
   Key	Enter the value of the public key, for example: ssh-ed25519 <key-body> <key-comment> or ssh-rsa <key-body> <key-comment>

4. Click Save.

After configuring SSH authentication, you can connect to a remote Git repository using the SSH protocol. Test the connection from the Git command line to ensure you set it up correctly.

Configure agents

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

• Each agent is associated with a specific instance of PulseUno.
• Each instance of PulseUno includes an embedded agent, so you do not need to install an agent on the same machine.
• To distribute the processing load of chains, install multiple agents on different machines on a network.
• Agents only include the code required to run chains and automatically download the required plugins from the PulseUno primary. You do not need to manually install plugins on agents.
• Agents can be configured to run specific chains by adding capabilities and variables.

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.

• When an agent is added to PulseUno, by default it is unapproved and cannot be used to run chains. If an agent can be trusted, you can approve it.
• Unapproving or deleting an agent releases the license that it holds.
• Taking an approved agent offline or online does not effect licensing.
• PulseUno includes three free agent licenses.

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:

• Agent name (same as the host machine, which you cannot change in PulseUno), for example: suse4130-buildagent
• Title (an optional description of the agent), for example: Windows compilers
• Status: Embedded, Offline, Unapproved
• Universal unique identifier (UUID)
• Operating system of the host machine
• Connection status, for example: Started 2 weeks ago
• Heartbeat (when the agent last communicated with PulseUno)
• Agent version
• Capabilities tags
• Memory usage of the host machine
• Workspace remaining on the host machine. A workspace is an area on disk that an agent can populate with code to run a chain.

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.

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.

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:

• The location of a specific compiler on an agent’s host machine.
• The configuration settings used by an expert.

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

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:

• A specific operating system
• High memory
• A specific network location

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:

• Add the capabilities WindowsServer2016 and 64gbMemory to the appropriate agent.
• Add WindowsServer2016 and 64gbMemory as required capabilities on the chain.

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:

• The user who delivered the changes.
• The changeset ID and delivery message.
• The health of the changes.
• The review associated with the changes.

Files also display:

• Findings from experts when a chain has run on the stream or branch.
• Peer review comments.
• Colored code syntax.

Folders also display:

• A summary of problems with any associated reviews.
• The number of contributors who made changes.
• (Optional) A readme file that describes the folder's contents.

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.

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.

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:

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:

• Comment on, and review, the changes in your development projects.
• Collaborate with team members.
• Get insight into the health of changes in your changesets, streams, and branches, such as the results of chain runs.
• Promote team work and development best practices.
• Vote to approve reviews or ask for changes, which may cause reviews to be marked as approved or sent for rework.

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

• Change a review's owner.
• Send a review for rework back to its owner.
• Change a review's state.
• Abandon a review.

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:

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:

• Draft: the review is being modified by the user who is the owner.
• In Review: the review has been published. Reviewers can add comments and vote on the review.
• Approved: the review's changes have been accepted.
• Rework: the review has been sent back to its owner with suggestions for improvement.
• Completed: if there are no issues the Approved review is normally marked as Completed by the owner.
• Abandoned: a review can be changed to Abandoned at any time by an administrator. The review is closed and removed from circulation.

Review roles

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

• Owner: normally the user that delivered the changeset that created the review. The owner can be changed by an administrator to any valid user.
• Lead reviewer: can be assigned automatically from the changeset and modified manually. In Dimensions CM, the valid lead reviewers are derived from the real role assignments on the design parts in Dimensions CM that own the items being reviewed. In PulseUno for Git, any active user is a valid lead reviewer. A lead reviewer can add optional reviewers.
• Optional reviewer: normally assigned manually. In Dimensions CM, the valid optional reviewers are derived from the candidate role assignments on the design parts in Dimensions CM that own the items being reviewed. In PulseUno for Git, any active user is a valid optional reviewer. Optional reviewers cannot assign other reviewers.

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:

• A user with the appropriate role (Owner or Administrator) changes the review state manually.
• A decision made by a review rule that has run automatically.

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

• A new changeset is associated with a review, which may automatically assign reviewers to the review.
• A user manually changes the state of a review.
• A reviewer votes to approve, request changes, or abstain with no opinion on a review that is at the In Review state.
• The owner of a review is changed.
• The reviewers assigned to a review are changed manually.
• Dimensions CM: A request associated with a review is actioned to the In Review state in Dimensions CM. This may automatically assign reviewers.

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.

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:

• An icon that indicates the review's current state, for example, In Review or Approved
• The review's label (number and title)
• The date the review was created
• The stream associated with the review
• The user who created the review
• The users who are reviewing the review

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.

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:

• An icon that indicates the review's current state, for example, In Review or Approved.
• The review's ID and title.
• The associated stream or project.
• A summary of the review's health, for example, The chains indicated this change is good.
• Reviewer votes.
• The review owner and the lead and optional reviewers.
• Recent activity on the review.
• Related requests.
• The results of chains that ran on the changesets.
• The changesets associated with the review.
• The files and folders associated with the changesets.
• The contents of the files in the review.

Activity

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

• The delivery that created the review
• Chains that ran on the review

You can filter the information that is displayed:

• Discussions & Deliveries: only displays user generated events (such as Review sent for rework) and comments added by reviewers.
• Grouped: also displays the results of chains and experts that ran on the changesets associated with the review.
• All: displays both of the above.

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.

Add and remove reviewers

Each review can have reviewers with these roles:

• A review owner; normally the user who delivered the changeset that created the review.
• One or more lead and/or optional reviewers.

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.
TIP
• Control click to select multiple users.
• Use Search to find users.
4. 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.

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.
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.



4. To display how your comment will look, click Preview. To continue editing click Edit.
5. 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.

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.

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:

• Display comments made by reviewers
• Display the findings made by chain runs inline inside files. If you switch this off, mouse over the margin to display findings.
• Display the entire contents of each file
• Display the previous version of each file
• Unify the previous and current differences of each file

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

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:

• Secure: a complex check list with high levels of tightly controlled compliance, for example, for licensing.
• Minimum: a small list with low levels of compliance, for example, for in-house testing.

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.

• To watch a review click Watch.
• To stop watching a review click Unwatch.

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
• Configure which changesets automatically create reviews and run chains

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:

• Create and run chains of experts to check the health and quality of source code and builds.
• Review code changes to determine if they are ready to be merged or released.
• Use pull requests to evaluate and merge a set of defined changes.

Chains

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

• Perform builds
• Capture built artefacts
• Create and build Docker containers
• Deploy assets
• Fetch code from a repository
• Examine source code and artefacts for security vulnerabilities, report findings, and provide an opinion
• Perform static analysis
• Perform other activities such as fetch sources and send email notifications

Experts

The following experts are included with PulseUno:

Build

• Ant: runs an Ant build.
• CM Build: if your team uses Dimensions Build and you have existing build configurations, you can run the configurations in PulseUno.
• Dimensions CM command-line: enter dmcli commands.
• Gradle: runs a Gradle build.
• Jenkins: a continuous integration server that you can use with PulseUno to execute, and report on, builds of changesets as they are delivered.
• Makefile: runs a build using a makefile.
• Maven: builds and distributes artefacts.
• MSBuild: runs an MSBuild.
• Script: runs a batch script (Windows) or shell script (Linux).
• Visual Studio Build: runs a Microsoft Visual Studio Build.

Capture

• Capture to DA CodeStation: captures built artefacts to Deployment Automation CodeStation. These artefacts represent deployable items such as files, images, databases, configuration materials, or any other assets associated with a software project.
• Capture to Dimensions CM: captures built artefacts to a Dimensions CM stream.
• Capture to Directory: captures built artefacts to a directory.
• Capture to SCP/SFTP: captures built artefacts to a workspace using secure copy (SCP) or to remote network server using Secure File Transfer Protocol (SFTP).

Container

• Build a Docker Image: builds a Docker image in which you can run applications.
• Run a Docker Container: creates a Docker container in which you can run Docker images.
• Run Script in Docker Container: use a command to execute a script in a Docker container that is running, without logging into that container.

Dependency

• CycloneDx Dependency Detector: a lightweight software bill of materials (SBOM) specification designed for use in application security contexts and supply chain component analysis.
• Maven Dependency Detection: analyzes the dependencies of a project and determines which are: used and declared; used and undeclared; unused and declared.
• Npm Dependency Detection: checks which modules you have used in your code and lists them as dependencies in your package.json.

Deployment

• DA Deployment: imports and deploys a component using Deployment Automation.
• DA Generic Process: runs a generic process in Deployment Automation.

Fetch

• Fetch from Dimensions CM: fetches sources from a Dimensions CM repository.
• Fetch from Git: fetches sources from a Git repository.
• Fetch from StarTeam: fetches sources from a StarTeam repository.

Security

• Dependency Vulnerabilities: finds third party dependencies in your code that may have known security vulnerabilities.
• Fortify SCA (Static Code Analyzer): analyzes your source code and identifies the root causes of security vulnerabilities.
• WhiteSource: identifies all the open source components and dependencies in your build, reports any known security vulnerabilities, and lists their licenses.

Analysis

• Checkstyle: enforces coding standards.
• Copyright header checker: checks files for the presence of copyright statements or other snippets.
• Kiuwan: measures, analyzes, and verifies the quality of your code.
• PMD: analyzes source code and finds common programming bugs.
• SonarQube: inspects the quality of your code.

Test

• CTest Parser: parses CTest results files.
• JUnit Parser: parses JUnit results files.
• MSTest Parser: parses MSTest results files.
• NUnitParser: parses NUnit results files.
• TestNG Parser: parses TestNG results files.

Other experts

• Changeset Summary: counts the number of files added, deleted, and modified in each changeset.
• Code Summarizer: reports about lines in files, code languages, etc..
• Email Notification: sends email notifications to users.
• Halt on Failure: stops a chain if the previous expert in the chain failed.
• Microsoft Teams Notification: adds a Microsoft Teams notification using WebHook.
• Run another chain: run another chain that you have created..

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

Expert attributes

Experts have these optional attributes:

• Execution state: Success, Failure, Unstable, or Aborted.
• Measurement: 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.
• Finding: When issues are identified, experts annotate the source code and provide a "severity" level to indicate how serious an issue is. Annotations are displayed in tabular form in the Experts section of a review page and some experts also annotate the files in the Contents section. Some findings may include a link to a web page that provides more details. See Inspect Expert Results.
NOTE The Dependency Vulnerabilities and WhiteSource experts only annotate the Experts section.

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:

• Step 1: Maven builds the stream.
• Step 2: Capture WAR file captures the targets to the stream.
• Step 3: DA Deployment deploys the application to an environment

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

• The first chain runs on every delivery and performs brief static analysis.
• A second chain runs at midnight every day, performs more thorough analysis, and deploys software.

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.

Add capabilities to chains

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

• A specific operating system
• High memory

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.

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:

• An administrator creates a chain that will use Maven and can run on two agents.
• Maven is installed on different locations on each agent.
• The administrator adds a variable to each agent, MAVEN_HOME, which defines the location of the Maven installation on that agent.
• The administrator adds the variable ${MAVEN_HOME} in the chain step.
• When the chain runs on an agent, the value of the variable is substituted with the value for the Maven location on that agent.

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:

• Select a policy for retaining the logs created by a chain.
• Stop a chain after the failure of any step. For example, you have a chain with multiple steps and the last step is a build. If any of the previous steps fails, the chain stops, and the build is not executed. You can use this option instead of adding the Halt on Failure expert.
• Only queue one copy of a chain at any time.

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.
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:

• The review where the chain ran
• The associated changeset

Results include:

• Finding for each expert, including Errors, Warnings, Failures, and Information.
• Measurements for each expert. 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.

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.

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.

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:

• On the sidebar select Chains, select the chain, and click Run on Latest Changeset.
• On the sidebar select Changeset History, select the latest changeset, and from the Actions menu select Run Chains.

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:

• Review the proposed code changes.
• Add review comments and contribute to a discussion.
• Protect your mainline stream from unwanted changes, bad merges, and broken builds.
• Approve changes and merge them into a mainline.

Key facts about pull requests:

• Are related to two streams: the source stream, where the pull request changes are made and reviewed, typically a topic stream; and the target stream, where the pull request changes will be merged to, typically a mainline stream.
• Can be related to a request, which is used to merge the changes in the pull request.
• Enable you to merge changes into a target stream without using a work area.
• Can run chains to help you decide if the changes in a stream are healthy.

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:

• A topic stream is created from a parent stream, which creates a pull request. You can create topic streams in the Dimensions CM clients.
• Changes are delivered to the topic stream and related to the pull request.
• The pull request is reviewed, approved, and merged into the topic stream’s parent stream.

Key facts:

• Reviewers use the pull request to review the changes in the topic stream.
• The pull request contains the changes in the related topic stream.
• The request related to the pull request is used to merge the changes in the topic stream into its parent stream.

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.

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:

• Edit the title and description.
• Change the author.
• Add and remove reviewers.
• Change the related request.
• Change the display defaults.

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:

• It moves to the In Review state.
• The reviewers are notified.

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:

• View the associated code changes.
• Add review comments and collaborate with team members.
• View the results of chains that have run on the pull request.
• Vote to approve changes to the pull request.

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.

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.

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:

• In Review: a comma separated list of CM request states that can add reviewers to pull requests.
• Rework: when a pull request is sent for rework, action the associated request to the specified CM state.
• Approved: when a pull request is approved and ready to be merged, action the associated request to the specified CM state.
• Completed: when a pull request is merged successfully, action the associated request to the specified CM 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.

Vault types

PulseUno has the following types of vaults:

• Local: a vault stored on a local file system or repository.
• Remote: a vault stored on a remote file system or repository. Use this type of vault to cache the contents of a remote repository such as Maven Central on your local network so that its contents can be retrieved quickly.
• Virtual: a collection of local and remote vaults. Virtual vaults enable you to organize your vaults into virtual collections. A typical example is a single virtual vault that combine two vaults:
  • A local vault containing your application binaries.
  • A remote vault containing third party tools, such as Maven.

Key features of PulseUno vaults

• Version control of packages in Dimensions CM or a local file system.
• Control access to packages based on an approval process, for example, deny access to packages that have known security issues.
• Integrates with package managers such as Maven and npm.
• Audit trail and reporting of packages.
• Custom scripts for automating approvals and rejection, for example, automatically approve packages that have an Apache 2.0 license and no security issues.

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:

• The details of each vault inluding its URL and packages.
• The details of each package such as its contents, licenses, and any vulnerabilities that were detected
• Activity such as who delivered, used, reviewed, and approved packages.

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:

• Create and configure local, remote, and virtual vaults.
• Edit vault settings.
• Delete vaults.

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.

• Only one vault in a virtual vault can be published.
• You can change the published vault at any time.

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:

• Owner: can administer vaults, for example, change vault settings, delete vaults, publish packages into vaults, and download packages from vaults.
• Approver: can approve and reject packages.
• Developer: can only download packages from vaults.
• Deployer: can download and deploy packages into vaults and send packages for approval.
• CIBuild: can download and deploy packages.

For information about creating teams see Create and edit teams.

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.
• Set the default checklist across all vaults.

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:

• Internal: binaries built from your software. When you publish these package types they typically do not need to be approved and can be consumed by developers.
• External: components downloaded from third part vendors, such as Maven. When this package type has been added to a vault, it can be reviewed, approved, and then consumed by developers. An external package cannot be used in build and deployment processes until it has been approved, see Review and approve vault packages.

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:

Example URL:

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

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, for example, inspect vulnerabilities.
• Approve and reject packages. Approved packages can be consumed by build and deployment processes.

Review package contents

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

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:

• defaultRule.js: approves all packages that have no critical or high security issues and have an Apache-2.0 license.
• rejectGPL: rejects all packages that contain a GPL license.
• rejectHighSeverity: rejects all packages that contain high severity vulnerabilities.

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:

• A built-in expert can only be upgraded or replaced when you update PulseUno. It is core to the product and is not expected to change without changes to PulseUno.
• A bundled expert is a standard expert that is shipped with PulseUno. You can overwrite it as long as the newer version is backwards compatible with your version of PulseUno.
• Additional and upgraded experts will be made available for download from the Community web site.
• You can write your own expert implementations if you have site-specific requirements or in-house utilities that you want to integrate with PulseUno.

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

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

• Overview: what the expert does and why you would use it.
• Prerequisites: external tools that the expert depends on.
• Configure: global server configuration files that must be set up, the fields that you enter when configuring an expert, and whether the expert needs to be in a chain that uses a workspace.

  A workspace is a directory that is allocated to a chain when it runs. The workspace is populated with the stream content (its files), so that the experts in the chain can analyze the stream content and report findings back to PulseUno. Workspaces are limited and a chain may be delayed until one is allocated. Workspace directories are located in the PulseUno data directory.

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.

Manage experts

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

• Build
• Capture Artifacts
• Container
• Dependency
• Deployment
• Other
• SCM
• Security and Compliance
• Static Analysis
• Test

As asn administrator, you can:

• Check what plugins are installed.
• Enable and disable plugins.
• View the results of recent expert runs.

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.

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

• The Deployment Automation server must be installed in a network location where the expert can connect to.
• A working component configured in your Deployment Automation server for the expert to invoke.

This expert supports DA version 6.1.5.

Configure

Configure expert settings

Capture to Dimensions CM

Overview

Captures built artefacts to a Dimensions CM stream.

Configure

Capture to Directory

Overview

Captures built artefacts to a directory.

Configure

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

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.

Configure expert settings

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

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:
   • Yes: enter a BLD command and specify a poll rate. For details of the BLD command see the Dimensions CM Command-Line Reference.
   • No: configure CM Build using the fields described below.

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:

• Publishing files from a stream to a Deployment Automation server as a new component version.
• Adding a Deployment Automation status to a new published version.
• Deploying the new published version.

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:

Configure expert settings

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

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:

Configure expert settings

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

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:

• The folder ${dataDir}/conf/experts/com.serena.starlight/dependencyvulnerabilities/data/
• The file cve.2.9.h2.db that is updated from the Common Vulnerabilities and Exposures (CVE) data . Each run automatically updates the CVE data if autoupdate in the properties file is set to true.

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.

Configure expert settings

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

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

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

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

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.

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

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.

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.

Configure

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

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:

• Uses the parameters after the question mark in the build request URLs that are sent to the Jenkins server.
• Supports freestyle and pipeline jobs.

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.

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:

• Track the quality and security of your changesets.
• Make that information visible in PulseUno reviews and reports.

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

Configure expert settings

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

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:

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:

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:

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:

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:

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:

Fetch from Dimensions CM

Overview

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

Configure

Notification

Overview

Sends notifications by email if a chain succeeds or fails.

Configure

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:

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.

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:

• An operating system command.
• The path to a script, for example, a Windows batch file or Linux shell script.

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:

• PULSE_STREAMTITLE: the name of the project or stream.
• PULSE_STREAMVERSIONID: the project or stream version.
• PULSE_SCMCONNECTIONURI: a unique identifier for the Dimensions CM database.
• PULSE_LOGINNAME: the user who made the delivery.
• PULSE_MESSAGE: the commit message for the delivery.
• PULSE_DIRECTORY: the location of the workspace containing the source code.
• CURRENT_DIR: same as PULSE_DIRECTORY (also set as the working directory of the script).

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 help.

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

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:

The properties Username and Password are optional and are only required in specific security situations. For details, see the SonarQube help.

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

• An active organization (and API token) for the WhiteSource SaaS service.
• Access to the WhiteSource administrative site.
• A product and project to report results to.
• The project token.

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

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:

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:

• Changeset Graph: visualizes your changesets and streams/branches of development.
• Changeset History: displays the history of changes in chronological order.

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:

• Limit the data that is displayed.
• Focus on a specific feature or set of streams, branches, and projects.
• Focus on a specific period of time.

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*
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.
5. 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.
6. Select other options as required, for example, show parent streams.
7. 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:

• Visualize all your streams, branches, and projects in one place including branches and merges. Each circle or group represents a changeset or a group of changesets.
• Review the health and readiness of your changesets and determine if they are ready to be merged or released.
• Watch in real time as streams and branches are branched, merged, and moved through the lifecycle.

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:

• The changeset number and description.
• The stream or project version that owns the changeset.
• The user whose delivery created the changeset.
• The date and time the changeset was created.
• The review created by the delivery. Mouse over to display its current state.
• The result of the chain that ran on the changeset.

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

Sort streams and branches on changeset graphs

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

• Stream or branches name
• Create date
• Last activity

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:

• The changeset number and description. Click to open the changeset page.
• The stream or project version that owns the changeset.
• The user whose delivery created the changeset.
• The date and time the changeset was created.
• The review created by the delivery. Click a review to view its details.
• The health of the changeset.

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:

• The changeset ID and title
• The associated stream or project
• Recent activity, such as experts that ran on the changeset
• Related requests
• The associated reviews
• The results of chains that ran on the changeset including findings and measurements
• A list of all the files in the changeset
• The contents of the files and comments.

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:

• Comments made by reviewers
• Findings on files made by experts
• Entire files (not only the lines that have changed)
• Previous versions of files
• Combine the previous and current differences of files

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.

Create reports

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

	Metric: a chart with a single value, for example, the number of deliveries made.
	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: 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: a diagram in which the numerical values of variables are represented by the height or length of lines, or rectangles of equal width.
	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.