Discussion of Jazz Linking Recommendations

DEPRECATED THIS DOCUMENT IS NO LONGER ACTIVE IN ARCHITECTURE MANAGEMENT DISCUSSIONS

The Jazz BeCALMBook? : http://jazz.net/wiki/bin/view/Main/BeCALMBook (requires registration) contains recommendations on linking of resources. The Jazz infrastruction is an IBM framework on which many of its OSLC based applications are built upon. There are many concepts and ideas that both drive and are driven by OSLC specifications.

John Crouchly: Would like to talk about this page http://jazz.net/wiki/bin/view/Main/BeCALMBook and the contradictions back link mandatory and caching of remote data)

In this page it states that providers should support linking by:

• provide and consume applicable domain-specific OSLC specifications.
• provide compact rendering and rich hovers for your resources.
• consume and provide delegated resource creation and selection.
• support to bulk create a collection of linked resources
• support traceability queries by providing filter queries. A filter query is a predefined query that returns resources in a particular state that is relevant to other domains. Examples, open/closed work items, success/failing test executions. A filter query can be combined with another query to perform traceability queries.

The Jazz linking guide document ( https://jazz.net/wiki/bin/view/Main/LinkingGuide) describes linking:

• Linking actions are normally found in the user interface wherever related resources are displayed as a set of hyperlinks. For some displays the linking action may be in a toolbar, associated with the display, or as a simple command link.
• Clicking 'Add link' should display a drop down containing a list of link types or relationships, unless there is only one type of relationship to be created, then it should go directly to the linking dialog.
• At many points in the user interface a user can link to an existing artifact or create a new artifact and link to it. Avoid putting these two commands on the same level, by putting the Create resource action within the context of the linking dialog, where a link is automatically generated after the resource is created, from the dialog.
• For any artifact that supports multiple displays of links in the user interface, there should be at least one part of the display that can support creation and management of the links. Deleting or editing the link should also be available from this context.
• Within a resource, where links are displayed, either display an action represented with an icon that contains a representation of the link metaphor link-action-icon.png and hover help that contains 'Add link'. Or as a command link in the form 'Add link' with a dropdown indicator. Clicking on this link will open a drop down menu which will show a list of relationships or link types. Or a command link or icon with the hover help or text 'Add link...' to go to directly to the dialog.
• "Action for opening dialog directly. The type of resource being added implies a specific relationship type "