User Information Plugin

Name User Information Plugin
Vendor Atlassian Software Systems
Authors Shannon Krebs, David Peterson, Jonathan Nolen, Colin Goudie
Homepage http://confluence.atlassian.com/display/CONFEXT/User+Information+Plugin
Issue Management http://developer.atlassian.com
Categories Macros
Version 0.2.1
Availability Confluence v2.5 to v2.10-m1
State Beta
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/User+Information+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/user-info-plugin/tags/0.2.1
Download JAR userinfo-0.2.1.jar
Under Development

This plugin is currently under development and is not recommended for production environments. If you notice anything that isn't quite right or have ideas for features that would be useful please create a Jira issue (or vote on one that already exists).

Description/Features

This plugin replaces the Confluence user profile actions to allow users to enter more information about themselves. The fields that users can enter can be specified by Confluence administrators. The extra user information can be viewed through the {userinfo} macro or it can be accessed through the Reporting Plugin if it is installed.

Installation

You need to have System Administrator permissions in order to install and configure plugins.

Installing and Configuring Plugins using the Plugin Repository Client

If the plugin you wish to install is listed in the Confluence Plugin Repository, you can use the Confluence Repository Client to install it. Just find the plugin in the list and click the 'install' link. There's more information in Installing and Configuring Plugins using the Plugin Repository Client.

Installing and Configuring Plugins Manually

If the plugin you wish to install is not listed in the Confluence Plugin Repository, you can still install it by uploading it to your Confluence site:

  1. In the 'Administration' section of Confluence, click the Plugin Repository link.
  2. Click the 'Upload' tab.
  3. Use the 'Browse' button to find the plugin jar you wish to install.
  4. Select the jar file and click 'Open'.
  5. The plugin will be uploaded from your machine to Confluence, and will be automatically installed.

There's more information in Installing and Configuring Plugins manually.

RELATED TOPICS

Removing malfunctioning plugins

Usage

Examples

Plugin Versions

Version Date State License Price
Show description 0.2.1 (#3) 02 Feb 2008 Beta Freeware / Open Source (BSD) Free

Release Notes

This is a beta release of the User Information Plugin. It is not recommended for use in production systems.

Contributors

  • Shannon Krebs — Bug Fixer
  • Colin Goudie — Bug Fixer

Show description 0.2 (#2) 04 Sep 2007 Beta Freeware / Open Source (BSD) Free

Release Notes

This is a beta release of the User Information Plugin. It is not recommended for use in production systems.

Contributors

  • Shannon Krebs — Developer
  • David Peterson — Developer
  • Jonathan Nolen — Developer

Open Issues

Atlassian Developer Network JIRA (20 issues)
T Key Summary Assignee Reporter Pr Status Res Created Updated Due
Support Request USER-43 Next release Dates for USER INFO Plugin Jonathan Nolen OUNI ALI Major Open UNRESOLVED Aug 22, 2008 Aug 22, 2008
Bug USER-42 Unable to add User Information Fields Jonathan Nolen Bj�rn Wang Critical Open UNRESOLVED Aug 18, 2008 Aug 18, 2008
Bug USER-41 Attempting to add a new custom field of type "text" results in error: userinfo.error.fieldRequired Jonathan Nolen Rick Hadsall Blocker Open UNRESOLVED Aug 10, 2008 Aug 10, 2008
Bug USER-40 Breadcrumb on edit user info page has uninterpreted property Jonathan Nolen Matt Ryall Major Open UNRESOLVED May 26, 2008 May 26, 2008
New Feature USER-39 Ability to sort the results of groups alphabetically Jonathan Nolen Steven Salter Major Open UNRESOLVED Apr 01, 2008 Jul 31, 2008
Improvement USER-37 Need an icon to indicate a field is required Unassigned Shannon Krebs Minor Open UNRESOLVED Feb 02, 2008 Feb 02, 2008
New Feature USER-29 Pluggable field types Jonathan Nolen Guy Fraser Major Open UNRESOLVED Sep 14, 2007 Sep 14, 2007
New Feature USER-28 Need to be able to specify field ID for integration purposes Jonathan Nolen Guy Fraser Critical Open UNRESOLVED Sep 13, 2007 Sep 19, 2007
Bug USER-27 userinfo macro - unable to get it working Jonathan Nolen Guy Fraser Major Open UNRESOLVED Sep 13, 2007 Sep 14, 2007
New Feature USER-26 More IM services Jonathan Nolen Guy Fraser Major Open UNRESOLVED Sep 13, 2007 Sep 19, 2007
New Feature USER-25 Instant messenger type filed that has XMPP for generic Jabber servers. Cheryl Jerozal Miles Metcalfe Minor Open UNRESOLVED Sep 09, 2007 Feb 02, 2008
New Feature USER-24 Address fields configurable to suit different countries Jonathan Nolen Miles Metcalfe Minor Open UNRESOLVED Sep 09, 2007 Sep 13, 2007
New Feature USER-23 Remote API for extended user information fields Unassigned Shannon Krebs Major Open UNRESOLVED Sep 04, 2007 Sep 14, 2007
Improvement USER-22 confirm delete of custom field Cheryl Jerozal Shannon Krebs Major Open UNRESOLVED Sep 04, 2007 Feb 02, 2008
New Feature USER-20 Add user information fields to search index Unassigned Shannon Krebs Minor Open UNRESOLVED Aug 20, 2007 Sep 14, 2007
New Feature USER-17 Allow fields to be only viewable/editable by administrators Jonathan Nolen David Peterson Major Open UNRESOLVED Aug 14, 2007 Aug 14, 2007
New Feature USER-12 userinfo-field macro Shannon Krebs Major Open UNRESOLVED Jul 24, 2007 Sep 14, 2007
New Feature USER-9 Fileupload custom field type Unassigned Shannon Krebs Major Open UNRESOLVED Jul 23, 2007 Jul 23, 2007
New Feature USER-2 Upload and store a larger image Jonathan Nolen Jonathan Nolen Major Open UNRESOLVED Jul 03, 2007 Sep 13, 2007
New Feature USER-1 Use a flash widget to allow people to upload photos and them thumbnail-ize them Jonathan Nolen Jonathan Nolen Major Open UNRESOLVED Jul 03, 2007 Sep 13, 2007

Screenshots

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

    Guy Fraser says:

    This plugin doesn't appear to work on Confluence 2.6?

    This plugin doesn't appear to work on Confluence 2.6?

    1. Sep 17, 2007

      Fennie Ng says:

      Hi Guy, I managed to upload this plugin via Plugin Repository successfully. I w...

      Hi Guy,

      I managed to upload this plugin via Plugin Repository successfully. I was able to add custom fields and update the user information correctly with Confluence 2.6 and Confluence 2.5.5. If you are still having the problem, perhaps you want to raise a support request for this issue.

      Thank you.

      Regards,
      Fennie

  2. Oct 04, 2007

    Nicolay Aslaksen says:

    I would like to see some usages examples. How do I actually specify new fields ?...

    I would like to see some usages examples.
    How do I actually specify new fields ?

    Regards,
    Nicolay

    1. Oct 04, 2007

      Shannon Krebs says:

      This plugin is still very much under development so documentation doesn't really...

      This plugin is still very much under development so documentation doesn't really exist yet Managing what fields can be specified is done through the admin menus. Once the plugin is installed you should see a new section appear in the admin menu for managing the fields and for managing the stored information on other users.

      1. Nov 12, 2007

        Greg Barwis says:

        On Confluence 2.6, I'm able to get the plugin installed, create custom fields, a...

        On Confluence 2.6, I'm able to get the plugin installed, create custom fields, and edit that information for my users - but I can't seem to display it anywhere.  Whenever I call userinfo it just returns "No Users Found" regardless of what syntax I attempt.

        Our Confluence Enterprise installation is LDAP-integrated with our Active Directory, if that is relevant.  We would like for each user to be able to edit their own custom fields (as established through the admin menus), and then to display that information in a single-page company directory, but I can't figure out how to get at the information.

        Of course, this is all being done on our lab installation of Confluence, not our production installation. 

        1. Nov 15, 2007

          Jack Odell says:

          I have also been able to install it on 2.6, create custom fields, and edit them....

          I have also been able to install it on 2.6, create custom fields, and edit them.  I also can't display them with userinfo.

          I also implemented a report using the reporting plugin, but didn't know which names to use for my custom fields.  In the example below "Extension" is my custom field.

          {report-block}
          
          {user-reporter}
          {text-sort:user:full name}
          {user-reporter}
          
          {report-body}
          {float:left}
          {report-image:user:picture|width=48px|height=48px} *{report-info:user:full name|link=true}*
          *User ID:* {report-info:user:name}
          *Email:* {report-info:user:email|link=true|default=_Unavailable_}
          *Extension:* {report-info:user:extension|default=_Unavailable_}
          {float}
          {report-body}
          
          {report-block}

          How do I refer to custom fields via the "User Supplier"?

  3. Oct 09, 2007

    David Dembo says:

    This plugin looks like it could be pretty damn useful I'll be keeping a close ey...

    This plug-in looks like it could be pretty damn useful - I'll be keeping a close eye on its development. At least 10 different uses for it spring immediately to mind. Once we get a development server up and running I'll definitely have a play around with it.

    One idea I'll throw out there while you're in the early stages of development - I see a lot of potential uses for non-user-editable fields that are automatically updated on certain events, for example an online/offline boolean field that is toggled by the User Listener.

    1. Oct 09, 2007

      Shannon Krebs says:

      I think one of the things we should look at is USER29 to allow pluggable field t...

      I think one of the things we should look at is USER-29 to allow pluggable field types. Then different fields such as this can be added independently.

  4. Nov 28, 2007

    neeraj says:

    HI   after adding into custom field where does the data go. i was assuming ...

    HI  

    after adding into custom field where does the data go.

    i was assuming it to be os_propertyentry table .

  5. Dec 05, 2007

    Appan Ponnappan says:

    How do we access the additional user profile info once we have added them? The d...

    How do we access the additional user profile info once we have added them? The documentation for this plugin is to be improved. I have added a new field called Role and I am able to filter the users with a specific role with:

    {user-reporter}
    {text-filter:userinfo:Role|include=PM.*}
    {user-reporter}

    But accessing it from the report body does not produce anything.

    {report-column:title=Role}
    {report-info:userinfo:Role|default=_Unavailable_}
    {report-column}
    1. Dec 06, 2007

      David Dembo says:

      You could maybe try playing around with chaining other suppliers, e.g. tweaking ...

      You could maybe try playing around with chaining other suppliers, e.g. tweaking the syntax? Just stabbing in the dark, I haven't got around to playing with this plug-in yet myself...

      e.g. some things that might work:

      {report-info:reference:Role|default=_Unavailable_}
      or
      {report-info:report:item > reference:Role|default=_Unavailable_}
      or
      {report-info:user:personal information > reference:Role|default=_Unavailable_}

      Also worth trying the Scaffolding supplier, e.g.:

      {report-info:data:Role|default=_Unavailable_}
      or
      {report-info:report:item > data:Role|default=_Unavailable_}
      or
      {report-info:user:personal information > data:Role|default=_Unavailable_}

      Let us know if any of them happen to work

      1. Dec 06, 2007

        Jack Odell says:

        I just tried those six permutations and it didn't work for me.  For referen...

        I just tried those six permutations and it didn't work for me.  For reference I will include the last one I tried.  In my case the custom field is "Extension" not "Role".

        {report-block}
        
        {user-reporter}
        {text-sort:user:full name}
        {user-reporter}
        
        {report-body}
        {float:left}
        {report-image:user:picture|width=48px|height=48px} *{report-info:user:full name|link=true}*
        *User ID:* {report-info:user:name}
        *Email:* {report-info:user:email|link=true|default=_Unavailable_}
        *Extension:* {report-info:user:personal information > data:Extension|default=_Unavailable_}
        {float}
        {report-body}
        
        {report-block}
        1. Dec 09, 2007

          Appan Ponnappan says:

          The following is working for me: after upgrading Reporting plugin to 1.3.2 fr...

          The following is working for me:

          {report-info:userinfo:Role}

          after upgrading Reporting plugin to 1.3.2 from 1.2

  6. Jan 04, 2008

    Cristofer Weber says:

    After some troubles using Date Custom Fields I reached this DateCustomField's me...

    After some troubles using Date Custom Fields I reached this DateCustomField's method:

         public void handleEditSubmit( User user, HttpServletRequest req ) throws FieldException

    Unknown macro: {        Storage reqParams = new RequestParameterStorage( req );         int year = reqParams.getInteger( getId() + ".year", 1900 );        int month = reqParams.getInteger( getId() + ".month", 1 );        int day = reqParams.getInteger( getId() + "day", 1 );         Day newDay = new Day( year, month, day );         setDayValue( user, newDay );    }

    There's no dot in the concatenation of getId() and "day" string, causing getInteger to return 1 every time I try to submit my custom fields.

    []'s

     Cristofer

    1. Jan 06, 2008

      Tony Cheah Tong Nyee says:

      Hi Cristofer, I would suggest you to share this information to the plugin's Aut...

      Hi Cristofer,

      I would suggest you to share this information to the plugin's Author via the plugin's Issue Tracker: