Document Lock - Plugin

Document created by Ryan Rutan on Dec 21, 2010Last modified by max.calderon on Dec 16, 2013
Version 20Show Document
  • View in full screen mode


Retrofits aspects of lock-based collaboration onto SBS documents, with an emphasis on lock visibility/awareness over absolute enforcement.


Note:  It is quite difficult to enforce a persisted (non-session-based) Lock, like a Source-Control system, as a plugin given the current state of SBS.   Instead this plugin focuses on the ability to offer a social process to help people coordinate better when collaborating on Documents.


The Document Lock Plugin is plugin derived from much of the requirements/desires around the following idea:

Feature Request - Collaborative Document Locking (a.k.a. Document Check-Out)

Document Lock - Video Walk-Through


Official plugin of The specified item was not found.



Plugin install through Admin Console, with 1 additional manual step.  Visit the Admin Console > Settings > Configure Document Locking section for more detailed setup instructions.

*Note:  Requires minor customization of the /template/docs/document.ftl Template



  • 1.0.0 - January 5, 2011 (SBS < 4.5.6)
  • - April 7, 2011 (SBS < 4.5.6)
  • 1.0.1 - Jan 23, 2012 (SBS 4.5.7+)
  • 1.1.0 - July 6, 2011 (SBS 5.0.0+)
  • 1.1.0 - March 6, 2013 (SBS 6.0.0+)



System Administrators will find a configuration interface in the following Admin Console location:   Admin Console > Settings > Configure Document Locking

Container Admins (if authorized) will find their configuration interface in the Actions Menu on their Overview Page:  Container > Overview Tab > Actions Menu > Manage Section > Configure Document Locking


Plugin Support

This plugin IS NOT supported by Jive, and use of this plugin should be done at the user's discretion, or as advised by their Jive Support representative.

Copyright and License

Copyright 2012 Ryan Rutan under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License


  • System Admin / Container Admin Configuration Screens
    • Note: Some permutations of Global Off + Specific Group On require the use of tools like the Admin Essentials Plugin to mark Groups / Projects with the necessary configurations parameters.
    • Configure Global On/Off - (System Admin ONLY)
      • Global Turn On, with Container Specific Disable
      • Global Turn Off, with Container Specific Enable
    • Configure Ability for Container Admins to Control Document Lock Behavior for their Container (System Admin ONLY)
      • Spaces, Projects, and Social Groups
    • Configure Lock Stomp Detection Emails
      • see Lock Stomp Detecton Emails (below)
      • Configure format and content of the Lock Stomp Email via the Message Templates Admin Section (System Admin ONLY)
    • Configure Document Lock Expiration Duration
    • Configure Show In-line Help Feature
    • Configure Unlock on Publish Feature
      • Automatically remove the Document Lock when the Lock Owner publishes a new version
    • Configure Hide Edit Links
      • When Enabled, Document Lock will hide the Edit links for Users that are not the Lock Owner
  • Lock a Document (same experience for Upload/Collaborative Docs) (blue)
    • (optional) Comments can be left on the lock to tell others why the lock occurs
    • Friendly Date duration displayed (i.e. 4 hours ago) alongside the Lock Owner (link to profile provided)
    • See the person who has the Lock (link to profile)
    • Color coded UI to catch attention
    • Lock Status Updated Dynamically (no full page loads)
    • If Lock-Collision Occurs
      • UI  displays the Existing Lock Information and updates UI accoringly for the one who has the lock (see Unlock a Document) and the one who does  not (see Document is Locked)
        • This happens when 2 people are viewing an Unlocked Document....and both try to Lock at the same time
  • Unlock a Document (green)
    • Uploaded FIles

      • Link provided to download the most recent document
      • File Upload input for easy 1-click upload of a new file
      • On submit, your lock is removed (configurable, see  above)
      • If  you choose to Edit the Document via the standard Jive UI....your Lock  is removed for you automatically when you Publish (configurable, see  above)
    • Collaborative Docs
      • Unlock button provided (status updated via AJAX, no full page load)
      • When  you edit the Document via the standard Jive UI....your Lock  is removed  for you automatically when you Publish (configurable, see  above)
  • Document is Locked (red)
    • See Read-Only Comments (if available) for the Lock
    • See the friendly date duration of the Lock
    • See the person who has the Lock (link to profile)
    • For Container Admins and System Admins ONLY
      • Remove Link is provided to purge the lock in the event you need to intervene
  • Lock Stomp Detection Emails (configurable, see above)
    • Because  this plugin does NOT (and will NEVER) enforce the DocumentLock at a  low-level, these emails detect when someone (that is not a current Lock  Owner) makes an edit to the existing document.
      • Emails are sent to  both the Lock Owner and Lock Stomper, detailing when the stomp  occurred, on what document, and who the stomper was.




What a user sees when a document is AVAILABLE, (Note: The user does not have to Lock the document to edit)

Screen shot 2010-12-17 at 4.34.04 PM.png

What the Lock Owner sees (Collaborative Documents)

Screen shot 2010-12-17 at 4.34.49 PM.png


What the Lock Owner sees (Uploaded Documents)

Screen shot 2010-12-17 at 4.39.53 PM.png

What Other Users see when a Document is Locked (notice the Edit Links are gone)

Screen shot 2010-12-17 at 4.37.02 PM.png
What Other Users see when a Document is Locked (notice the Edit Links are gone),

but they are a Group/System Admin so they have the option to Remove the Lock.

Screen shot 2010-12-17 at 5.16.34 PM.png

Container Admin Document Lock Configuration Screen

Screen shot 2010-12-21 at 2.19.34 PM.png