Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

Aramis/Design/Tagging
From Bpmdevwiki
Contents
1 Document Status 2 Introduction 3 MRD 4 Goals 5 Scope 6 User Stories 7 Design 7.1 Permissions 7.2 Persisting Tags Between Consoles 7.3 Tags on Projects 7.4 Tags on Rules 7.5 Adding/Removing a Tag 7.6 Sort by Tags 7.7 Search 7.8 Stream

1 Document Status
This document was last updated on June 18; updated permissions and streams sections as per playback feedback June 18 playback w/dev April 27 initial draft

2 Introduction
Tags provide a quick way of categorizing elements within the repository. They can be created and removed from projects and rules. Tags were initially to be supported in Athos release, but were not able to be contained. This work incorporates that design work as well.

3 MRD
[Tagging MRD]

4 Goals
Provide a quick way of categorizing artifacts for each ndability and grouping

1 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

5 Scope
Support for tags on rules and projects are only included in this release.

6 User Stories
Adam can migrate existing tags from the Enterprise Console Bea can search for a tag Bea can sort artifacts by tag Bea can create and delete a tag on rules, projects
Comment: For this initial release, we will not be supporting tags on vocabulary terms, snapshots nor branches. --Davis 14:35, 27 April 2012 (CDT)

7 Design
7.1 Permissions
Projects As there are no permissions specically set on projects, we will use the permissions on the main branch of the project to set/edit tags on projects Only someone with edit access on the main branch of a project can add/edit tags to the project Users who can not edit the main branch of a project can only view tags on the project Rules Users with edit access to rules can add/edit tags to a rule Users with view access to rules can only view tags to the rule

7.2 Persisting Tags Between Consoles

There is only a one way push of tags - from the Enterprise Console to the Business Console
Question: Is this only a one-time synch? e.g. run a script once --Davis 12:14, 18 June 2012 (CDT)

Comment: We ave some discussion on this topic. Tagging is a new feature and we don't need to push the old tags to the new old YeePin 17:12, 20 June 2012 (CDT)

Tags that exist on artifacts in the Enterprise Console will be surfaced in the Business Console Only the "value" portion of the named pair will be surfaced. For example if an existing tag was "State, New Jersey" (Name, Value) on only New Jersey will be surfaced on the element in the Business Console
Question: It's likely that the internal implementation of "new tags" will be different from how we implemented "old tags", mainly for performance reasons, so I think we should not assume that

2 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

we will reuse the old tags as is and simply say that a new tag is an old one without name. If we want to keep old tags, couldn't we rather migrate them when migrating the database from 8.0 to 8.5? Note that if a old tag was a numeric value, then some rules will be "newly"-tagged with some numeric values as well... --Antoine.melki@fr.ibm.com 04:31, 3 May 2012 (CDT)

7.3 Tags on Projects

Tags on Projects can be added in: Project details page Library

When a project has no tags: In the library an Add Tags link will appear on hover under project name On the Project Details page an Add Tags link will appear at all times under the project name When Project has one or more tags: In the library, there will be a Edit Tags link on hover to the right of the current tags On the Project Details page an Edit Tags link will appear at all times to the right of the current tags If a project has too many tags to display, smart roll-up will appear:

3 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

Example: Project Name 1 (tag 1) (tag 2) (tag 3) (+3 more...) Hovering on the (+x more...) will show the tags in the hover tooltip Clicking on + X More will show the X more tags
Question: Currently the "description" of the project details page applies to the current branch. Should we do this for tags as well, or are tags at the project level only, and not at the branch level? --Antoine.melki@fr.ibm.com 04:31, 3 May 2012 (CDT)

Answer: I do not believe that branches can be tagged; for Aramis, you can tag a project or a rule. --Davis 14:19, 13 June 2012 (CDT)

7.4 Tags on Rules

Tags on rules can be added in: Editor (in edit mode) Project Details page When a rule has no tags: In the project details page an Add Tags link will appear on hover under rule name In the editor in edit mode an Add Tags link will appear under the rule name In the editor in view mode nothing will be shown under the rule name When a rule has one or more tags: In the project details page, there will be a Edit Tags link on hover to the right of the current tags In the editor in edit mode an Edit Tags link will appear to the right of the last tag shown In the editor in view mode the tags will appear under the rule name In the project details page, if a rule has too many tags to display, smart roll-up will appear: Example:
Rule Name 1 (tag 1) (tag 2) (tag 3) (+3 more...)

Hovering on the (+x more...) will show the tags in the hover tooltip Clicking on + X More will show the X more tags
Question: Are tags cross-versions? Cross-snapshots? Cross-branches? --Antoine.melki@fr.ibm.com 04:28, 3 May 2012 (CDT)

Answer: Tags are attached to a rule. If a rule is in multiple snapshots, multiple branches etc. those tags stick with the rule. If a rule is copied, so too are the tags; the tags in the duplicate rule however can be edited without affecting the initial rule's tags. --Davis 07:08, 5 June 2012 (CDT)

7.5 Adding/Removing a Tag

4 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

These mockups use the header to show how tags are added; the same process is used in the Project Ddetails page too The user clicks on the Add tags link

The [icon] and label disappear and are replaced by an input eld The user types into the eld Type ahead matching terms with existing tags

As soon as the user clicks "Enter" or adds a comma, a tag is created

The word is encapsulated by a border and a red "x" icon in the top right corner By clicking on the red x at any point, the tag is deleted When the user clicks away (e.g. onto anything but the input eld) the edit tag session is completed

7.6 Sort by Tags

Sorting by Tag will be added to the Library for projects and the Project Details page for rules Sorting by Tag will group things under "headers" with the Tag being the name of the header. The headers themselves being sorted alphabetically, and the objects within them sorted alphabetically When sorting by Tag in the library, the # of items will be shown in each group in the headers If a project or rule has more than one tag, and you are sorting a list by tag, that space will appear once in each tag "Header", so the same project could appear multiple times. Items without tags will appear in an "Untagged" section

5 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

6 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

7.7 Search
Clicking on a tag will take you to the Search page, with a search completed for that tag within the project A new lter will also be added to the search so you can lter by tag e.g. Currently you can lter the search results to only show Action Rules etc., and you should be able to only who search results that are tags

7.8 Stream
A new event will be added to the streams for tags. An event will be generated on the Repository Stream (home page) when a tag is Added/Removed to a project. A user will only be able to see this event if they are subscribed to that project Example:
You added tag1 tag to Project x project

An event will be generated on the Repository Stream (home page) and the Editor stream when a tag is Added/Removed to a rule.

7 of 8

13-11-06 10:03 AM

Aramis/Design/Tagging - Bpmdevwiki

http://bpmdevwiki.austin.ibm.com/index.php/Aramis/Design/Ta...

A user will only be able to see this event if they are subscribed to that rule Example:
You added tag1 tag to Rule x rule

8 of 8

13-11-06 10:03 AM