Attaching changelists to items from Helix VCS clients

When you submit changelists in Helix VCS clients, you can attach them to Helix ALM items if triggers are configured for Helix Versioning Engine. To attach a changelist to an item, you enter the item tag in the changelist description and a trigger runs when you submit the changelist. You can see the attached changelist on the Helix ALM item Source Files tab.

Note:  Before you can attach changelists from Helix VCS clients, an administrator or other high-level user needs to configure triggers on the Helix Versioning Engine server. See Configuring triggers to attach changelists from Helix VCS clients to Helix ALM items.

1. When you submit a changelist from a Helix VCS client, enter the tag for the Helix ALM item to attach the changelist to in the description field.

The tag must be enclosed in square brackets ([]) and include the item type abbreviation, a dash, and the item number. For example, [IS-2345] attaches a changelist to issue 2345. If you do not know the item abbreviation to use, ask your administrator for help.

2. Submit the changelist.

The trigger runs and verifies that the specified Helix ALM item exists. If it exists, the changelist is attached. If it does not exist, an error is returned and the submit fails. Edit the changelist description to correct the item tag and submit the changelist again.

You can view the attached changelist on the Helix ALM item Source Files tab. If Helix Swarm information is configured for the project, you can click a hyperlink to open the changelist in Swarm.