Perforce Helix Core

Perforce Helix Core is a version control software for large-scale development environments. Helix Swarm allows geographically dispersed developers to coordinate their code review.

Use the SEI Perforce Helix Server integration to integrate SEI with remote Helix Core Server instances.

Configure the SEI user

To transmit data from Perforce Helix Server to SEI, you must create an SEI user in your Perforce Helix Server instance.

1. To create a user in Helix Core Server, run p4 user -f USERNAME. Replace USERNAME with the desired username for your SEI user.

2. Assign at least the list permission to the user. You must have super access to run p4 protect and modify user permissions.

3. Note the username and password for the SEI user. You need this information to configure the SEI Helix integration.

For more information, go to the Helix Core documentation on the p4 user command and p4 protect command.

Configure the integration on cloud

1. Select Integrations under Settings.

2. Select Available Integrations, locate the Perforce Helix Server integration, and select Install.

3. Enter your Helix Core Server instance specifications:

   • Helix Core Server: Enter the IP/hostname of your Helix Core Server instance.

   • Helix Core Port: Enter the port on which Helix Core Server is running.

   • Username: Enter the username of the SEI user you created in Helix Core Server.

   • Password: Enter the password of the SEI user.

   • Helix Swarm URL: If you want to integrate with Helix Swarm, enter your Helix Swarm URL. If you don't want to integrate with Helix Swarm, leave this field empty.

   • Server Uses SSL: Select this option if your Helix Core Server instance uses SSL.

   • SSL Fingerprint: Enter the fingerprint for your Helix Core Server instance. You can get the fingerprint by running p4d -Gf, if the value of P4SSLDIR is set correctly.

4. To integrate with the on-premises instances of Helix Core Server, you must use an Ingestion Satellite.

5. Enter a Name for the integration. Description and Tags are optional.

6. Finish configuration and save the integration.

Configure the integration using satellite

The steps for configuring the integration using satellite is similar to configuring the integration on cloud, with the exception of using satellite to communicate with the Helix server.

Make sure to select the satellite integration checkbox while configuring the integration. Select Download the Config file to save the satellite.yml to your computer. Update it following the instructions here.

If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.

Here’s a sample satellite.yml file:

satellite:
  tenant: <ACCOUNT_NAME>
  api_key: <SEI_API_KEY>
  url: 'https://staging.propelo.ai'
integrations:
  - id: '<INTEGRATION_ID>'
    application: helix
    url: '<HELIX_CORE_SERVER_INSTANCE_URL>'
    username: <HELIX_CORE_USERNAME>
    api_key: <HELIX_CORE_API_KEY>
    metadata:
      helix_swarm_url: '<HELIX_SWARM_URL>'
      ssl_enabled: true
      ssl_fingerprint: <SSL_FINGERPRINT>
      ssl_auto_accept: false

Add Depot mappings

Depot mappings are required for your Helix Core data to be available in your SEI Insight.

1. Select Integrations under SEI Settings.

2. Find your new Perforce Helix Server integration and edit it.

3. Under Repo Paths add repo names and corresponding depot paths.

   1. A Repo Name is a unique identifier that identifies the set of files under a depot.

   2. A Depot Path is a Helix Core path.