Attachment Checkout Plugin

Name Attachment Checkout Plugin
Vendor Atlassian Developer Network (Website)
Authors Amit Singh, Shaikh Riyaz
Homepage http://confluence.atlassian.com/display/CONFEXT/Attachment+Checkout+Plugin
Issue Management http://developer.atlassian.com/jira/browse/CHKOUT
Continuous Integration n/a
Categories Administration
Most Recent Version 2.0-dr01
Availability Confluence v2.8.0 to v2.10-m1
State Beta
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs n/a
Java API Docs n/a
Download Source n/a
Download JAR plugins-checkout-2.0-dr01.jar
Attachment Checkout Plugin version 2.0-dr01 is designed to work in cluster environment.

Compatibility With Confluence

Plugin Version 2.5.1 2.5.4 2.6.x 2.7.x 2.8.x 2.9 2.10-m1 2.10-m2 Tested Jars
1.0.0 Shaikh Riyaz plugins-checkout-1.0.0.jar
1.0.2 Shaikh Riyaz plugins-checkout-1.0.2.jar
1.0.3 Shaikh Riyaz plugins-checkout-1.0.3.jar
1.0.4-dr02 Shaikh Riyaz plugins-checkout-1.0.4-dr02.jar
2.0-dr01 Shaikh Riyaz plugins-checkout-2.0-dr01.jar

Download statistics

Date 2008-Jun 2008-Jul 2008-Aug 2008-Sep 2008-Oct 2008-Nov 2008-Dec
Hits 143 184 185 142 157 121 8

Installation

At this point the plugin is not upgrading using Confluence Plugin Repository so you'll need to install it by uploading it manually to Confluence:

In the 'Administration' section of Confluence, click the Plugins link.
Click on the 'Upload' tab.
Use the 'Browse' button to find the plugin-checkout-VERSION.jar (you did download it, right?)
Select the jar file and click 'Open'.
The plugin will be uploaded from your machine to Confluence, and will be automatically installed.
*If anyone would like to modify it so that it is available via the Repository, have at it!

Description/Features

  1. Adds basic check-out/check-in functionality to Confluence attachments.
  2. Admin functionality is implemented to Undo Check-out for all the checked-out files for given space. This is permission based functionality where Confluence admin holds default permission to Undo Check-out and Space admin can provide undo checkout permissions for Individual and/or group of users. This functionality is available under Advanced tab. Screenshots is available here
  3. Automatic Undo Check-out functionality is implemented.
    Aim of this functionality to overcome a problem which occur when some one checked-out a file and forget to check-in/ Undo checkout.
    This problem may lead to restrict check-in for specific user and violate the concept of Knowledge management.
    Automatic Undo Check-out functionality will cancel the checkout.
    This cancellation is done on the basis of the lapsed time period set by the space admin.
    Plug-in will send reminder mail to user who have checked-out the file and not checked-in in the scheduled time period set by administrator.
    Every after reminder mail user have not check-in/ Undo check-out , then plug-in will take care to Undo Check-out on schedule time period set by administrator followed by a notification mail to user saying "Checkout of files listed below has been cancelled by Admin. This cancellation is done on the basis of the lapsed time period set by the administrator".This functionality is available under Space Admin tab. Screenshots is available here

    Plugin Versions

    Version Date State License Price
    Show description 2.0-dr01 (#10) 11 Sep 2008 Beta Freeware / Open Source (BSD) Free

    Contributors

    Show description 1.0.4-dr02 (#9) 11 Sep 2008 Beta Freeware / Open Source (BSD) Free

    Contributors

    Show description 1.0.4-dr01 (#8) 07 Jul 2008 Beta Freeware / Open Source (BSD) Free

    Contributors

    Show description 1.0.3 (#7) 07 Jul 2008 Stable Freeware / Open Source (BSD) Free

    Contributors

    Show description 1.0.2 (#6) 19 Mar 2008 Stable Freeware / Open Source (BSD) Free

    Contributors

    Show description 1.0.0 (#4) 30 Oct 2007 Stable Freeware / Open Source (BSD) Free

    Contributors

    Show description 0.0.94 (#4) 30 Oct 2007 Stable Freeware / Open Source (BSD) Free

    Contributors

    Show description 0.0.93 (#3) 10 Sep 2007 Beta Freeware / Open Source (BSD) Free

    Contributors

    Show description 0.0.92 (#2) 10 Sep 2007 Beta Freeware / Open Source (BSD) Free

    Contributors

    Show description 0.0.91 (#1) 08 Aug 2007 Beta Freeware / Open Source (BSD) Free

    Contributors

Support

This plugin was written to meet the needs of a particular company and then released to the Confluence Developer Community as open source for further development/enhancement. We'll try to address issues that affect our installation as quickly as possible. We'll also make changes to the plug-in as our environment changes. (For example, right now we're on v2.5.4 with no planned upgrade in sight. Any issues relating to upgrading will be low on our list until we're ready to upgrade.)

We apologize for any inconvenience that this may cause but we don't have the resources to maintain this for every possible installation, yet we saw enough community demand for it to release it open source. We encourage everyone to continue to use the issue tracker that's been set up by Atlassian and for any developer that would like to enhance/upgrade it, have at it. (Actually, what we'd really like to see is Atlassian incorporate it as standard!) Thank you for understanding.

Issue/Request Tracker

Screenshots

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jul 19, 2007

    Bob Swift says:

    Nice! Something people have been looking for! Thanks.

    Nice! Something people have been looking for! Thanks.

    1. Jul 19, 2007

      Peter R. says:

      You're welcome! We'll be putting out some more as we develop them for internal u...

      You're welcome! We'll be putting out some more as we develop them for internal use.

  2. Jul 19, 2007

    Jonathan Nolen says:

    Hi Peter, I can give you a JIRA project if you want. And be sure to put this int...

    Hi Peter, I can give you a JIRA project if you want. And be sure to put this into the Confluence Plugin Repository so it can installed on the fly.

    1. Jul 19, 2007

      Peter R. says:

      That'd be great, thanks! I'll get it in the repository soon as I teach myself ho...

      That'd be great, thanks! I'll get it in the repository soon as I teach myself how to do so. If programming's involved I'll have to get my developers to do it; I'm just the "face" of the team.

      1. Jul 20, 2007

        Guy Fraser says:

        You'll need to add the XML data to the repository on Atlassian's servers - give ...

        You'll need to add the XML data to the repository on Atlassian's servers - give Jonathan Nolen a shout and he should be able to help out.

        1. Jul 21, 2007

          Peter R. says:

          I added it as an issue for the project so if Jonathan wants to hit it that'd be ...

          I added it as an issue for the project so if Jonathan wants to hit it that'd be cool. If not we'll get it figured out in the coming days.

  3. Jul 19, 2007

    Joshua Wold says:

    Sounds great!  This should be really useful.

    Sounds great!  This should be really useful.

  4. Jul 19, 2007

    David Soul [Atlassian] says:

    Awesome!

    Awesome!

  5. Jul 19, 2007

    David Soul [Atlassian] says:

    1) Spoke too soon - checkins are broken for me When I check in a document, the ...

    1) Spoke too soon - checkins are broken for me When I check in a document, the new file is uploaded fine as harbour.jpg?version=2. However, after the upload, links to harbour.jpg actually shows the content from version 1.
    This means that anyone linking to harbour.jpg will not see my checked-in update. Also, the document is still actually listed as checked out and I can't get it to check back in. I'm using Confluence 2.5.4

    2) When I checkout a document, it'd be great if it downloaded it

    1. Jul 21, 2007

      Peter R. says:

      Hmm, that's curious, we've been using it in our production environment for abo...
      1. Hmm, that's curious, we've been using it in our production environment for about three weeks now and haven't experienced this. I'll try a jpg here and see if that acts different than the documents we've been using.
      2. Already on our feature request list!
      1. Jul 21, 2007

        Peter R. says:

        I was unable to duplicate the issue here. My picture uploads were properly recog...

        I was unable to duplicate the issue here. My picture uploads were properly recognized. Open an issue with your particulars and hopefully we can figure it out.

        1. Jul 23, 2007

          David Soul [Atlassian] says:

          No prob, I'll test it again when I get time to revisit and log a proper bug repo...

          No prob, I'll test it again when I get time to revisit and log a proper bug report now that your issue tracker is up

          1. Nov 06

            John Reynolds says:

             We had the same issue recently and appears as though it may be a caching i...

             We had the same issue recently and appears as though it may be a caching issue, with the browser (in out case Firefox) going and grabbing the cached version of the attachments rather than the actual document.

             Not sure if there's anything that can be done about that, though.

            Sláinte,

            John

  6. Jul 20, 2007

    Collin Summers says:

    Any plans to expose this via the WebDav plugin?   It would be great to...

    Any plans to expose this via the WebDav plugin?   It would be great to allow WebDav to lock a file while it is open.

    Thanks for building this... 

    1. Jul 20, 2007

      Jonathan Nolen says:

      The whole WebDAV locking thing is a different ball of wax. That issue is being t...

      The whole WebDAV locking thing is a different ball of wax. That issue is being tracked here: http://developer.atlassian.com/jira/browse/WBDV-44

  7. Aug 15, 2007

    Lehky, Miro says:

    This is a fantastic start on a much needed capability.  My only concern is ...

    This is a fantastic start on a much needed capability.  My only concern is that in some space this is not needed.  Ideally we should be able to specify/configure each space or possible page to use either the attachment plugin or the check-in/check-out plugin as appropriate for the usage of that space or page.  Right now this seems to be an all or nothing.

    1. Aug 23, 2007

      Peter R. says:

      Yes, it's all or nothing. From what I understand it's much more complicated to e...

      Yes, it's all or nothing. From what I understand it's much more complicated to enable this on a space by space basis.

      We've got 140+ Spaces and 6700+ users in our Confluence instance, a good portion of which don't really need the check-out capability, and no one has complained that it's there. I think it's one of those "they'll use it if they need it, they'll ignore it if they don't" type of things.

      If you'd like it to be considered for a future update, please add it to the issue log. Thank you.

      1. Aug 31, 2007

        Lehky, Miro says:

        Peter, the more I play with the the more I agree.  It if you simply dont ch...

        Peter, the more I play with the the more I agree.  It if you simply dont check out attachments it really is quite invisible.

        Miro

      2. Sep 14, 2007

        Lehky, Miro says:

        Peter I just realized the usage mode where this could get to be annoying for us...

        Peter

        I just realized the usage mode where this could get to be annoying for users. I see the attachment feature having to usage models.

        1.In many spaces the attachments are files that are being received from a 3rd party (is documentations for 3rd party applications for example) and then simply being posted in the space.

        2. In other spaces/pages attachments are truly files that are going through an editing processes thus need to be checked out.

        In the case of the first model i agree it not to bad to click check out, and then check the newly received file right back in. But looking at the issues for the plug-in I noticed that an enhancement was made to automatically download the file when it is marked for check out. This will definetly get annoying. (CHKOUT-3).

        Would it be possilble that when the file in not in the Checked Out state for the option to be "Checkout | Upload | Edit | Remove" thus giving the user the option to upload a new file without checking out and being forced to download the file.

        Regards

  8. Aug 17, 2007

    Preston Tollinger says:

    Is work continuing on this plugin?  Do we have an ETA to leave beta?

    Is work continuing on this plugin?  Do we have an ETA to leave beta?

    1. Aug 23, 2007

      Peter R. says:

      Work is continuing. We've just configured it to be recognized by the Confluence ...

      Work is continuing. We've just configured it to be recognized by the Confluence Plugin Repository and are implementing a couple of suggestions. .92 should be out shortly. Still beta but, with no negative reports back, we'll flip it to stable for .93.

      Thanks!