Configuring P4 Server extensions

P4 Server provides extensions to customize server operations or invoke additional processing for specific versioning operations. Perforce TeamHub extensions notify TeamHub about activity on the P4 Server. When extensions are configured, any pushes to graph depots or any submits to stream depots are visible as events in the TeamHub Activity view.

You can easily install, view the status of, and remove extensions using the TeamHub admin UI. Extensions are installed on the P4 Server that TeamHub is configured to connect to.

Configuring extensions requires that you already have an administrator bot account. For more information on setting up an administrator bot account, see Bots and programmatic repository access.
Extensions require P4 Server 2019.2 or later. If you are using an earlier version of P4 Server, you must use triggers and not extensions.

  1. Log in to the Perforce TeamHub administrator UI.

  2. Click P4 Extensions.

    The Configure P4 Server Extensions page opens.

  3. Make any changes to the Perforce TeamHub properties and extensions.

Perforce TeamHub properties

In the Perforce TeamHub properties, you can set the URL for the Perforce TeamHub instance and select the account key for the company administrator bot used by P4 Server to perform authenticated calls.

  • URL - The hostname of the TeamHub instance. If the hostname is not configured or you need to change it, in the pane on the left side of the page, click Preferences.
  • Account key - The company-administrator bot that will generate events for TeamHub. Select the bot name to use and click Save.

Perforce TeamHub (hth) extension

The Perforce TeamHub extension, named hth-extension, is required to create events for stream and classic depots. This extension supports the following events:

  • change-commit

If the extension is installed, you can view general and status information on the Configure P4 Server Extensions page. You can also install and remove the extension from this page.

  • If the extension is not yet installed, click Install. The extension is installed to the P4 Server. If the Install button is not available, you need to set the Perforce TeamHub properties first.
  • To upgrade the extension when a new version is available, click Upgrade. The extension is removed and then the new version is installed.
  • If the extension is installed and you want to remove it, click Remove. The extension is removed from the P4 Server.

Perforce TeamHub Graph (hth-graph) extension

The Perforce TeamHub Graph extension, named hth-graph-extension, is required to create events for graph depots. This extension supports the following events:

  • branch create

  • branch delete

  • tag create

  • tag delete

  • graph-push-reference-complete

If the extension is installed, you can view general and status information on the Configure P4 Server Extensions page. You can also install and remove the extension from this page.

  • If the extension is not yet installed, click Install. The extension is installed to the P4 Server. If the Install button is not available, you need to set the Perforce TeamHub properties first.
  • To upgrade the extension when a new version is available, click Upgrade. The extension is removed and then the new version is installed.
  • If the extension is installed and you want to remove it, click Remove. The extension is removed from the P4 Server.