[Rt-commit] r8356 - in rt/branches/3.7-EXPERIMENTAL-TUNIS: docs

[thayes at bestpractical.com]

Author: thayes
Date: Wed Aug  1 12:18:31 2007
New Revision: 8356

Added:
   rt/branches/3.7-EXPERIMENTAL-TUNIS/docs/locking
Modified:
   rt/branches/3.7-EXPERIMENTAL-TUNIS/   (props changed)

Log:
 r8523 at toth:  toth | 2007-08-01 12:00:04 -0400
 * Added locking documentation
 


Added: rt/branches/3.7-EXPERIMENTAL-TUNIS/docs/locking
==============================================================================
--- (empty file)
+++ rt/branches/3.7-EXPERIMENTAL-TUNIS/docs/locking	Wed Aug  1 12:18:31 2007
@@ -0,0 +1,77 @@
+RT Locking
+----------
+
+- A lock can be initiated manually by clicking the "Lock" link on one of the pages for the ticket (hard lock)
+
+- A lock is created whenever a user performs an action on a ticket that takes multiple steps (e.g., Edit, Resolve,
+  reply, etc., but not Quick Resolve, Quick Reject, etc.) (auto lock)
+
+     Locking Actions in RT:
+     ----------------------
+
+	- Comment
+	- Reply
+	- Resolve
+	- Modify Ticket ("Basics" link)
+	- Modify Dates ("Dates" link)
+	- Modify People ("People" link)
+	- Edit Links ("Links" link)
+	- Reminders ("Reminders" link)
+	- Modify All ("Jumbo" link)
+
+
+     Locking Actions in RTIR:
+     ------------------------
+
+	- Edit
+	- Split
+	- Merge
+	- Advanced
+	- Reply
+	- Resolve
+	- Reject
+	- Comment
+	- Remove
+
+- A lock can be removed manually by clicking the "Unlock" link on one of the pages for the ticket (hard unlock)
+
+- An auto lock is removed once the user is done with whatever he was doing on the page (e.g., when he clicks 
+  "Save Changes" on the Edit page). It is also removed if the Unlock link is clicked from a page that generated
+  an auto lock (in other words, clicking the Unlock link from any page will remove all locks on that ticket) 
+  (auto unlock)
+
+- A hard lock and an auto lock can stack; that is, if a user hard locks a ticket, then goes to an auto locked page,
+  there will be two locks in place (the hard lock and the auto lock). When the user is done with the auto lock page,
+  the auto lock will disappear as usual, but the hard lock will still be in place.
+
+- Locks are advisory: if a ticket is locked by one user, other users will be given a notification that another user has
+  locked the ticket but they will still be allowed to edit and submit changes on the ticket.
+
+- Locks will remain in place until
+	a) The user is done editing/replying/etc. (for auto locks)
+	b) The user clicks the Unlock link
+	c) The user logs out
+	d) A configurable expiry period has elapsed
+
+- When a user clicks the "Take" link for an RTIR Incident ticket, a lock is added. This lock is a special case, and will
+  be removed when the Incident is linked to a new or existing Investigation.
+
+- When a user locks a ticket (auto lock or hard lock), they are given a notification informing them of their lock.
+
+- When a user unlocks a ticket (auto unlock or hard unlock), they are given a notification informing them that their
+  lock has been removed, and how long they had the ticket locked for.
+
+- When a user accesses a page for a ticket that they have locked, they are presented with a notification informing them
+  that they have the ticket locked, and how long they have had the ticket locked.
+
+- When a user accesses a page for a ticket that has been locked by another user, they are given a notification of the
+  other user's lock, with the locking user's name and how long they have had it locked for.
+
+
+
+
+-----------
+Optional frills
+-----------
+
+Lock display portlet for homepage (display all of your locks)