Configure Traceability for Binary Artifact Repositories

Once a binary repository is created, configuring the repository to publish runtime data to EventQ is the next step that lets you track and visualize binary artifacts in real time using TeamForge EventQ.

Log on to TeamForge as Project Admin.

Click Project Admin from the Project Home menu.

Click Tools on the Project Admin Menu.

Click Binaries from the list of Project Tools.

Select Include Traceability check box.

Provide the data source details and click Update.

Link Binary Artifact Repository to Project

You can link existing binary artifact repositories, if any, to your project.

Note: Earlier, only project admins can link the repository to a project. From TeamForge 18.2, any user with the permission to create repositories can link the repository to a project.

Click BINARIES from the Project Home menu.

Click Link Existing Repository.

Select a repository from the list of binary repositories and click Link to Project.

Important: Make sure the <skip> tag is set to true to prevent more than one Nexus/Artifactory notification for a single Nexus/Artifactory artifact deployment. If <skip> is not set to true, notifications are sent by both the maven-deploy-plugin and the collabnet-deploy-maven-plugin for a single binary artifact.

Setup the Nexus/Artifactory and EventQ credentials in settings.xml. You may find this file in the Maven home directory. For example, in the following illustration, your distribution management section has a repository id of the local-nexus and the amqpServer, amqp://host.with.amqp is setup as mentioned in Step 1:

If you already have a set of credentials against an AMQP URL in settings.xml, all jobs including the one that posts events against different sources can use the same credentials. The following table lists the available configuration items.

Configuration Parameter

Description

Mandatory

Default Value

Example

amqpServer

An amqp url for the form amqp://host.domain where EventQ is listening to.

true

None

amqp://example.com

sourceAssociationKey

The source association key from orchestrate custom event setup.

true

None

uuid format

orchestrateSchemaId

The schema id posted to EventQ. Do not set it in v1.4.1 and later.

true

binary_artifact

binary_artifact

orchestrateSchemaVersion

The version of the schema, usually 1. Omit to default to 1. Do not set it in v1.4.1 and later.

false

1

1

amqpUserName

The AMQP user name. It is recommended not to set it in the project POM but using in settings.xml. Take it from the custom event setup in EventQ.

false

None

proj_custom

amqpPassword

The AMQP password. It is recommended not to set it in the project POM but using in settings.xml. Take it from the EventQ settings.

false

None

af78aaee0c5610d21….

amqpQueueName

Do not specify. Defaults to orchestrate.custom.

false

orchestrate.custom

orchestrate.custom

associatedBuildNumber

Specify to the env variable depending on your build system process. Set to ${env.BUILD_NUMBER} for Jenkins.

false

None

${env.BUILD_NUMBER}

skipOrchestrateNotification

Set to true to disable notification.

false

false

False

dieOnOrchestrateError

Defaults to true. Set to false to treat orchestrate notification errors as non-fatal.

false

true

true

component

Used to identify a specific binary artifact as a component in a larger application.

false

None

An ALM platform has several components such as an application server, an indexer, an SCM integration server and so on. These components have their own build process. This property is used to uniquely identify such components in EventQ.

componentOf

Associated with the ‘component’ parameter to store the details of the component.

false

None

SCM as a component of Teamforge.

Delete a Binary Artifact Repository

You must have the required permission to delete binary repositories. As a project admin, you can use the delete option only to unlink the repository from a project. If you want to delete a repository from the Nexus, login as a Nexus admin.

Click BINARIES from the Project Home menu.

In the list of the repositories, select the repository you want to delete and click Delete. The following confirmation message appears:

This repository will no longer be accessible. Your site administrator can relink it later. Are you sure you want to unlink this repository?

Click OK to delete.

The repository is deleted.

Note: This deletion disassociates the repository from your project; only the Site Admin can reinstate the repository.