EditGrid Plugin - Edit Spreadsheet in Confluence

Name EditGrid Plugin
Version 2.2.5
Supported Confluence Versions Confluence 2.6 - 2.8.1
Author(s) EditGrid.com
Categories External Content
Homepage http://www.editgrid.com/
Price Pricing
License Commercial
Contact sales@editgrid.com
JavaDocs
IssueTracking http://developer.atlassian.com/jira/browse/GRID
Download JAR editgrid-confluence-plugin-latest.jar
(click here to obtain an evaluation key)
Download Source

EditGrid on Confluence

EditGrid is an online spreadsheet technology that lives solely in the web browser – no browser plugin or Flash required. The EditGrid Plugin for Confluence allows real-time collaboration on spreadsheets in Confluence.

With EditGrid on Confluence, you can insert a spreadsheet onto a Confluence page. You can even edit the spreadsheet collaboratively – at the same time with other Confluence users with the right permission. The spreadsheet is then saved as an attachment to the Confluence page in Microsoft Excel format, allowing Confluence to manage its revision history.

There are two modes: view mode and edit mode. In view mode (see more below), users can view the spreadsheet in HTML format with configurations available to allow sorting and auto-filter of the data. In edit mode (see more below), the spreadsheet can be edited with the EditGrid spreadsheet editor. It also allows multiple users to edit the same spreadsheet at the same time with changes propagated to all concurrent editors in real-time.

EditGrid Confluence Plugin supports multiple modes of deployment at your option. For Confluence licensing customers, EditGrid Confluence Plugin is available in two versions:

  • Standalone Version – shipped with a trimmed-down version of the EditGrid Server tailored for Confluence customers. Supports Ubuntu Linux 6.06 (Server Edition), Red Hat Enterprise Linux 5, CentOS 5.1, or any compatible virtual machine.
  • Hosted Version – connects to the EditGrid Server hosted on our infrastructure at editgrid.com. The spreadsheets are still stored on your intranet (as attachments to Confluence pages), but will be sent to and hosted at editgrid.com temporarily while being edited or displayed.

More details here.

Furthermore, Confluence Hosted and Confluence Enterprise Hosting customers can use EditGrid on Confluence without any additional installation – the plugin is by default enabled by Atlassian there.

Latest News

Version 2.2.5 released
  • Updated plugin key.
Version 2.2.4 released
  • Useful links and more user-friendly error messages at the EditGrid Plugin Configuration page.
  • Fixed two instances of exceptions arising respectively from re-initialisation of the EditGrid Server database and outage of EditGrid Server.
Version 2.2.3 released
  • Fixed malfunctioning of EditGrid Frame configuration parameters save width and height.
  • Forced API method calls under HTTP/1.0 for compatibility reasons.
Version 2.2.2 released
  • Various bug fixes on plugin configuration.
Version 2.2.1 released
  • Various enhancement and bug fixes on plugin configuration, error handling and error messages.
Version 2.2.0 released
  • Initial support for Standalone Version.
  • Overhauled the SOAP API communication protocol with EditGrid Server.
  • Added license key support.
  • Better error handling and more user-friendly warning and error messages.
Version 2.0 series released
  • Added tab switch for viewing spreadsheet.
  • Changed the "Add Spreadsheet" link to add macro to current page instead of creating a new page.
  • Changed to edit spreadsheet inline.
  • Added configuration for the EditGrid frame.
  • Allowed real-time collaboration.
  • Added Confluence 2.7 support.
  • More robust attachment management.
  • Disabled viewing and editing spreadsheet on past revisions.

Installation

Please refer to the EditGrid Confluence Plugin Installation Guide.

Usage

Getting Started

To create a new spreadsheet, click on the "Add Spreadsheet" link. The system will then ask you to input a name for the new spreadsheet, input the name in the text field and click "Save and edit spreadsheet", the spreadsheet is created and you can start editing the spreadsheet right away.

EditGrid supports real-time update, i.e. the system saves your changes on the spreadsheet automatically, and other users will see all the changes at real-time, too. However, the changes will not be posted to your Confluence page until you click on the [Save] button. If you have made changes but do not want to reflect the changes onto your Confluence page, click on the [Quit] button (note that changes will still be saved in the spreadsheet).

You could also configure the look and feel of the spreadsheet displaying on the Confluence page. Simply click on the [Configure] button while you are viewing the spreadsheet, configure settings and click on the [Submit] button. Changes will be stored and reflected on the Confluence page immediately.

Note: Since EditGrid supports real-time collaboration, more than one person could be working on the same spreadsheet at the same time. So for example, Amy and James are both working on the same spreadsheet at the same time, Amy made some changes but decided not to post it on the Confluence page so she clicked [Quit]. At the same time, James made some changes on the same spreadsheet and decided he wants to post it on the Confluence page so he clicked [Save]. Because Amy's changes has immediately been stored on the spreadsheet alongside James' changes, both changes from Amy and James will now be posted on the Confluence page, all because James clicked [Save] after Amy's changes has been done.

Adding a Spreadsheet

There are two ways to add a spreadsheet onto a Confluence page. The first way is to click on the "Add Spreadsheet" link. This will then bring you to a new screen where you are asked to key in the following information for the new spreadsheet:

  • Source of the spreadsheet. Choose any one of the following options:
    • Import an Excel Spreadsheet - attach an existing MS Excel spreadsheet onto your Confluence page. Pick the file using the [Browse...] button.
    • Start from a new, blank spreadsheet. Give it a name in the textbox under "Start a new spreadsheet, give it a name". NB: The extension ".xls" will be automatically appended if it is omitted. So if you name your new spreadsheet "My new spreadsheet", it will be referred to as "My new spreadsheet.xls" in Confluence from this point onwards.
  • Display size of the spreadsheet. Specify how much space on your Confluence page would you would like to assign to the EditGrid Frame. You will be able to change it later on using the [Configure] button.
  • Insertion point of the new spreadsheet. Specify where would you like to place the EditGrid Frame on the Confluence page. You will be able to change it later on by editing the Confluence page.

Click [Create and edit spreadsheet] or [Create spreadsheet] after completing the above. This will then create an {editgrid} macro on your Confluence page at the designated insertion point. You will now be able to edit the spreadsheet using the [Edit] button.

The second way to add a spreadsheet is to directly key in an {editgrid} macro on the Confluence page's Wiki Markup. See the section The EditGrid Macro below.

The EditGrid Frame

Once you have added a spreadsheet to your Confluence page, you'll see a frame added to and displayed on your Confluence page. The EditGrid Frame has two modes: view mode and edit mode.

View Mode

The following is an illustration of the view mode (default):

Here is an overview of the functions available in view mode:

  • Export button: export the latest version of the spreadsheet attachment as a file.
  • Name: name of the spreadsheet given at the time of adding it to the Confluence page, or interpreted from an existing file.
  • Configure: configure the settings of the EditGrid Frame. See more below.
  • Edit: enter edit mode.
  • Print: export the latest version of the spreadsheet attachment into a printer-friendly format in a new browser window or tab for your easy printing.
  • Static view: a static view of the latest version of the spreadsheet attachment.
  • Sheet navigation: navigate across multiple sheets. Use the scroll buttons at the leftmost and rightmost to scroll if there are too many sheets to display.

Edit Mode

Once you've clicked on the [Edit] button, you'll enter edit mode, which looks like this:

Here is an overview of the functions available in edit mode:

  • Export button: export the latest version of the spreadsheet attachment as a file. NB: unsaved changes in the current editing session are not exported.
  • Name: name of the spreadsheet given at the time of adding it to the Confluence page, or interpreted from an existing file.
  • Save: save all changes in the current editing session to a new revision of the spreadsheet attachment.
  • Quit: quit the current editing session and ignore all unsaved changes. IMPORTANT: the unsaved changes are ignored but not abandoned immediately. Other Confluence users may, if they have the right permission to the Confluence page, continue your editing session and elect to save the editing session anyway.
  • Menu bar: the EditGrid menu bar. See more below.
  • Tool bar: the EditGrid tool bar. See more below.
  • Grid area: the live spreadsheet which allows you to edit. Editing sessions have real-time update ("RTU") enabled, which means that if another Confluence user, who has the right permission, is also in edit mode of the same spreadsheet, you'll be able to see all changes made by that user in real-time on your live spreadsheet, and vice versa.
  • Status bar: the EditGrid status bar, which shows the current status of the editing session. Pay attention to the status LEDs at the leftmost of the status bar, since they indicate whether your last changes have been submitted to the server successfully. The LEDs have the following status available:
    • Green: all fine.
    • Blue and amber: changes are being submitted to/received from the server. NB: the "Saving..." status merely indicates that the changes are being "saved" to the editing session on server; it does not indicate that the changes are being saved to the spreadsheet attachment. To save your changes in the current editing session to the spreadsheet attachment, use the [Save] button at the top-right corner of the EditGrid Frame.
    • Amber: changes are being processed in server. NB: you may lose your changes if you quit your editing session or the browser while the status LED is still in amber.
    • Red: some changes have failed.

Configuring the EditGrid Frame

The following parameters are available for you to configure the display of the EditGrid Frame:

  • Show grid lines: whether to show the spreadsheet's grid lines or not in view mode.
    Wiki Text parameter: gridline=0|1(default)
  • Show row header: whether to show the spreadsheet's row header or not in view mode.
    Wiki Text parameter: rowheader=0(default)|1
  • Show column header: whether to show the spreadsheet's column header or not in view mode.
    Wiki Text parameter: colheader=0(default)|1
  • Enable sorting by column: here you can enable sorting on a by-column basis in view mode.
    Wiki Text parameter: sort=0(default)|1
  • Enable filtering: here you can enable auto filter in view mode.
    Wiki Text parameter: filter=0(default)|1
  • Show charts and images: whether to show charts and images or not in view mode.
    Wiki Text parameter: sheetobject=0|1(default)
  • width: width of the EditGrid Frame when displayed on the present Confluence page. Support either absolute measurement (in pixels) or proportional measurement (in %).
    Wiki Text parameter: width=NNNpx|MM%
  • height: width of the EditGrid Frame when displayed on the present Confluence page. Support either absolute measurement (in pixels) or proportional measurement (in %).
    Wiki Text parameter: height=NNNpx|MM%

The EditGrid Macro

The EditGrid Frame is displayed on your Confluence page because of the placement of the {editgrid} macro at the designated insertion point. The {editgrid} macro looks like this in Wiki Markup:

{editgrid:filename=expense.xls}

You can place it anywhere on the Confluence page as you please. You can even add a new spreadsheet to the page by inserting the {editgrid} macro anywhere on the page.

The {editgrid} macro accepts configuration parameters; these are outlined in the Configuring the EditGrid Frame section above. For example, the following Wiki Markup:

{editgrid:filename=expense.xls|width=100%|height=300px|filter=1}

would place on the Confluence page an EditGrid Frame opening the attachment expense.xls, of width 100% and height 300 pixels, with auto filter enabled in view mode.

NB: the filename parameter is mandatory and must be suffixed by the file extension ".xls". If the attachment is not found on the present Confluence page, it will be automatically created.

The EditGrid User Interface

EditGrid has an Microsoft Excelâ„¢ like interface to ease your pain to learn how to use a new application:

For seasoned Excel users, keyboard shortcuts work here as well. Try Ctrl+C, Ctrl+X and 50 other common keyboard shortcuts.

Standard Spreadsheet Features

Cut-and-paste, sorting, charts, auto-fill, cell border, number formatting, cell formatting, find and replace, undo, redo, freeze pane, text overflow, auto-fit row/column size, word warp, cell comments, 500+ functions ... You name it, EditGrid has it.

Administration

Configuration

Please refer to the EditGrid Confluence Plugin Installation Guide for details of the configuration parameters on the "EditGrid Plugin Configuration" page under the administration console.

Proxy setting

In the current version of EditGrid plugin, it will make web requests to remote servers in order to process the spreadsheet file. If you find that the {editgrid} macro does not work, ask your network administrator if Confluence needs to access the Internet through a web proxy.

Please refer to Configure Web Proxy Support for Confluence for further information.

Support

Your feedback is paramount to us to improve EditGrid on Confluence.

Version History

Version Date
2.2.5 11th June, 2008
2.2.4 6th June, 2008
2.2.3 11th April, 2008
2.2.2 8th April, 2008
2.2.1 2nd April, 2008
2.2.0 31st March, 2008
2.0.3 12th March, 2008
2.0.2 4th March, 2008
2.0.1 15th January, 2008
1.1.2 25th October, 2007
1.1.1 8th August, 2007
1.1 4th July, 2007
1.0 13th May, 2007

Version Compatibility

The latest version of the EditGrid Plugin is version 2.2.5, released on 11th June, 2008. Confluence versions 2.6.0 - 2.8.1 are tested and supported.

Support for previous versions of the EditGrid Plugin have been deprecated. Please upgrade your plugin and Confluence as early as possible.

EditGrid Version Confluence Version Java Version Compatible
2.2.5 2.6.0 - 2.8.1 1.4 - 1.5
2.2.4 2.6.0 - 2.8.1 1.4 - 1.5
2.0.2 - 2.2.3 2.6.0 - 2.7.3 1.4 - 1.5
2.0.1 2.6.0 - 2.6.2 1.4 - 1.5
1.1.2 2.3 - 2.6.2 1.4
1.1.1 2.3 - 2.5.3 1.4
1.1 2.3 - 2.5.3 5.0
1.0 2.5.1 5.0
1.0 2.3.3 5.0

Note:

The Hosted Version of EditGrid Confluence Plugin interacts with an external web service, EditGrid. The data in your spreadsheet will be sent over the internet to EditGrid's servers. If you have any concerns regarding this, feel free to contact us at sales@editgrid.com.

Labels

license license Delete
hosting hosting Delete
enterprise enterprise Delete
hosted hosted Delete
spreadsheet spreadsheet Delete
editgrid editgrid Delete
plugin plugin Delete
macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. May 14, 2007

    Derek Nicol says:

    Very cool plugin. Any idea when it will no longer be beta and what the pricing m...

    Very cool plugin. Any idea when it will no longer be beta and what the pricing model will be?

  2. May 20, 2007

    David Soul [Atlassian] says:

    What version of Confluence are you running? I recommend upgrading to 2.5.1 if yo...

    What version of Confluence are you running? I recommend upgrading to 2.5.1 if you are running an older Confluence version or reporting this problem directly to EditGrid at http://forum.editgrid.com/viewforum.php?id=5

  3. May 22, 2007

    jd lima says:

    In your example, {editgrid:filename=expense.xls} where is .xls saved? on the ...

    In your example,

    {editgrid:filename=expense.xls}
    where is .xls saved? on the filesystem? in the database? page metadata?

  4. May 24, 2007

    Mark says:

    I'm running 2.5.1 and the plugin does not appear in the repository, nor do I see...

    I'm running 2.5.1 and the plugin does not appear in the repository, nor do I seem to be able to upload the .jar file directly.

    It just hangs the plugin upload screen forever.

    Scratch that! I logged out and back in, now it's there.

    So manual loading works, but it's not in the ATL repository for some reason. 

  5. May 24, 2007

    Mark says:

    I have successfully created a spreadsheet  test.xls via the Add Content ...

    I have successfully created a spreadsheet  test.xls via the Add Content | attach spreadsheet link
    (Please note if you use a custom template you will not see a tab, you must go to Add Content)

    But upon creation of spreadsheet I get a blank confluence page.

    I then go into the server via webdav and edit the spreadsheet, adding new data.
    The new data in the spreadsheetshows up on the confluence page fine

    When I go to Edit the spreadsheet, I get a blank page again.

    I can edit via Webdav, but not via Confluence/Editgrid Edit Spreadsheet button
     

  6. Jun 15, 2007

    Mark says:

    Can anyone confirm viewing spreadsheets in 2.5.3 and up? I can't see anything a...

    Can anyone confirm viewing spreadsheets in 2.5.3 and up?

    I can't see anything and am wondering if it's my install or if this is buggy?       

  7. Jun 16, 2007

    William Hayes says:

    It worked for me using 2.5.4. It's a bit buggy on cursor movement and it doesn'...

    It worked for me using 2.5.4. It's a bit buggy on cursor movement and it doesn't show the table unless you are actively editing it. However, if the kinks can get worked out of this - I'd be happy to pay for it.

  8. Jun 29, 2007

    David Lee says:

    Hi Guys, First of all, my terribly sorry for my late reply to this thread. A lo...

    Hi Guys,

    First of all, my terribly sorry for my late reply to this thread. A lot has happened in the last few weeks, including we've successfully raised our series A round funding. We will definitely keep improving our product and the confluence plugin!

    The bugs reported are already fixed in our development. We'll upload the plugin next week (week of July 2) after some more testing. Sorry for keeping you waiting.

    Re: Price - We'll only think about the pricing after the plugin is good enough. The price should be an affordable one.

    Re: Storage - The file is stored in your server, but when the online spreadsheet is loaded, the data is temporarily sent to our server for calculations.

    Should you have any further enquiry, kindly email me directly. My email is: david at tnc dot hk.

    Thank so much for trying our our confluence plugin!

    David
    EditGrid Team

    1. Jun 30, 2007

      Egon Kuster says:

      Re: Storage - The file is stored in your server, but when the online spreadsheet...

      Re: Storage - The file is stored in your server, but when the online spreadsheet is loaded, the data is temporarily sent to our server for calculations.

      My confluence instance runs on a seperate network not connected to the Internet so I am interested to know why data is send temporarily back to the server for calculations and why that can not be calculated in the confluence instance?

      I am sure that there would be other customers a little worried about data being sent to another persons servers.

      1. Jun 30, 2007

        David Lee says:

        Hi Egon, The backend calculation engine of EditGrid is written in C, thus there...

        Hi Egon,

        The backend calculation engine of EditGrid is written in C, thus there are no trivial way to port it to Java. We are still investigating whether there are any possible ways though.

        At the moment, when you open the spreadsheet file for editing, it will send the data to EditGrid.com through a secure channel (SSL) and after you've finished editing, the file is exported and save to your server.

        We fully understand some customers would have concern about sending the data out to other servers, so in the future we will also provide an licensing option of EditGrid software. You can then connect your confluence plugin with your internal EditGrid.

        1. Jul 01, 2007

          Egon Kuster says:

          Ah I see, pity. When you do create a version that does not require external acce...

          Ah I see, pity. When you do create a version that does not require external access you will still need to provide a trial version otherwise users like myself will not be able to test out the capability before purchase.

          Keep up the good work.

          1. Jan 17, 2008

            P. K. Chan says:

            Hi Egon, We will launch EditGrid Confluence Plugin coupled with a trimmed-down ...

            Hi Egon,

            We will launch EditGrid Confluence Plugin coupled with a trimmed-down version of the EditGrid Server soon in 2008 Q1. If you are interested in it and would like to have more details, drop us an email at sales@editgrid.com .

            Yours,

            P. K.
            The EditGrid Team

  9. Jul 05, 2007

    Luci says:

    It doens't seem to work for me (Confluence v.2.5.4). After clicking Edit, no tab...

    It doens't seem to work for me (Confluence v.2.5.4). After clicking Edit, no table is shown.

    It is important to be able to edit/display the file from another page. Can that be implemented?

    1. Jul 05, 2007

      David Lee says:

      Hi Luci, Can your Confluence installation access to the internet? The plugin ne...

      Hi Luci,

      Can your Confluence installation access to the internet? The plugin need to depends on EditGrid.com for the spreadsheet interface library and calculation.

      David
      EditGrid Team

      1. Jul 10, 2007

        Luci says:

        Yes, the server where our Confluence installation resides has access to int...

        Yes, the server where our Confluence installation resides has access to internet. I will try to manually allow access to EditGrid.com page and see what happens. Maybe just a security issue. Thank you.

        1. Jul 10, 2007

          Luci says:

          Tried, but still no success. Is it a specific link to the necessary libray?

          Tried, but still no success. Is it a specific link to the necessary libray?

          1. Jul 11, 2007

            Chiu says:

            Hi Luci, Confluence v 2.5.4 is already bundled with the necessary library. Have...

            Hi Luci,

            Confluence v 2.5.4 is already bundled with the necessary library.
            Have you tried the proxy setting described above?

            You may found more details on Configure Web Proxy Support for Confluence.

            Chiu
            EditGrid Team

            1. Aug 23, 2007

              Shu Ping says:

              Tried, but still no success. The self-contained plugin will be much easier and b...

              Tried, but still no success. The self-contained plugin will be much easier and better to manage.

  10. Jul 08, 2007

    Hitesh Seth says:

    David/EditGrid Team, Have you guys thought about creating a self-contained Edit...

    David/EditGrid Team,

    Have you guys thought about creating a self-contained EditGrid plugin, basically a plugin which will not depend on the EditGrid.com site, kind of like the Gliffy Plugin. This would make the plugin very useful from using within an enterprise.

    Thanks

    Regards

    Hitesh

  11. Jul 24, 2007

    Alex Szabados says:

    Hey, can you guys add an option to make textoverflow enabled when you render the...

    Hey, can you guys add an option to make textoverflow enabled when you render the sheet? (it's one of the basic options you can toggle within editgrid) Right now a lot of my text is being cut off once it exits the cell, because by default textoverflow is off!

    I would greatly greatly appreciate it .

    1. Jan 17, 2008

      P. K. Chan says:

      Hi Alex, You can enable/disable text overflow under the View menu at the menu b...

      Hi Alex,

      You can enable/disable text overflow under the View menu at the menu bar.

      Yours,

      P. K.
      The EditGrid Team

  12. Jul 25, 2007

    Alex Szabados says:

    Hey, I am also having problems with it rendering (rendering period, *nothing...

    Hey, I am also having problems with it rendering (rendering period, *nothing* shows up) many pages.

    I have attached an example.

    The editgrid program itself has no problems rendering this file, just the plugin that renders the thing on the page.

  13. Jul 30, 2007

    Derek Nicol says:

    As someone suggested above, it will be important for this plugin to be self cont...

    As someone suggested above, it will be important for this plugin to be self contained within Confluence in order for an Entrprise to consider purchasing it. It is an impressive application but if it cant be decoupled I dont see many enterprises purchasing it.

     Talk to Gliffy

    1. Jan 17, 2008

      P. K. Chan says:

      Hi Derek, Guess what, we did talk to Gliffy And we'll be launching EditGrid C...

      Hi Derek,

      Guess what, we did talk to Gliffy And we'll be launching EditGrid Confluence Plugin together with a trimmed-down version of the EditGrid Server for installation on the intranet later in 2008 Q1.

      Drop us an email at sales@editgrid.com if you are interested in that and would like to have more details.

      Yours,

      P. K.
      The EditGrid Team

  14. Jul 31, 2007

    Alex Szabados says:

    There really is extensive problems with rendering many many files with this plug...

    There really is extensive problems with rendering many many files with this plugin... I attached a few examples.  It is a serious problem for users of my site, making the plugin almost useless.

  15. Oct 16, 2007

    Kirk Mook says:

    Confluence standalone version 2.5.4, disabled this plugin. Then tried to uninsta...

    Confluence standalone version 2.5.4, disabled this plugin. Then tried to uninstall. It continually fails to uninstall. " Plugin uninstall failed." "The plugin loader has no memory of deploying the plugin you are trying to remove" is displayed when trying to uninstall via the repository.

    I've tried re-installing/disabling but it will not remove! 

    I reload the page for the plugin and it says "all modules enabled." What's up with that???

  16. Oct 19, 2007

    Paul Csapo says:

    Dear EditGrid, this is a nice idea. I understand that the plugin is still in be...

    Dear EditGrid, this is a nice idea.

    I understand that the plugin is still in beta mode, but I believe it will also need to be available as a stand alone plugin as several companies might not be happy to transfer financial figures or other sensitive data outside company servers.

    regards,
    Paul