PulseUno User Help

Micro Focus PulseUno version 21.1

Last updated: July 30, 2021

Introduction

About PulseUno

PulseUno is a web-based user interface that enables you to:

• Directly work with a Git server and use standard Git functionality, such as creating and cloning Git repositories, collaborating with individuals and teams, committing, reviewing, and merging changes.
• Continually build and inspect the health and quality of code using plugins such as dependency checkers and static analysis. This information helps you 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 21.1

The following new features and enhancements are introduced in PulseUno 21.1.

Git and CM functionality in one PulseUno UI

You can now work with both Git repositories and Dimensions CM products in one PulseUno instance.
For example, you can synchronize a Git branch with a stream in a Dimensions CM product. See Create a Git repository.

Vault enhancements

Use these enhancements when working with PulseUno vaults:

• Create Docker vaults
  In addition to package managers Maven and npm, PulseUno now integrates with Docker. A Docker vault enables you to store Docker images. For details on creating vaults, see Create, configure, and delete vaults.

• Approve multiple vault packages
  You can now approve or reject multiple packages at once. See Approve vault packages.

• Delete vault packages
  Keep your vaults clean by deleting packages and package versions you no longer need. See Delete packages.

• Download content from a vault
  You can download individual files or entire vault packages. See Download files and packages.

• Set content policies
  Content policies control what packages can be delivered to a vault. By using the exclude/include filters, you can restrict specific packages and versions from being uploaded. See Set vault content policies.

• Run an automatic vulnerability check
  To improve security, use an automatic vulnerability check for vault packages. PulseUno will regularly check for new security issues and report the findings in the Vulnerabilities tab of the related package version. For details on how to enable this option, see Edit vault settings.

• View vault statistics
  In the new Statistics panel, you can view vault information such as the total size of all package content, the number of packages and versions, and a breakdown of package versions by state. To view vault statistics, navigate to Spaces > Vaults and open a vault. See Vaults home page.

• Find code hints and examples of package usage
  PulseUno provides commands and code snippets for using the package in your build system. To view code hints, open your package version and click the Details tab. See Review package contents.

Activity feed enhancements

Use the following new activity feed options:

• Filter activity by changes that are pulled and pushed in a Git repository.
• Inspect the activity of other users. For details on how to view activity, see View activity.
• Export activity to an XML or JSON file. See Export the activity feed.

Chains enhancements

Use the following features when configuring and running chains:

• Run ongoing vulnerability detection
  For chains that have dependencies, you can enable an ongoing vulnerability scanning to regularly check for new vulnerabilities that may be discovered in the future. PulseUno will display the vulnerability information in reviews and on the chain run pages, and will pass it on to the vault. See Enable ongoing vulnerability detection.

• Add custom measurements to a chain
  Add your own measurements from a Script step in a chain. Your script can create a properties file which will be used to report measurements to PulseUno. You can then chart the measurements in dashboard reports or publish them as output variables. See Define measurements in chain steps.

• Publish output variables
  Use this feature to pass measurements generated by a chain step to later chain steps and child chains. See Publish output variables to chain steps.

• Stop downstream chains
  If a chain runs other chains, you can instruct the parent chain to stop its child jobs whenever it is stopped. See Configure chains to stop downstream chains.

Git enhancements

These new features are available in Git:

• Content import from other repositories
  You can create repositories with content imported from other repositories, for example, from GitHub or BitBucket. See Create a Git repository.

• Automated pull requests
  You can set pull requests to be created automatically in specified Git branches. For details, see Configure how pull requests are created.

• Large file support (LFS)
  When you check out a Git repository, the LFS feature enables Git to download only the latest file version rather than the entire history of versions, which saves time and space. See Create, modify, and delete Git repositories.

• Signed commits
  Use GPG keys to sign commits. See Add GPG keys to verify signed commits.
  For details on how to enforce signed commits, see Define branch policies.

Integrations

PulseUno has expanded its integration capabilities:

• Use Dimensions CM requests in a Git repository
  You can set up Dimensions CM as a request provider for your Git project. See Integrate with external request providers.

• Synchronize with ALM Octane
  You can synchronize PulseUno review and pull request states with the phases of ALM Octane backlog items. The synchronization is available for Dimensions CM products configured to use ALM Octane external requests. See Synchronize with ALM Octane.

• Send chain results to ALM Octane
  You can create a pipeline to send chain results from PulseUno to ALM Octane. See Set up a chain to publish chain results to ALM Octane.

PulseUno licensing

PulseUno now supports the AutoPass License Server (APLS) for managing user and agent licenses. See PulseUno licensing.

Known issues and limitations

The following issues are known to exist at the time of the latest PulseUno release.

Installation and upgrade

• Uninstalling or upgrading on Windows: Depending on your system's virtual memory, when you attempt to uninstall PulseUno 20.1 or upgrade PulseUno to version 21.1, the following errors may occur:
  Unable to load and to prepare the installer in GUI mode.
  or
  CopyAndModFiles Git data-dir processing error: file does not exist C:\PulseUno\git-server\logback-dimensions-remote-helper.xml
  Solution:
1. Edit the Change PulseUno Installation.lax file in the PulseUno installation directory.
   Default path: C:\Program Files\Micro Focus\PulseUno\Change PulseUno Installation.lax
   Set the memory allocation parameters to the following values or greater:
   

   lax.nl.java.option.java.heap.size.initial=536870912
   lax.nl.java.option.java.heap.size.max=1073741824

2. Try uninstalling or upgrading PulseUno again.

• When upgrading to 21.1, HTTPS is not applied for a remote Git or Vault server: If you selected an HTTPS option for a remote Git or Vault server connection, the installer may not apply the option.
  Solution: After the upgrade, verify that the Git and Vault URLs point to HTTPS. Open the startup.properties file in the pulse_data\conf directory and check the URLs:

  gitserver.url=https\://<hostname>\:<port>/vault-server 
  vaultserver.url=https\://<hostname>\:<port>/vault-server

  Change the URLs to HTTPS if they are incorrect, and then restart Common Tomcat.

• When upgrading to 21.1, the installer doesn't update the host name for a remote Git or Vault server: The installer may use your current Git or Vault server host name instead of the new host name supplied during the upgrade.
  Solution: After the upgrade, verify that the Git and Vault server URLs point to correct host names. Open the startup.properties file in the pulse_data\conf directory and check the URLs:
  

  gitserver.url=http\://<hostname>\:<port>/vault-server
  vaultserver.url=http\://<hostname>\:<port>/vault-serve

  Change the host names if they are incorrect, and then restart Common Tomcat.

PulseUno vaults

• Deploying Maven artifacts: When deploying a Maven artifact with an incorrect password, you may get the "Connection reset by peer" error instead of the "Failed to log in with user name <username>" error.
  When you deploy a Maven artifact with an -X switch, a detailed error message is displayed:
  [DEBUG] Failed to dispatch transfer event 'PUT PROGRESSED <URL> <> <local-path> to org.apache.maven.cli.transfer.ConsoleMavenTransferListener
  java.lang.IllegalArgumentException: progressed file size cannot be greater than size: 696320 > 568158
  This is an issue with Maven, and it may be fixed in a future Maven release.

• Docker vaults:
• When you view vault statistics, the displayed size of files in a vault may not be completely accurate. When a Docker image layer is shared among Docker images, its size is counted for each image using the layer, but only one copy of the layer is stored in the vault.
• Docker vaults don't support anonymous access. Even if a Docker vault is configured for anonymous access, unauthenticated users cannot pull from the vault, receiving this message:
  User 'anonymousUser' does not have permissions to read from vault.

• Serena SSO: The PulseUno Vault server is not supported when using Serena SSO.

Git functionality

• Serena SSO/CAC: The PulseUno Git server doesn't support Serena SSO/CAC authentication. To work with the Git server, choose an authentication scheme other than Serena SSO.

• Signed commits and server-side merge: Defining a branch policy that enforces signed commits in a particular branch may prevent server-side merges of pull requests to that branch. This behavior is expected, as the server-side merge doesn't have access to your private GPG key to sign commits on your behalf.
  Workaround: Merge locally with a signature and push.

• Enabling automatic pull request creation after the upgrade: If you had automatic pull request creation enabled for a repository, and you upgraded from PulseUno 20.1, you may need to reset the branch name patterns for pull request creation before making other changes to the repository settings. For details, see Configure how pull requests are created.

• Automatic pull request merge may fail: In a Git repository that uses Dimensions CM requests and has a branch policy requiring commit messages to a particular branch to include request IDs, the following issue exists:
  When pull requests are merged into such a branch, the default commit message for server-side merge commits doesn't place the request ID in square brackets, as expected. For example, [QLARIUS_CR_44]. When merging manually, you can edit the generated commit message. But if you have automatic merge enabled in the merge rules, the merge may fail.
  Workaround: Use a database tool to connect to the pulse schema. In the overriddendefaults table, add a row with the following values in the keyname and keyvalue columns:
  

  keyname	pull.request.merge.commit.pattern
  keyvalue	Merged %LABEL% from %AUTHOR% (%SOURCE%) %REQUESTEXTLABEL% [%REQUESTLABEL%]

  For example, if you use SQL syntax:
  

  INSERT INTO overriddendefaults (keyname,  keyvalue) VALUES ('pull.request.merge.commit.pattern', 'Merged %LABEL% from  %AUTHOR% (%SOURCE%) %REQUESTEXTLABEL% [%REQUESTLABEL%]');

  With this configuration change, the generated commit message for server-side merges will satisfy the branch policy.

Navigate

The following image displays some of the common user interface elements in PulseUno.

Top navigation

The top navigation contains:

• Links to My Work, Spaces, and Administration.
  

  My Work	Displays information for the user who is currently logged in to PulseUno, such as their review inbox, reviews they own, and packages waiting for approval.
  Spaces	Displays a list of spaces. A space is a collection of related software products. See Create, modify, and delete spaces.
  Administration	An area for performing administrative tasks. Visible only to administrators. See Administer.

• A search field. To starch searching, click the search icon. For details, see Search.
• A link to user preferences. To access preferences, click the user icon and select Preferences. For details about modifying preferences, see Configure user preferences.
• An information link. To access the online help, community page, and product news and events, click the question mark icon.

Sidebar

Use the sidebar to access items that are relevant to your current location in PulseUno.

Breadcrumbs

Use breadcrumbs to view your current location in PulseUno.

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.

Install and upgrade

Install a standalone PulseUno instance

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

You can also install PulseUno as part of Dimensions CM. For details, see Install PulseUno as part of Dimensions CM.

Use one of the following methods to install PulseUno as a standalone product:

Before you install

Before installing PulseUno, review the following requirements and considerations:

Support Matrix

The PulseUno Support Matrix provides information on the hardware and software requirements, supported operating systems, technologies, and tools.

Installation components

PulseUno 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, 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 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. If you are installing PulseUno without the Git or Vault modules:
   • To configure the Git and Vault connection, enter the hostname and port for the Git and Vault servers. Select the HTTPS option to enable an HTTPS connection.
   • To skip configuring the Git and Vault connection, select Do not configure PulseUno for a remote Git/Vault server.
     
     NOTE To configure the Git and Vault connection after the installation, edit the startup.properties file in the pulse_data\conf directory and modify the gitserver.url and vaultserver.url properties, for example:
     

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

     Then restart Common Tomcat.
   If you are installing only the Git and/or Vault modules, specify the hostname and port for the PulseUno server. To enable an HTTPS connection, select the HTTPS option.
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 a new database. This is the default option that installs 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 to use for sending notifications.
    Default host: localhost
    Default port: 25
13. Review the installation details. Go back if you need to change the settings.
14. Click Install.
15. When the installation is finished, click Done.

Next steps

Post-installation steps

Install from a command line on Windows

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

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

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

To install PulseUno 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 this command to launch the installer in console mode:
   

   <PulseUno-installer>.exe -i console

   For example:
   

   pulseuno-21.1.0-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 server, 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. If you are installing PulseUno without the Git or Vault modules:
   • To configure the Git and Vault connection, enter the hostname and port for the remote Git and Vault servers. To enable an HTTPS connection, enter Y.
   • To skip configuring the Git and Vault connection, press Enter for each connection option.
     
     NOTE To configure the Git and Vault connection after the installation, edit the startup.properties file in the pulse_data\conf directory and modify the gitserver.url and vaultserver.url properties, for example:
     

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

     Then restart Common Tomcat.
   If you are installing only the Git and/or Vault modules, specify the hostname and port for the PulseUno server. To enable an HTTPS connection, enter Y.
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 or press Enter. This is the default option.
    • 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 admin user	Enter the PostgreSQL admin’s username. Or press Enter to accept the default username, postgres.
    DB admin password	Enter the PostgreSQL admin’s password.
    Port	Enter the port for the PostgreSQL instance. Or press Enter to accept the default port, 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.
    Or Press Enter to accept the default port, 8080.
13. Enter the hostname and port for the mail server to use for sending notifications. Or press Enter to accept the default settings:
    Default hostname: localhost
    Default port: 25
14. Review the installation details and 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, 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 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:
   

   ./<PulseUno-installer>.bin

   For example:
   

   ./pulseuno-21.1.0-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. If you are installing PulseUno without the Git or Vault modules:
   • To configure the Git and Vault connection, enter the hostname and port for the Git and Vault servers. To enable an HTTPS connection, select the HTTPS option.
   • To skip configuring the Git and Vault connection, select Do not configure PulseUno for a remote Git/Vault server.
     
     NOTE To configure the Git and Vault connection after the installation, edit the startup.properties file in the pulse_data/conf directory and modify the gitserver.url and vaultserver.url properties, for example:
     

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

     Then restart Common Tomcat.
   If you are installing only the Git and/or Vault modules, specify the hostname and port for the PulseUno server. To enable an HTTPS connection, select the HTTPS option.
   
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 to use for sending notifications.
    Default hostname: localhost
    Default port: 25
14. Review the installation details. Go back if you need to change the settings.
15. Click Install.
16. When the installation is finished, click Done.

Next steps

Post-installation steps

Install from a command line on Linux

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

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

The default installation path is /opt/microfocus/PulseUno

To install PulseUno 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:
   

   <PulseUno-installer>.bin -i console

   For example:
   

   pulseuno-21.1.0-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. If you are installing PulseUno without the Git or Vault modules:
   • To configure the Git and Vault connection, enter the hostname and port for the Git and Vault servers. To enable an HTTPS connection, enter Y.
   • To skip configuring the Git and Vault connection, press Enter for each connection option.
     
   
   
   NOTE To configure the Git and Vault connection after the installation, edit the startup.properties file in the pulse_data/conf directory and modify the gitserver.url and vaultserver.url properties, for example:
   

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

   Then restart Common Tomcat.
   If you are installing only the Git and/or Vault modules, specify the hostname and port for the PulseUno server. To enable an HTTPS connection, enter Y.
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 to use for sending notifications. Or press Enter to accept the default settings:
    Default hostname: localhost
    Default port: 25
14. Review the installation details and press Enter to install.
15. When the installation is finished, press Enter to exit the installer.

Next steps

Post-installation steps

Install PulseUno in silent mode

Before installing PulseUno, 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, and you don't need to follow wizard steps and select options. Silent mode uses a response file that contains all the configuration properties for your installation.

Before you can run an installation in silent mode, create a response.properties file in a text editor. Set the installation properties using this 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>\<PulseUno-installer>.exe -f <response-file-location>\response.properties -i silent

   • On Linux, as a root user:

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

     where:
     

     <PulseUno-installer>.exe <PulseUno-installer>.bin	Specifies the name of the PulseUno installation file, for example, pulseuno-21.1.0-setup-windows.exe or pulseuno-21.1.0-setup-linux.bin.
     <installer-location>	Specifies the full path to the PulseUno installation file.
     <response-file-location>	Specifies the 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:

Before using PulseUno, ensure that you have the necessary licenses to work with PulseUno. The evaluation option provided by PulseUno is limited to three users and three agents. For details about managing licenses, see PulseUno licensing.

Next steps

Log in to PulseUno

Log in to PulseUno

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

When you uninstall PulseUno, 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. Log in as a local system user.
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

Install PulseUno as part of Dimensions CM

For details on how to install PulseUno as part of Dimensions CM, see the Dimensions CM documentation.

Upgrade PulseUno

This section provides instructions on how to upgrade PulseUno to the latest version.

Upgrade a standalone PulseUno instance

You can upgrade PulseUno from version 20.1 by running the latest installer on top of your existing installation. The installer removes the earlier product version and installs the new version using your current PulseUno database, application server, and mail server settings.

Prerequisite: Before you upgrade PulseUno, back up your current installation. Make a copy of the root directory where the PulseUno data directories are stored:

To upgrade PulseUno, run the installation for your platform, as described in Install a standalone PulseUno instance.

For silent upgrade, follow the instructions in Install PulseUno in silent mode.

Upgrade PulseUno as part of Dimensions CM

If you installed PulseUno as part of Dimensions CM, follow the upgrade instructions in the Dimensions CM documentation.

PulseUno licensing

If your PulseUno instance is configured for internal or LDAP authentication, use the AutoPass License Server (APLS) to manage PulseUno licenses. Out of the box, PulseUno allows three free users and three free agents. To have more users or agents, purchase a full license and set up APLS.

This section explains what license options are available and how to configure and use APLS.

License options

The following license options are available for PulseUno.

Set up the AutoPass License Server

To manage licenses through AutoPass, install and configure the AutoPass License Server (APLS).

To install and configure APLS:

1. Download the AutoPass License Server from the Micro Focus ITOM Marketplace (requires login).
   
   
   NOTE PulseUno 21.1 and later uses AutoPass 12.0.0 or later. Normally, we recommend using the latest APLS version available.
2. Run the installer for your platform.
3. Open the APLS web interface and configure the server. For details, see the AutoPass License Server documentation.

Alternatively, you can set up APLS as a Docker image. For details, see the Docker documentation.

After the installation, the APLS service starts automatically. To start or stop the service manually, see the AutoPass License Server documentation.

Next steps

Configure PulseUno to use AutoPass

After installing the AutoPass License Server (APLS), configure the communication between PulseUno and AutoPass.

Configuration steps:

• Add AutoPass details to the PulseUno startup.properties file. See Modify the PulseUno properties with AutoPass details.
• Configure an HTTPS connection to establish the trusted relationship between APLS and PulseUno. Out of the box, APLS uses a custom SSL certificate for HTTPS. You may replace this certificate with another certificate signed by your own certificate authority (CA), or with a self-signed certificate. For details, see Add the SSL certificate to the Java keystore.

Modify the PulseUno properties with AutoPass details:

1. On a licensed PulseUno server, edit the startup.properties file in the pulse_data\conf directory to define the following properties:
   

   license.type=autopass
   license.autopass.server=<APLS-URL>

   where <APLS-URL> is the URL of your AutoPass License Server, for example:
   

   license.autopass.server=https://apls:5814  

2. Restart PulseUno.
   

Add the SSL certificate to the Java keystore:

1. Obtain the CA certificate or the self-signed certificate used by APLS, as a .pem, .der, or .cer file.
   
2. Back up the cacerts file in the Common JRE's keystore directory. The default keystore locations are:
   

   Windows	C:\Program Files\Micro Focus\common\jre\8.0\lib\security\cacerts
   Linux	/opt/microfocus/common/jre/8.0/lib/security/cacerts

3. Using the Common JRE’s keytool command-line tool, run this command:
   Windows:
   

   <JAVA_HOME>\bin\keytool -import -v -trustcacerts  -alias APLS -file <certificate-file> -keystore <JAVA_HOME>\lib\security\cacerts -keypass changeit -storepass changeit

   where:

   <JAVA_HOME>	Specifies the root location of the JRE directory. The default locations are: Windows: C:\Program Files\Micro Focus\common\jre\8.0 Linux: /opt/microfocus/common/jre/8.0
   <certificate-file>	Specifies the path to your SSL certificate file.

4. Restart Common Tomcat.

Next steps

Request a license

Request a license

You need the AutoPass Lock Code to obtain license keys.

To request a license:

1. Get the AutoPass Lock Code.
   1. Open the APLS web interface.
   2. Navigate to License > Install.
   3. Copy the alpha-numeric value in the Lock Code field, for example, 1A2B3C-456DEF.
2. Visit the Micro Focus Software Entitlement portal (requires login) and use the Lock Code to submit a license request.
3. Download your license key from the portal.

For more details, request assistance at Contact Licensing Delivery Center (requires login) or contact your Micro Focus sales representative.

Next steps

Install a license

Install a license

After configuring your AutoPass License Server (APLS) and obtaining license keys, install the licenses in APLS. You need APLS administrator privileges for this task.

To install a license:

1. Open the APLS web interface.
2. Navigate to License > Install.
3. Add your license keys. For details, see the AutoPass License Server documentation.

After installing licenses, assign them to specific users and agents:

• To assign licenses to users, see Assign named licenses.
• To assign licenses to agents, see Approve agents.

Assign named licenses

After you install named user licenses, assign them to specific user login names in the APLS web interface. You need APLS administrator privileges for this task. For details, see the AutoPass License Server documentation.

Approve agents

When an agent is associated with an instance of PulseUno, it is automatically displayed in Administration > Agents. To confirm that an agent is known and trusted, approve the agent.

If you have already approved three agents, each additional agent that you approve will consume a license.

Considerations:

• When an agent is added to PulseUno, it is unapproved by default, and you cannot use it to run chains. If it's a trusted agent, you can approve it.
• Unapproving or deleting an agent releases the license assigned to the agent.
• Taking an approved agent offline or online does not affect licensing.
• PulseUno provides up to three free agents. Further agents require agent licenses.

To approve an agent:

1. In PulseUno, navigate to Administration > Agents.
2. Select one or more agents.
3. From the Mark As list, select Approved.
4. To unapprove an agent and release its license, select Unapproved from the Mark As list.

View license information

You can view the usage of named licenses, expiry dates, capacity, and sharing details in the APLS web interface.

To view named license information:

1. Open the APLS web interface.
2. Navigate to Usage and Report > License Usage. The page displays an overview of license types.
3. To view usage details, click the license type.

You can check if an agent is licensed, or if there are licensing issues with agents, in the PulseUno web interface. To open the Agents page, navigate to Administration > Agents.

Organize work

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

• 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.
  You can register CM products so that they respond to events produced from those products.
  You can also create Git repositories and maintain them using standard Git functionality.
• A product is a major unit of software development and a collection of streams. For example, the product Life Insurance can contain these streams:
  • LIFE
  • DISCOUNTS
  • PROMOTION
  A product usually refers to a Dimensions CM product, but sometimes 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

You can view recent activity for a space, product, Git repository, stream, or branch. As an administrator or space owner, you can also view the activity of other PulseUno users, for example, when you need to investigate certain events.

PulseUno enables you to export activity data to an XML or JSON file.

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.
• Pushes to and pulls from a Git repository.

View activity

When viewing the activity feed, use filters to narrow down the list of events.

To view and filter activity:

1. Choose what activity you want to view:
• To view activity for a space, open Spaces and select a space.
• To view activity for a product, Git repository, stream, or branch, open Spaces and drill down to select the unit you need.
• To view your own activity, open My Work.
2. In the sidebar, select Activity. The Activity page with a list of events for the current location opens.
3. From the All Activities list, select an event type, for example, Comments.
   Alternatively, in the search field, enter a keyword in the format <keyword>:<value>. Keywords are not case-sensitive.
   For example, to view activity about pull request PR1234, enter Review:PR1234.
   To view activity for two or more event types, enter keywords in the format <keyword>:<value> or <keyword>:<value>, for example, Event:Reviews or Event:Votes.
   For more examples, see Activity feed keywords.
4. Administrators only: To view activity for a particular user, click the user's name in any event done by the user.

To view activity for reviews or changesets, open the Conversation tab of the relevant review or changeset.

Export the activity feed

As an administrator or space owner, you can download activity using the Export feature.

To export the activity feed:

1. Open the Activity page for the unit or the user you need, as described in View activity.
   
2. Click Export next to the search field. The Feed Export dialog box opens.
3. From the All Activities list, select an event type to export only the filtered results. To export the unit's entire activity feed, keep All activities selected.
   To select activity for two or more event types, enter keywords in the format <keyword>:<value> or <keyword>:<value>, for example, Event:Reviews or Event:Votes. Keywords are not case-sensitive.
4. Select the format in which you want to export the data. The supported formats are XML and JSON.
5. Select the period for which you want to export activity.
   To specify your own period, select Custom and then select the start and end dates.
   
6. Click Export. A file with activity data is downloaded to your machine.

Create, modify, and delete spaces

As an administrator, you can create, edit, or delete spaces.

In a space, you can register Dimensions CM products or create Git repositories. For details, see the following topics:

• Register a product to a space.
• Create a Git repository.

Create a space

Spaces are located at the top level of the PulseUno navigation.

To create a space:

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

Modify a space

As an administrator, you can modify the title and description of a space.

To edit a space:

1. In PulseUno, navigate to Spaces and open the space you want to modify.
2. Click Edit.
3. Change the title and/or description. Use the tools to format and preview the description.
4. Click Save.

Delete a space

As an administrator, you can remove a space with all its contents.

To delete a space:

1. In PulseUno, navigate to Spaces and open the space you want to delete.
2. In the sidebar, click Settings > Advanced.
3. On the Advanced page, click Delete This Space and then confirm your action.

Register, modify, and delete products

As an administrator, you can add, modify or delete products in PulseUno.

Register a product to a space

As an administrator, you can register Dimensions CM products in PulseUno.

To register a single product:

1. In PulseUno, navigate to Spaces and select a space.
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. (Optional) 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 Dimensions CM repository.
6. If you are creating a new repository, provide these details:
   

   Field	Description
   Title	Enter a title for the Dimensions CM repository.
   Server	Enter the network address of the Dimensions CM server, for example, dm-server.example.com.
   Base database name	Enter the CM base database name and connection string, for example, cm_typical@dim14.
   System Credentials	(Optional) Select the Always use the following credentials option that controls what set of credentials is used for connecting to the Dimensions CM repository. For details about this option, see Connect to Dimensions CM repositories.
   System username	Enter a username for connecting to the Dimensions CM repository.
   System password	Set a password for connecting to the Dimensions CM repository.
   CI username	(Optional) Enter a username of the Dimensions CM user to be used for chain operations. Note: For security purposes, we recommend that this user has permissions only to fetch the code and perform other tasks in Dimensions CM chains.
   CI password	(Optional) Set a password of the Dimensions CM user to be used for chain operations.

7. From the Product in Repository list, select a CM product.
8. Click Register.

Register multiple products to a space

As an administrator, you can register several Dimensions CM products at once.

To register multiple products:

1. In PulseUno, navigate to Spaces and select a space.
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 Dimensions CM repository.
4. If you are creating a new repository, provide these details:
   

   Field	Description
   Title	Enter a title for the Dimensions CM repository.
   Server	Enter the network address of the Dimensions CM server, for example, dm-server.example.com.
   Base database name	Enter the CM base database name and connection string, for example, cm_typical@dim14.
   System Credentials	(Optional) Select the Always use the following credentials option that controls what set of credentials is used for connecting to the Dimensions CM repository. For information about using this option, see Connect to Dimensions CM repositories.
   System username	Enter a username for connecting to the Dimensions CM repository.
   System password	Set a password for connecting to the Dimensions CM repository.
   CI username	(Optional) Enter a username of the Dimensions CM user to be used for chain operations. Note: We recommend that this user has permissions only to fetch the code and perform other tasks in Dimensions CM chains.
   CI password	(Optional) Set a password of the Dimensions CM user to be used for chain operations.

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.

Edit a product

As an administrator, you can modify a product's title and description.

To edit a product:

1. In PulseUno, navigate to Spaces, select a space, and then select a product.
2. In the sidebar, click Settings. Your product's general settings open.
3. Change the product's title and/or description. Use the tools to format and preview the description.
4. Click Save.

Delete a product

As an administrator, you can remove a product with all its streams.

To delete a product:

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

To stop the product deletion:

1. In PulseUno, navigate to Spaces, select a space, and then select the product to be deleted.
2. In the sidebar, select Settings > Advanced.
3. On the Advanced page, click Stop Deletion and then confirm your action.

Create, modify, and delete Git repositories

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

As an administrator or space owner, you can organize Git repositories into groups of related repositories by putting them in a space. For details on how to work with spaces, see Create, modify, and delete spaces.

Create a Git repository

As an administrator or space owner, you can create local Git repositories. When you initialize a Git repository, PulseUno enables you to populate it with the contents from a custom template, a Dimensions CM stream, or another Git repository.

To create a Git repository:

1. In PulseUno, 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 custom template you created earlier. For details about templates, see Create a Git repository template. Synchronize a branch from another repository. Create a repository with the default branch that will be synchronized with a Dimensions CM stream: Select a CM repository connection. To select a connection, first you need to create it. For details, see Connect to Dimensions CM repositories. Select a product in the CM repository to which you are connecting. Select a CM stream to synchronize with. To copy the entire history of the CM stream, clear the Clone tip of stream option. By default, no historical changesets are pulled into the new Git repository. Import from another Git repository. Create a repository with content imported from another Git repository, for example, from GitHub or BitBucket. Provide the URL, username, and password for the source repository.
   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 access 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, 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 access 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, 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, 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 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\<auto-generated-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.

Move a product or Git repository

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.

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.

To register a stream to a product:

1. In PulseUno, navigate to Spaces and select a space.
2. Select the product where you want to register a stream.
3. Click Register Stream.
4. 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:

   • Enter an asterisk (*) at the end of a string to match a range of names, for example, DEV:STREAM_A*
   • Enter an asterisk (*) to view all the streams in a Dimensions CM product.
5. Select a stream.
6. Click Save. The stream is registered with the product. Now you can:
   • Configure the stream. For details, see Automatically create reviews and run chains.
   • Add steps to chains. For details, see Add steps to chains.

Delete streams

As an administrator, you can unregister streams.

To unregister a stream:

1. In PulseUno, navigate to Spaces.
2. Select a space, a product, and then select one or more streams.
3. Click the Delete icon and confirm.

Set favorite streams

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

To add a stream to favorites:

1. In PulseUno, navigate to Spaces.
2. Select a space and then a product.
3. In the list of streams, click a stream to open it.
4. Next to the stream name, toggle the star to add or remove the stream from your favorites.

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 may want different products to show different check lists when users vote to approve reviews or request changes. You can override these settings for individual streams or branches.

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 Git repository's default branch.

To change the default branch:

1. In PulseUno, navigate to Spaces, select a space and then 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.

Set new stream and branch defaults

When creating new streams or branches, you can copy the settings from either the parent stream/branch or the product or Git repository.

To set the defaults for new streams or branches:

1. In PulseUno, navigate to Spaces, select a space, and then select a product or 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 streams/branches using the settings of a parent stream/branch.
• Inherit settings from product. Create new streams/branches using the product/Git 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 actions:

• 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.
• Requiring verified signatures for commits.

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, 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 an asterisk * as a wildcard to match a set of branches in a repository.
   Commits	Define the following options: Require that commit messages or branch names contain valid request identifiers. Select Apply to Owners as well to enforce this option on all users, including owners. For details on how to set up a connection to an external request provider, see Integrate with external request providers. Require that all commits have verified signatures. Select Apply to Owners as well to enforce this option on all users, including owners. For details on how to configure commit signing, see Add GPG keys to verify signed commits.
   History	Define the following options: Enforce 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.

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 artifacts 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 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 > Delivery Filters.
3. On the Delivery Filters page, select the filter you want to make default for this product or Git repository.
4. Click Set As Default and then click 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 Git repository.
2. Open a stream or branch.
3. In the sidebar, select Settings > Delivery Filters.
4. On the Delivery Filters page, select Override default delivery filter.
5. Select Filter deliveries using, and then select the filter you want to make default for the stream or branch.
6. Click Save.

Configure how reviews are created

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

To configure review settings for a product or 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 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.

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.

Set pull request options

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.

Configure agents

Agents are small applications that PulseUno uses to run chains. For details about chains, see Chains.

Considerations:

• 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 server. You do not need to manually install plugins on agents.
• You can configure agents to run specific chains by adding capabilities and variables. For details, see Add capabilities to agents and Add variables to agents.

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

For details about approving and licensing agents, see Approve agents.

Manage agents

View agent information

The Agent page lists all the agents registered for your PulseUno instance. 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.

To view agent details:

1. In PulseUno, navigate to Administration > Agents.
2. To narrow down the list of displayed agents, select an option from the filter list. For example, you can select all agents or only agents that are online.
3. To enable or disable memory and workspace monitoring, click Agent Monitoring.
4. To modify an agent's title, open the agent and then click Edit. In 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.

To view chain information:

1. In PulseUno, navigate to Administration > Agents.
2. On the Agents page, click the agent's name to open the agent.
3. To view the chain that is currently running, click the Running tab.
4. To view the history of previous chain runs, click the Chains tab. Each chain is on a separate row.

Take agents offline or online

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

To take agents offline:

1. In PulseUno, navigate to Administration > Agents.
2. On the Agents page, select one or more agents.
3. From the Mark As list, select Offline.

To take agents back online, select Online from the Mark As list.

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 connected to it. When you upgrade a subordinate, it downloads the agent code from the primary and installs it.

To upgrade or restart an agent:

1. In PulseUno, navigate to Administration > Agents.
2. On the Agents page, click the agent's name to open the agent.
3. Click Upgrade or Restart.

Delete agents

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

To delete an agent:

1. Stop the agent on the host machine.
2. In PulseUno, navigate to Administration > Agents.
3. Select the agent and click Delete.
4. Confirm that you want to delete the agent.

Add variables to agents

You can add variable definitions 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.

To add a variable to an agent:

1. In PulseUno, navigate to Administration > Agents.
2. On the Agents page, click the agent's name to open the agent.
3. Click Edit and select the Variables tab.
4. Click Add variable (+).
5. Enter a name and value pair, for example, MAVEN_HOME=/home/autobuild/maven3
6. (Optional) To make the variable private, select the Private check box. The values of private variables are displayed obscured in the user interface.
7. 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 run 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 Git 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 is 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.

As an administrator, 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. For 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. For Git, any active user is a valid lead reviewer. A lead reviewer can add optional reviewers.
• Optional reviewer: normally assigned manually. For 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. For Git, any active user is a valid optional reviewer. Optional reviewers cannot assign other reviewers.

Delivery filters control which changesets automatically create reviews. For 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. 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 the health of your code. You can:

• Create and run chains of experts to check the health and quality of source code and builds. See Chains.
• Review code changes to determine if they are ready to be merged or released. See About reviews.
• Use pull requests to evaluate and merge a set of defined changes. See Use pull requests to manage changes.
• Inspect vulnerabilities in chains and vault packages. See Vulnerability detection.

Chains

PulseUno includes expert plugins that you can run in a sequence of steps called a chain. For details on how to work with chains, see Create and configure chains.

Experts enable you to:

• Perform builds
• Capture build artifacts
• Create and build Docker containers
• Deploy assets
• Fetch code from a repository
• Examine source code and artifacts 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 artifacts.
• 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 build artifacts to Deployment Automation CodeStation. These artifacts represent deployable items such as files, images, databases, configuration materials, or any other assets associated with a software project.
• Capture to Dimensions CM: captures build artifacts to a Dimensions CM stream.
• Capture to Directory: captures build artifacts to a directory.
• Capture to SCP/SFTP: captures build artifacts 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 and compliance

• 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.
• Micro Focus LoadRunner: runs Micro Focus LoadRunner load test scenario.
• Micro Focus UFT One: runs Micro Focus UFT One file system based tests.
• 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 measurements and findings.
NOTE The Dependency Vulnerabilities and WhiteSource experts only annotate the Experts section.

Vulnerability detection

You can instruct PulseUno to regularly identify vulnerabilities in chains and vault packages.

When you run a chain or deliver a package to a vault, PulseUno automatically detects vulnerabilities that the chain or package have. For enhanced security, you can enable ongoing vulnerability detection for chains and packages. This way, PulseUno will identify and report any vulnerabilities that may be discovered in the future.

To keep up to date with newly found security issues, PulseUno regularly gathers vulnerability information from the following sources:

• National Institute of Standards and Technology (NIST)
• Sonatype OSS Index
• npm Security Advisories

To run ongoing vulnerability checks:

Create and configure chains

Overview

A chain consists of a sequence of steps, and each step can run one expert plugin. For details about plugins, see Experts.

In this example, the chain has three steps:

• Step 1: Maven builds the stream.
• Step 2: Capture to Dimensions CM 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. In PulseUno, navigate to Spaces and select a space.
2. Select the product or Git repository where you want to create a chain.
3. In the sidebar, select Chains.
4. Click New (+). The New chain page opens.
5. In the Steps tab, enter a title and, optionally, additional information about the chain.
6. Click Save.

Specify when to run a chain

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

To select when to run a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. Select the Triggers tab.
5. From the Run chain list, select when you want to run the chain:

   Option	Description
   Manually run	Trigger chain runs manually. This is the default option.
   On every changeset	Trigger the chain every time a changeset is delivered.
   When a pull request is published	Trigger the chain every time a pull request is published.
   Hourly	Specify the interval (in hours) for running the chain, for example, every 12 hours at 15 minutes past the hour. The Hourly schedule reflects your local time zone. To trigger the chain even if no changes were delivered between the runs, select Run as scheduled even if no new changesets have been created since the last run.
   Daily	Specify the interval (in days) and the time when the chain will run, for example every 3 days at 19:00. The Daily schedule is set in a 24-hour format using your local time zone. To trigger the chain even if no changes were delivered between the runs, select Run as scheduled even if no new changesets have been created since the last run.
   Weekly	Specify the week days and the time when the chain will run, for example, Tuesday and Saturday, at 19:00. The Weekly schedule is set in a 24-hour format using your local time zone. To trigger the chain even if no changes were delivered between the runs, select Run as scheduled even if no new changesets have been created since the last run.
   Cron	Enter a CRON expression to set the schedule for running the chain. For example, to run the chain every day at noon, enter 0 0 12 ? * MON-FRI. CRON expressions are interpreted in the UTC time zone. To trigger the chain even if no changes were delivered between the runs, select Run as scheduled even if no new changesets have been created since the last run.

   To disable the chain, select Chain is disabled.
6. 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-*
7. In the Path filtering field, enter Ant patterns (one per line) to run changesets only on paths that match the pattern. The chain is triggered if at least one path in the changeset matches the pattern.
   Leave empty to run the chain on all changesets.
8. Click Save.

Add steps to chains

You can add plugins or actions as chain steps.

To add a step to a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. Select the Steps tab, and click Add Step to Chain (+).
5. In the Add Step list, select an expert or action from one of the categories, or use search to find steps. Click Add next to the step. The step is added to your chain.
6. Click the chain step to configure it. Each expert or action has different parameters, some of which are mandatory. For details see Configure Experts.
7. Add more steps as required.
   To change the running order of steps, drag them to different positions.
   To remove a step from a chain, select the step and click the Delete Step from Chain icon.
8. Click Save.

Add capabilities to chains

Capabilities describe an agent's environment, for example:

• A specific operating system
• High memory

You can add one or more 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 64 GB of memory, add WindowsServer2016 and 64gbMemory as required capabilities on the chain. The chain only runs on the agents that match these capabilities.

To add capabilities to a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. Select the Options tab.
5. In the Required Capabilities field, enter a comma-separated list of capabilities. Leave empty to run the chain on any agent.
6. 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 enables a chain to reference that location via the variable instead of a fixed value in the step's configuration. When the chain runs 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 in 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 in 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. For details, see Add variables to agents.
• 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.

To add a variable to a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. Select the Variables tab, and click Add Variable (+).
5. Enter a variable name and value pair, for example, MAVEN=M2_HOME
6. (Optional) To make the variable private, select the Private check box. The values of private variables are displayed obscured in the user interface.
7. Click Save.

See also

Configure agents

Publish chain results to ALM Octane

You can instruct chains to publish chain run results to external systems such as ALM Octane.

Before you can run a chain to send results to ALM Octane, add an ALM Octane connection and configure an ALM Octane pipeline, For details, see Set up a chain to publish chain results to ALM Octane.

To publish chain results to an ALM Octane pipeline:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit. Or click New (+) to create a new chain.
4. Add the Publish results to Octane step:
   1. In the Steps tab, click Add step to chain (+).
   2. In the Add Step list, click the Other tab and select the Publish results to Octane step. Or use search to find the step.
   3. Click Add next to the step. The step is added to the chain.
5. Click the step in the chain to configure it, and specify the following parameters:
   

   Parameter	Description
   Title	Enter a name for the chain step. The default name is Publish results to Octane.
   Control options
   Enable step	Leave this option selected to enable the step to run. Clearing this option deactivates the step.
   Fail step	(Optional) Specify the conditions for failing the step, such as findings criteria and/or log entries.
   Mark step as unstable	(Optional) Specify the conditions for making the step unstable, such as findings criteria and/or log entries.
   Output variables	(Optional) Enter the variables that you want to pass to other steps down the chain. For details on how to add output variables, see Publish output variables to chain steps.

6. Click Save.

In a working ALM Octane integration, PulseUno sends the chain run results to ALM Octane, and you can view them as an ALM Octane pipeline.

Configure chains to stop downstream chains

If a chain runs other chains, you can configure the parent chain to interrupt its child jobs whenever it is stopped.

To configure a chain to stop its downstream chains:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. In the Steps tab, select an existing Run another chain step to view its parameters.
5. In the step's parameters, select Wait for chain run results.
   Now when you stop the chain mid-run, any chains triggered by this chain will also stop.

Enable ongoing vulnerability detection

You can enable ongoing vulnerability scanning for chains with dependencies. This way, PulseUno will regularly check for new vulnerabilities and detect them as soon as they are discovered. The vulnerability information is displayed in reviews and on the chain run pages, and passed on to the vault.

For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

To enable ongoing detection of vulnerabilities:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. Select the Option tab.
5. For the Vulnerabilities option, select Enable ongoing detection of vulnerabilities.
6. 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. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list 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 content from repository selection.
   • To analyze the entire stream or branch, select Fetch content from repository and leave the content box empty.
   • To analyze part of the stream or branch, select Fetch content from repository and in the content box 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. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains. The chain list opens.
3. Click the chain's name to open the chain and view its results, configuration, and steps.

Share chains

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

To export a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. From the chain list, open the chain that you want to export.
4. From the Actions menu , select Export Chain.
5. Navigate to the downloads folder on your machine and find a .chain file containing the exported chain.

You can import chains from members of your team.

To import a chain:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains, and then open a chain from the chain list.
3. From the Actions menu , select Import Chain.
4. In the Import Chain dialog box, drag and drop the .chain file onto the upload area. Or 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.

To configure additional chain settings:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains, and then open a chain from the chain list.
3. Click Edit and select the Options tab.
4. Specify the following settings:
   

   Setting	Description
   Stop early	Select to stop a chain on first step failure.
   Stop execution after	Specify the number of minutes after which the chain run will be stopped. To run the chain indefinitely, enter 0 or leave the field empty.
   Limit queued chains	Select to allow only one run of this chain to be in the queue.
   Retention policy	Select a policy for keeping the logs in this chain. For details on how to configure retention policies, see Create chain and vault retention policies. Tip: You can override the retention policy for individual logs in a chain. For details, see View chain run details.

Define measurements in chain steps

Use the Script, Maven, or Gradle plugins to define custom measurements, capture them to a file, and publish them to PulseUno.

When you run a script with your measurements as part of a Script, Maven, or Gradle chain step, the script can generate a pulse-measurements.properties file, the contents of which PulseUno adds as custom measurements created by the step. You can then view these measurements in the user interface and pass them to other chain steps. For details, see Publish output variables to chain steps.

Guidelines for defining measurements:

• To define custom measurements, your script must create the pulse-measurements.properties file. PulseUno will not recognize the file with a different name.
• Use the following syntax for each line:
  measurement-name=measurement-value
  
• Because pulse-measurements.properties is a Java properties file, use the ISO 8859-1 (ISO Latin1) 8-bit character encoding.
  To encode UTF-16 code units that are not in the ISO-Latin1 character set, use Unicode escape sequences such as \uXXXX, where XXXX is a 4-digit hexadecimal code point that represents a single character. For example, to encode the value €100.00 (one hundred euros), use the following escape sequence: \u20AC100.00
• You can define the string, number, or boolean metric types by adding @string, @number, or @boolean to the relevant variable. For example, count@number=10 creates the count metric with the number value of 10.
• You can paste your script into a step or use a script file that you checked in to the project's working directory. When the step completes, PulseUno will look for the pulse-measurements.properties file in the top directory of the chain’s build area (normally, the default working directory for the step).
• Follow the syntax and character guidelines in Publish output variables to chain steps.

To define custom measurements in a chain step:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain for editing, or click New (+) to create a chain.
4. Add a Script, Maven, or Gradle step to the chain.
5. Click the step to configure it.
6. In the step's parameters, specify the script that the step will run:
   

   Script	Runs a batch file (Windows) or shell script (other systems). To add your script: Select the script language. Enter your script in the Command line box. Alternatively, from the Location list, select File in workspace, and enter a path to the script file, for example, scripts/runstep.bat.
   Maven	By default, runs a pom.xml file from the working directory.
   Gradle	By default, runs a build.gradle file from the working directory.

7. Configure other parameters. For details, see the Gradle, Maven, or Script description in Configure experts.
8. Click Save.
   

When PulseUno runs the step, it will read any custom measurements from the pulse-measurements.properties file, but only if your script creates the file.

To view the measurements in PulseUno, open a chain run and select the Measurements tab.

Publish output variables to chain steps

If a chain step produces measurements, you can publish them as output variables to other steps down the chain. This enables you to pass information to later steps and child chains.

You can define your own measurements and pass them as output variables. For details on how to add custom measurements, see Define measurements in chain steps.

Guidelines for specifying output variables:

• Use only these characters in variable names: a-z, A-Z, 0-9, and underscore (_).
• Enter one variable-name=variable-value pair per line.
• Measurement names are not case-sensitive. For example, newvar=${Finding Count} matches newvar=${finding count}.
• An output variable value can contain the values of other variables or step measurements. Use the following syntax: ${variable-name} or ${measurement-name}.
• You can combine variables and measurements, for example, newvar=Step in ${chainnum} has ${finding count} findings.
• You can use escape sequences in variable values: newline \n, tab \t, return \r, and backslash \\.
• Variable values defined in later steps override those in earlier steps. For example, if the same output variable is defined in steps 1 and 2, then step 3 will use the value from step 2.

To publish output variables:

1. In PulseUno, navigate to Spaces, select a space and then a product or Git repository.
2. In the sidebar, select Chains.
3. Open a chain from the chain list and click Edit.
4. In the Steps tab, click the step from which you want to publish output variables.
5. In the step's parameters, expand the Output Variables section and enter the output variables you want to publish, one variable-name=variable-value pair per line.
6. Click Save.

Only output variables are replaced. Your PulseUno agent makes a record of step variables in the step log, indicating what output variables have been overwritten. To view the step log, open a chain run and select the Log tab.

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/Git repository, or stream/branch.
2. In 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. Point to a line number to view information.

View chain run details

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

1. Navigate to Spaces, select a space, and then select a product or Git repository.
2. In the sidebar, select Chains. The chains list opens.
3. Open 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

As an administrator, you can edit and delete chains:

1. Navigate to Spaces, select a space, and then select a product or Git repository.
2. In the sidebar, select Chains. The chains list opens.
3. To delete one of more chains, select them from the list, click Delete, and confirm.
4. To edit a chain, open it and click Edit.
5. Edit the chain's configuration, add and remove steps, change the running order of steps, 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 product or Git repository containing the chain that you want to diagnose, and do one of the following:

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

To diagnose a specific changeset:

1. Navigate to Spaces, select a space, and then select a product or Git repository.
2. In the sidebar, select Chains. The chains list opens.
3. Select the chain.
4. In 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 or branch. Pull requests are a collaborative process that enables a team to:

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

Key facts:

• Pull requests are related to two streams or branches: the source stream/branch, where the pull request changes are made and reviewed, typically a topic stream; and the target stream/branch, where the pull request changes will be merged to, typically a mainline.
• Pull requests can be related to a request, which is used to merge the changes in the pull request.
• Pull requests enable you to merge changes into a target stream or branch without using a work area. For details, see Merge changes in pull requests.
• Pull requests can run chains to help you decide if the changes in a stream are healthy. For details, see Run chains on pull requests.

As an administrator, you can instruct PulseUno to create a pull request automatically when a branch or topic stream are created. The new pull request is automatically linked to the branch or topic stream. For details, see Configure how pull requests are created.

As part of its integration options, PulseUno enables you to synchronize pull request states with the phases of ALM Octane backlog items and the Dimensions CM request states. For details, see the following topics:

• Synchronize with ALM Octane
• Set integrations with Dimensions CM roles and request states

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 stream or branch 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 or branch. For details on how to set up the automatic merge, see Merge pull requests automatically.

If the automatic merge is not enabled, when changes have been reviewed and approved, and if there are no conflicts between the topic stream or branch 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. For details on the manual merge, see Merge pull requests manually.

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.

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.

For details on how to define the settings for creating pull requests automatically, see Configure how pull requests are created.

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 in 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 a product or 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. In 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. For details, see Review rules.

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. For details, see Review rules.

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.

To merge pull requests automatically:

1. In PulseUno, navigate to Spaces, select a space, and then select a product or a Git repository.
2. To enable the automatic merge for a particular stream or branch, select the stream or branch.
3. In the sidebar, select Settings >Reviewing changes.
4. In the Pull Requests section, 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.

Configure how pull requests are created

As an administrator, you can define pull requests settings for one or more Git repository branches or a Dimensions CM product or stream.

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

To configure pull requests for a product or a set of Git branches:

1. In PulseUno, navigate to Spaces, select a space and then 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 if you want to enable pull requests.
4. (Optional) If you enabled pull requests, select the option for creating pull requests automatically:
   

   Dimensions CM streams	Select Automatically when the source branch is a Dimensions topic stream.
   Git repositories	Select Automatically when the source branch matches... Specify the branches for which PulseUno will automatically create pull requests. Enter a comma-separated list of branch names or name patterns. Use an asterisk * as a wildcard to match a set of branches.

5. Click Save.

To configure pull requests for a CM stream:

1. In PulseUno, navigate to Spaces.
2. Select a space, a product, and then a stream.
3. In the sidebar, select Settings > Reviewing changes.
4. On the Reviewing Changes page, in the Pull Requests section, select Override defaults for pull request creation. This enables PulseUno to use the stream setting instead of the default product setting.
5. Select the settings for enabling pull requests and creating pull requests automatically.
6. Click Save.

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

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.

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

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.

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

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.

Set display defaults

To set the display defaults for your pull requests, see Set review page and pull request defaults.

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

To set the reviewer role:

1. In PulseUno, navigate to 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 merge strategies for pull requests

Out of the box, PulseUno provides several methods for merging commits. As an administrator, you can apply these merge strategies to all pull requests in a Git 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 PulseUnot, open 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, open 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

Use vaults to store software components

About PulseUno vaults

Vaults overview

A PulseUno vault is a secure repository for collections of software components such as binaries, artifacts, and metadata. 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 combines two vaults:
  • A local vault containing your application binaries.
  • A remote vault containing third-party tools, such as Maven.

Key features of PulseUno vaults

Vaults provide the following functionality:

• 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.
• Integration with package managers such as Maven, npm, and Docker.
• 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 a list of all vaults and their details such as the vault type, storage type, and visibility level (for vaults with public access).
• Filter vaults by package type or vault type, and sort them by creation date or title.
• Search for vaults by name.
• Drill down to view information about each vault, such as packages, URL, and statistics.
  The vault statistics includes the following information:
  • Total size of all package content in the vault.
  • Total number of packages and versions.
  • A breakdown of package versions by state.
• Drill down to view the details of each package, such as contents, licenses, and detected vulnerabilities.
  
• Drill down to view activity, such as who delivered, used, reviewed, and approved packages.

To view information about vaults:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page displays all the current vaults.
3. To view a vault's packages and details, click the vault's name. The individual vault's page opens, where the vault's URL and statistics are displayed on the right.
4. To change the page layout, switch between the views:
   

   List view (default)	Displays vault contents as a list of packages, which you can sort by name, namespace, last modified date, and in an ascending or descending order.
   Tree view	Displays vault contents as a hierarchical tree of Maven namespaces, npm scopes, or Docker directories.

5. To copy the vault's URL for your IDE or build scripts, click Copy next to the URL.
6. To view the users with access to the vault, and the roles they hold, for example, developer or approver, click Members in the sidebar.
7. To view a vault's general settings, click Settings in the sidebar.
8. To view a list of package versions, click the package name.
9. To view information about a package version, click the version's name. On the package version page, navigate between the tabs to view recent activity, licenses, and vulnerabilities. Depending on the package type, PulseUno also provides commands and code snippets for using the package in your build system. For details, see Review package contents.

Create, configure, and delete vaults

This topic describes how to create, configure, or remove local, remote, and virtual vaults.

PulseUno supports the following package managers:

• Maven
• npm
• Docker

Create local vaults

A local vault is stored in a local file system or repository.

To create a local vault:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, click Add (+) and select Local. The New Local Vault page opens.
4. Enter the following details for the local vault:
   

   Field	Description
   Vault title	Enter a name for the local vault.
   Description	(Optional) Enter a description for the vault.
   Package type	Select a vault package type: Maven npm Docker
   Access	Select the access permission: Authenticated (default). Provides full access to the vault to any logged in user. Anonymous. Provides read-only access to the vault. No login authentication is required. A vault with the Anonymous permission is a public vault.
   Vulnerability check	(Optional) To enable regular vulnerability checks, select Enable automatic checking of packages for vulnerabilities. Using this option, you instruct PulseUno to regularly update packages in the vault with any new vulnerabilities that may be discovered. For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.
   Storage type	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 CM repository or create a new connection. For details, see Configure connections to Dimensions CM repositories.

5. Click Save.

Create remote vaults

A remote vault caches copies of content from a remote system.

To create a remote vault:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, click Add (+) and select Remote. The New Remote Vault page opens.
4. Enter the following details for the remote vault:
   

   Field	Description
   Vault title	Enter a name for the remote vault.
   Description	(Optional) Enter a description for the remote vault.
   Package type	Select a vault package type: Maven npm Docker
   Access	Select the access permission: Authenticated (default). Provides full access to the vault to any logged in user. Anonymous. Provides read-only access to the vault. No login authentication is required. A vault with the Anonymous permission is a public vault.
   Vulnerability check	(Optional) To stop regular checks for new vulnerabilities, clear the Enable automatic checking of packages for vulnerabilities option. For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.
   Remote Vault Connection
   Remote URL	Enter the URL of the remote repository to be cached, for example: https://repo1.maven.org/maven2/
   Username	(Optional) Enter a username for accessing the remote vault.
   Password	(Optional) Enter a password for accessing the remote vault.
   Storage type	Select a storage type: Filesystem. The vault will be stored in a local system. Dimensions CM. The vault will be stored in a local CM repository. Select a connection to an existing CM repository or create a new connection. For details, see Configure connections to Dimensions CM repositories.

5. Click Save.

Create virtual vaults

A virtual vault is a collection of local and remote vaults.

The order of the vaults in a virtual vault is important: they are searched in descending order, starting from the first vault, to locate matching packages during package download. After you create a virtual vault, change the order of the vaults as required.

To create a virtual vault:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, click Add (+) and select Virtual. The New Virtual Vault page opens.
4. Enter the following details for the virtual vault:
   

   Field	Description
   Vault title	Enter a name for the virtual vault.
   Description	(Optional) Enter a description for the virtual vault.
   Package type	Select a vault package type: Maven npm Docker
   Access	Select the access permission: Authenticated (default). Provides full access to the vault to any logged in user. Anonymous. Provides read-only access to the vault. No login authentication is required. A vault with the Anonymous permission is a public vault.
   Vulnerability check	(Optional) To enable regular vulnerability checks, select Enable automatic checking of packages for vulnerabilities. Using this option, you instruct PulseUno to regularly update packages in the vault with any new vulnerabilities that may be discovered. For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

5. Click Save.

To add vaults to a virtual vault:

1. Open the virtual vault you have created.
2. In the Vaults tab, click Add (+).
3. In the Add Vaults dialog box, enter a search string and press Enter.
4. Select one or more vaults from the search results and click Add.
5. (Optional) After you have added vaults, change their order by dragging them to different locations.

Specify the vault for publishing packages

Virtual vaults contain multiple vaults. When you publish packages into a virtual vault, the packages are deployed to the vault which you set as published.

When working with virtual vaults, take into account:

• Only one vault in a virtual vault can be published.
• You can change the published vault anytime.

To specify the vault to publish packages into:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, open a virtual vault.
4. On the virtual vault's page, select the vault you want to publish.
5. Click Publish.

Edit vault settings

As an administrator, you can edit settings and configurations for existing vaults.

To edit vault settings:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, select a local or remote vault. You can also select vaults inside virtual vaults.
4. In the sidebar, click Settings.
5. Edit the vault's general settings. You can change any setting except the package type and storage type.
   

   Field	Description
   Vault title	Change the vault's name.
   Description	Update the vault's description.
   Access	Change the access permission: Authenticated (default). Provides full access to the vault to any logged in user. Anonymous. Provides read-only access to the vault. No login authentication is required. A vault with the Anonymous permission is a public vault.
   Vulnerability check	Enable or disable regular checks of packages for vulnerabilities. Using this option, you instruct PulseUno to regularly update packages in the vault with any new vulnerabilities that may be discovered. For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

6. Click Save.

Delete vaults

As an administrator, you can delete vaults. Deleted vaults are scheduled to be permanently removed after 7 days. During those 7 days, you can cancel the deletion anytime.

To delete a vault:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, open the vault you want to delete.
4. In the sidebar, select Settings > Advanced.
5. Click Delete this vault and confirm the deletion.
   The vault is now scheduled to be deleted in 7 days.
6. To delete the vault instantly, click Complete Deletion Now.
7. In the warning dialog box, enter the name of the relevant space and vault.
8. Click Complete Deletion Now. The vault is permanently removed.

To stop the vault deletion:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, select Vaults.
3. On the Vaults page, open the vault scheduled to be deleted.
4. In the sidebar, select Settings > Advanced.
5. Click Stop deletion and confirm your action.

Configure HTTP access to vaults

This section describes how to set up an HTTP connection to a vault if you want to use HTTP instead of HTTPS.

Set up HTTP access to a Maven vault

Because Maven 3.8.1 and later doesn't support non-HTTPS repositories, we recommend that you configure your vault server for HTTPS. For details, see Configuring Web Tools for HTTPS in the Dimensions CM Administration Guide.

To enable HTTP access to your Maven vault, follow the instructions in this topic.

To set up an HTTP connection:

Create a custom Maven settings.xml or .mvn/local-settings.xml file with the following entry:

<blocked>false</blocked>

For details on creating the settings file, see the Maven documentation.

Example:

Suppose this is the way you vault is configured in the pom.xml file:

<repositories>
  <repository>
    <id>my-repository</id>
    <name>my-vault</name>
    <url>http://my-server:8080/vault-server/maven/my-space/my-vault</url>
  </repository>
</repositories>

Then, to unblock HTTP access to the vault, include the following entries in the settings file:

<mirrors>
  <mirror>
    <id>unblock-my-vault</id>
    <mirrorOf>my-repository</mirrorOf>
    <name>my-vault</name>
    <url>http://my-server:8080/vault-server/maven/my-space/my-vault</url>
    <blocked>false</blocked>
  </mirror>
</mirrors>

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.
• Continuous Integration: 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. In PulseUno, navigate to Spaces and open a space.
2. In the sidebar, click Vaults, and then select a local or remote vault. You can also select vaults inside virtual vaults.
3. In the sidebar click Settings > Approving changes.
4. Select Enable check list.
5. Select a package approval checklist for this vault.
6. 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 for all vaults:

1. In PulseUno, navigate to Spaces and 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 these are the 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. For details, see Review and approve vault packages.

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

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>

<hostname>:<port-number>/<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.

To publish a vault package:

1. In PulseUno, open Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open the vault containing the package you want to publish.
4. Open the package and then a package version.
5. In the Conversation tab, on the right, click Approver.
6. Select approvers for this package and click Save.
7. To publish the package so that it can be reviewed and approved, click Publish.
8. To confirm, click Publish Package.

Download files and packages

You can download content from a vault. PulseUno enables you to download individual files or entire packages. Packages are saved as single zip files.

To download a file:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open a vault and then open a vault's package.
4. Open the package version that contains the file you want to download.
5. Select the Content tab.
6. Select a file from the content list. Use the Find field to search for files by name.
7. In the Info section, click the file name link. Confirm the download if requested.

To download a package:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open a vault and then open a vault's package.
4. Click Download. Confirm the download if requested.
   A zip file with package contents is downloaded to your machine.
   

Delete packages

As an administrator, you can delete vault packages and package versions.

To delete packages:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open the vault containing the packages you want to remove.
4. Select one or more packages.
5. Click Delete and confirm the deletion.

To delete package versions:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open a vault and then open a vault's package.
4. Select one or more package versions.
5. Click Delete and confirm the deletion.
   
   NOTE Alternatively, to delete a single package version, open the package version and click Delete at the top right.

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, rename the package, and send comments to team members.

To review package contents:

1. In PulseUno, navigate to Spaces and select a space.
2. In the sidebar, click Vaults. The Vaults page opens.
3. Open the vault containing the package you want to view.
4. Open the package and then a package version.
5. To view and edit information about the package, navigate between the tabs:
   

   Tab	Description
   Conversation	Edit the description to change the package's automatically generated name. Send comments and questions to other members of your team. Replies from the team are displayed in this tab.
   Details	View the package details, for example, who deployed the package and when. View command and code hints on how to use the package in your project. For example, for npm, find commands for installing the package to your npm project or adding the package to a dependency file.
   Content	View details about the files and folders included in the package. Download a package file or the entire package. For details, see Download files and packages.
   Activity	View the recent activity for the package.
   Licenses	View licenses for the package, for example, Apache 2.0.
   Vulnerabilities	View vulnerabilities detected by PulseUno, including the source, Common Weakness Enumeration (CWE, software weakness types), severity, and description. For details on how to enable regular vulnerability checks, see Edit vault settings.

Approve vault packages

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

Reject packages if they violate your organizations standards such as licensing, performance, or 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.

You can approve or reject multiple packages at once.

To approve or reject a package:

1. In PulseUno, open My Work.
2. In the sidebar, click Package approvals. A list of packages pending your approval is displayed. Sort the list as required, for example, by package version or the users who deployed the packages.
3. Open the package version by clicking its name.
4. To approve the package, click Approve. Optionally, in the Confirm Approval dialog box, enter the reason for approving the package.
   To reject the package, click Reject. In the Confirm Rejection dialog box, enter the reason for rejecting the package.
5. Click Approve or Reject to confirm your action.

To approve or reject multiple packages:

1. In PulseUno, open My Work.
2. In the sidebar, click Package Approvals. A list of packages pending your approval is displayed.
3. Select the packages you want to approve or reject.
   To select all the packages, click Toggle Select All .
4. To approve the packages, click Change Approval > Approve. Optionally, in the Confirm Approval dialog box, enter the reason for approving the packages.
   To reject the packages, click Change Approval > Reject. In the Confirm Rejection dialog box, enter the reason for rejecting the packages.
5. Click Approve or Reject to confirm your action.

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 space.
2. Set a rule for all vaults or individual vaults:
   

   All vaults	In the sidebar, select Settings > Vault Defaults.
   Individual vaults	In the sidebar, select Vaults. On the Vaults page, open a local or remote vault. In the sidebar, select Settings > Approving Changes.

3. For the Approval Rules option, select Enable automated approval and rejection using rule scripts.
4. Select a rule from the list.
5. Click Save.

Set a vault content policy

Content policies define what packages can be delivered to a vault and for how long they are kept. As an administrator, you create a content policy when you want to restrict specific packages from being uploaded. A content policy is set for each vault.

When creating a content policy, you can also apply a retention policy that specifies how long PulseUno needs to keep packages in a vault before purging them.

To set a vault's content policy:

1. In PulseUno, open Spaces and select a space.
2. In the sidebar, click Vaults.
3. On the Vaults page, open a vault.
4. In the sidebar, select Settings > Content Policy.
5. On the Content Policy page, provide the following information:
   

   Field	Description
   Retention policy	Set a retention policy for the vault: Select Enable automatic deletion of packages using retention policy. Select a policy from the list.
   Exclude packages	Specify the names of packages and versions to exclude from being delivered to the vault. Enter each name on a new line. Use Ant-style patterns and wildcards to exclude multiple packages, for example, com.acme.*.
   Include packages	Specify the names of packages and versions that can be included in the vault. Enter each name on a new line. Use Ant-style patterns and wildcards to include multiple packages, for example, com.acme.test.*. PulseUno matches each delivered package against the exclude filter first and then against the include filter. Packages that do not pass the filters will not be uploaded to the vault.

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 plugin 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 plugin 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 page.
• 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 Administration > 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 build artifacts 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 build artifacts to a Dimensions CM stream.

Configure

Capture to Directory

Overview

Captures build artifacts to a directory.

Configure

Capture to SCP/SFTP

Overview

Captures build artifacts 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 artifacts 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:

Because Deployment Automation normally operates on binary files, add the DA Deployment expert to a chain that populates a workspace with build artifacts.

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

Because Deployment Automation normally operates on binary files, add the DA Generic Process expert to a chain that populates a workspace with build artifacts.

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

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. For details, see Add capabilities to agents.

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. For details, see the Apache Ant documentation.

Prerequisites

Ant must be installed on an agent and added as a capability. For details, see Add capabilities to agents.

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. For details, see the Gradle documentation.

Prerequisites

Gradle must be installed on an agent and added as a capability. For details, see Add capabilities to agents.

Configure

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