Getting build result linked to a work item

1

permanent link

Nick Edgar (6.5k●7●11) | answered Sep 08 '11, 9:26 p.m.
JAZZ DEVELOPER

The build-related link types are defined by the Build component. The Work Items component doesn't know about them. Constants for them are defined in com.ibm.team.build.internal.common.links.BuildLinkTypes, i.e.

    /**

     * Link between a build and a work item to indicate that the work item was

     * reported against the build.

     */

    public static final String REPORTED_WORK_ITEMS = &quot;com.ibm.team.build.linktype.reportedWorkItems&quot;; //$NON-NLS-1$



    /**

     * Link between a build and a work item to indicate that the changes

     * associated with the work item are included in the build.

     */

    public static final String INCLUDED_WORK_ITEMS = &quot;com.ibm.team.build.linktype.includedWorkItems&quot;; //$NON-NLS-1$

These are item links, so the source reference is a build result item handle, and the target reference is a work item handle.

To create the link, use ILinkServiceLibrary methods, e.g. something like:


        ILinkServiceLibrary linkService = getLinkServiceLibrary&#40;&#41;;

        IBuildResultHandle buildResultHandle = ...;

        IWorkItemHandle workItemHandle = ...;

        IItemReference buildResultRef = linkService.referenceFactory&#40;&#41;.createReferenceToItem&#40;buildResultHandle&#41;;

        IItemReference workItemRef = linkService.referenceFactory&#40;&#41;.createReferenceToItem&#40;workItemHandle&#41;;

        ILink link = linkService.createLink&#40;&quot;com.ibm.team.build.linktype.reportedWorkItems&quot;, buildResultRef, workItemRef&#41;;

        linkService.saveLink&#40;link&#41;;

where getLinkServiceLibrary() is:


    private ILinkServiceLibrary getLinkServiceLibrary&#40;&#41; &#123;

        return &#40;ILinkServiceLibrary&#41; getService&#40;ILinkService.class&#41;.getServiceLibrary&#40;ILinkServiceLibrary.class&#41;;

    &#125;

Ralph Schoon selected this answer as the correct answer

Comments

Morten Madsen commented Jun 09 '13, 12:26 p.m.

Hi, I just used this code using the Java client API (used the ILinkManager instead of ILinkServiceLibrary).

The work item gets a nice link "Included in builds" but my build result does not show the work item.

Any ideas why this happens?

0

permanent link

Nick Edgar (6.5k●7●11) | answered Jul 17 '13, 11:27 a.m.
JAZZ DEVELOPER
edited Jul 17 '13, 11:28 a.m.

For more on contributing "included in build" links to a build (via client-side API), see thread https://jazz.net/forum/questions/117259/adding-work-items-to-build-result-using-api

It involves more than just creating the links.

0

permanent link

Nick Edgar (6.5k●7●11) | answered Sep 21 '11, 12:16 p.m.
JAZZ DEVELOPER

The corresponding client-side methods are all on com.ibm.team.links.client.ILinkManager, which you can get as a client library from the ITeamRepository connection.

For example, Build's (internal) WorkItemHelper class uses these as follows:


    public static IWorkItemHandle&#91;&#93; getLinkedWorkItems&#40;ITeamRepository teamRepository,

            IBuildResultHandle buildResultHandle, String buildLinkType, IProgressMonitor monitor&#41;

            throws TeamRepositoryException &#123;

        ValidationHelper.validateNotNull&#40;&quot;teamRepository&quot;, teamRepository&#41;; //$NON-NLS-1$

        ValidationHelper.validateNotNull&#40;&quot;buildResultHandle&quot;, buildResultHandle&#41;; //$NON-NLS-1$

        ValidationHelper.validateNotNull&#40;&quot;buildLinkType&quot;, buildLinkType&#41;; //$NON-NLS-1$



        List&lt;IWorkItemHandle&gt; reportedWorkItems = new ArrayList&lt;IWorkItemHandle&gt;&#40;&#41;;



        ILinkManager linkManager = &#40;ILinkManager&#41; teamRepository.getClientLibrary&#40;ILinkManager.class&#41;;

        IReference source = linkManager.referenceFactory&#40;&#41;.createReferenceToItem&#40;buildResultHandle&#41;;

        ILinkCollection referencesToResults = linkManager.findLinksBySource&#40;buildLinkType, source,

                monitor&#41;.getAllLinksFromHereOn&#40;&#41;;



        for &#40;Object object &#58; referencesToResults&#41; &#123;

            ILink link = &#40;ILink&#41; object;

            IWorkItemHandle workItemHandle = &#40;IWorkItemHandle&#41; link.getTargetRef&#40;&#41;.resolve&#40;&#41;;

            if &#40;workItemHandle != null&#41; &#123;

                reportedWorkItems.add&#40;workItemHandle&#41;;

            &#125;

        &#125;



        return &#40;IWorkItemHandle&#91;&#93;&#41; reportedWorkItems.toArray&#40;new IWorkItemHandle&#91;reportedWorkItems.size&#40;&#41;&#93;&#41;;

    &#125;

Comments

praveen patidar commented Nov 06 '12, 9:08 p.m.

Hello
What If I have the Build Result Link and I need to add this in the work item, same as linking above?

https://<Server>.com:9443/ccm/web/projects/MY_BUILD_PROJECT#action=com.ibm.team.build.viewResult&id=_AXxKISh6EeKIIeAdAaNGgA

I want to add a normal reference to the work item for this build result.

Ralph Schoon commented Nov 07 '12, 2:50 a.m.

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

Praveen, you should probably describe the context you are asking better. For example,are you developing a client or server extension.

Some hints can be found here:

http://rsjazz.wordpress.com/2012/10/20/following-calm-links-using-the-java-client-or-server-api/

http://rsjazz.wordpress.com/2012/09/20/the-rtc-workitem-server-link-api-linking-to-work-items-and-other-elements/

http://rsjazz.wordpress.com/2012/09/19/the-rtc-workitem-link-api-linking-workitems-to-other-elements/

I think you should be able to use the described approaches to analyze how build results are linked to the work items today and create them that way.

0

permanent link

Luis Bazo (68●3●20●19) | answered Sep 21 '11, 11:07 a.m.
JAZZ DEVELOPER

The build-related link types are defined by the Build component. The Work Items component doesn't know about them. Constants for them are defined in com.ibm.team.build.internal.common.links.BuildLinkTypes, i.e.

    /**

     * Link between a build and a work item to indicate that the work item was

     * reported against the build.

     */

    public static final String REPORTED_WORK_ITEMS = &quot;com.ibm.team.build.linktype.reportedWorkItems&quot;; //$NON-NLS-1$



    /**

     * Link between a build and a work item to indicate that the changes

     * associated with the work item are included in the build.

     */

    public static final String INCLUDED_WORK_ITEMS = &quot;com.ibm.team.build.linktype.includedWorkItems&quot;; //$NON-NLS-1$

These are item links, so the source reference is a build result item handle, and the target reference is a work item handle.

To create the link, use ILinkServiceLibrary methods, e.g. something like:


        ILinkServiceLibrary linkService = getLinkServiceLibrary&#40;&#41;;

        IBuildResultHandle buildResultHandle = ...;

        IWorkItemHandle workItemHandle = ...;

        IItemReference buildResultRef = linkService.referenceFactory&#40;&#41;.createReferenceToItem&#40;buildResultHandle&#41;;

        IItemReference workItemRef = linkService.referenceFactory&#40;&#41;.createReferenceToItem&#40;workItemHandle&#41;;

        ILink link = linkService.createLink&#40;&quot;com.ibm.team.build.linktype.reportedWorkItems&quot;, buildResultRef, workItemRef&#41;;

        linkService.saveLink&#40;link&#41;;

where getLinkServiceLibrary() is:


    private ILinkServiceLibrary getLinkServiceLibrary&#40;&#41; &#123;

        return &#40;ILinkServiceLibrary&#41; getService&#40;ILinkService.class&#41;.getServiceLibrary&#40;ILinkServiceLibrary.class&#41;;

    &#125;

Hi,

Do you know how we can do the same from a snippet because we don't see ILinkServiceLibrary on the plain libraries client size.

Thanks

It's all about the answers!

Related questions

Getting build result linked to a work item

Accepted answer

3 other answers

Your answer