Scripts

Aug 27, 2026

This page is a collection of community-submitted scripts.

Browse what's already here or click 'Add Page' above to submit your own.

It may be a good idea to prefix your new page title with 'Script' to avoid clashing with other pages in the Space.

Remember to include your scripts in {noformat} or {code} tags!

Bitbucket Examples project

A public repository of example scripts is available on Bitbucket - see Examples

Contents

Script - add-watcher (groovy) — This groovy script, implemented as a user macro, is used to add users as a watcher to a page.
Script - all user email (beanshell) — All user email string - use to paste into an email for all Confluence users.
Script - cleanup groovy temporary files (gant) — Cleanup temporary files produced by running groovy and gant scripts in Confluence.
Script - datalog download form (Jython)
Script - display images and icons
Script - Editable Paging Tables
Script - forum table
Script - list groups and LDAP owners (jython)
Script - list of user macros
Script - list pages that have permissions set
Script - Show Page Watchers (groovy & beanshell) — show watchers of the current page (including space watchers)
Script - sql query (beanshell) — Run a query against the Confluence database connected via an application server data source. Lists all spaces in the Confluence instance.
Script - sql query (groovy) — Run a simple query against a direct JDBC connected database (mySQL)
Script - user by group (beanshell) — List users by group script
Script - user list (groovy) — List all users

Comments

Former user (Deleted)

Apr 27, 2010

I can't add pages, so chop this...

Beanshell script to view banada keys, and if not found, dump all of them. The bit commented out actually sets an empty value for the given key (removing) the related value.


{run:heading=Remove Bandana Key|inputSize=80|replace=searchterm:com.yourkey:Search:10:stuff|autorun=false} 
{beanshell:output=wiki}
import com.atlassian.bandana.BandanaManager;
import com.atlassian.confluence.setup.bandana.ConfluenceBandanaContext;
import com.atlassian.spring.container.ContainerManager;

BandanaManager mgr= ContainerManager.getInstance().getComponent("bandanaManager");
ConfluenceBandanaContext cctx=new ConfluenceBandanaContext();

Object value=mgr.getValue(cctx, "$searchterm");
if (value!=null)
{
   out.println("$searchterm '"+value.getClass().getName()+"' == \n"+value);
   //mgr.setValue(cctx, "$searchterm", "");
}
else
{
   out.println("{note:title=Bandana key '$searchterm' not found}Dumping bandana data for investigation{note}");
   out.println("h3. Bandana Context Dump");
   out.println("\{noformat}"+mgr.exportValues(cctx)+"\{noformat}");
}
{beanshell}
{run}

Bob Swift (Deactivated)

Apr 28, 2010

You should be able to add pages now. The default authorities that are set up for spaces are pretty restrictive .

Jason Huntley

Oct 31, 2011

Bob, I've got my script working with groovy and now have paginated tables working in confluence using your macros and previous sample code you provided. I'd like to make a contribution to the script library, but i don't have access. Here's my final markup:


 {run:id=page|autoRun=true|hideColumnHeadings=true|replace=
 g1::Edit:group,
 limit:10:Size:select::5::10::25::50::75::100::200::300::400::500,
 direction:refresh:Select:select::forward::backward::begin::end::refresh,
 offset:0::hidden
 |titleRun=Page}

{groovy:output=wiki|glimit=$limit|goffset=$offset|gdirection=$direction|goffsetoveride=$overideoffset}

import com.atlassian.renderer.v2.RenderMode

def renderMode = RenderMode.suppress(RenderMode.F_FIRST_PARA)
SESSION_OFFSET_ATTRIBUTE='my_pageoffsetvalue'

value=session.getAttribute(SESSION_OFFSET_ATTRIBUTE)

//***UPDATE SQL: nested in between quotes
def countMacro = "{sql:id=countsql|datasource=test|table=false}select count(*) from confluence_editable_table;{sql}"

def count = subRenderer.render(countMacro, context, renderMode)

glimit=glimit.toInteger()

  if (value==null) {
    value=goffset
  } else {
    c=count.toInteger()
    value=value.toInteger()

    if (gdirection=='forward') {
      if (c>(value+glimit))
        value=value+glimit
    } else if (gdirection=='backward') {
      if ((value-glimit)<0)
        value=0
      else
        value=value-glimit
    } else if (gdirection=='begin') {
        value=0
    } else if (gdirection=='end') {
        if (glimit<c)
          value=c-glimit
        else
          value=0
    }
  }

session.setAttribute(SESSION_OFFSET_ATTRIBUTE, value)

//***UPDATE SQL: nested in between quotes
def selectResultsMacro = """
{sql-query:dataSource=test|output=wiki}

 select id, name, value,

 '{table:border=0|cellpadding=0|cellspacing=0}{table-row}{table-cell}'
 || '{run1:id=e' || id || '|buttonPadding=0'
 || '|keepRequestParameters=true|anchor=edit|titleRun=Edit}'
 || '{extract-link:redirect=true}'
 || '$page_url'
 || '?run_selection=run&run_edit_name={url-encode}' || name || '{url-encode}'
 || '&run_edit_value={url-encode}' || value || '{url-encode}'
 || '&run_edit_id=' || id
 || '&run_selection_hideEdit=false'
 || '#\$page_anchor_e' || id
 || '{extract-link}'
 || '{run1}'
 || '{table-cell} {table-cell}'
 || '{run1:id=d' || id
 || '|buttonPadding=0'
 || '|titleRun=Delete}'
 || '{sql:dataSource=hgaidb_hgatest}'
 || 'delete from confluence_editable_table where id = ' || id
 || '{sql}'
 || '{extract-link:redirect=true}'
 || '$page_url?run_page_direction=refresh'
 || '{extract-link}'
 || '{run1}'
 || '{table-cell}{table-row}{table}' as "Actions"

 from confluence_editable_table order by id limit $limit offset $value

{sql-query}
"""
println selectResultsMacro
println "Page command = '$gdirection', limit=$glimit, offset=$value, rows=$count"

{groovy}

{run}

h3. Insert
{run:id=recinsert|titleRun=Insert|autoRun=false|hideColumnHeadings=true|keepRequestIds=false|replace=
 g1::Insert:group,
 id::id,
 name::name,
 value::value}
 {groovy:output=wiki|gid=$id|gname=$name|gvalue=$value}
    //***UPDATE SQL: nested in between quotes
    def insertMacro = """
        {sql:id=insertsql|datasource=test|p1=$gid|p2=$gname|p3=$gvalue}
         insert into confluence_editable_table(id, name, value)
         values(cast(? as integer), ?, ?)
        {sql}
    """

  println insertMacro
 {groovy}
 {extract-link:redirect=true} $page_url?run_page_direction=refresh{extract-link}
{run}

{anchor:edit}
h3. Edit
{run:id=edit|hideColumnHeadings=true|replace=
 g1::Edit:group,
 id::id:hidden,
 name::name,
 value::value
 |titleRun=Update}
{groovy:output=wiki|gid=$id|gname=$name|gvalue=$value}
 //***UPDATE SQL: nested in between quotes
 def updateMacro = """
   {sql:dataSource=test|p1=$gname|p2=$gvalue|p3=$gid}
     update confluence_editable_table
     set name = ?, value = ?
     where id = cast(? as integer)
   {sql}
 """
 println updateMacro
{groovy}
{extract-link:redirect=true} $page_url?run_page_direction=refresh{extract-link}
{run}

Bob Swift (Deactivated)

Oct 31, 2011

Thanks for contributing. I gave you permission to add a page .

Josh Eastburn

Nov 14, 2011

Hi Bob,

The OEM I work for is trying out a new system for data acquisition. I built this script to allow users to download a CSV file of machine data obtained via OPC (using KEPServerEX) and stored in a MySQL DB.

The page is built using two Jython scripts, a couple of run macros, and the goto-url user macro. I had to install the Jython 2.5.2 jar to get the database connectivity library to work.

If you'll give me access, I can add the code to the script library.

UPDATE: Script - datalog download form (Jython)

(edited)

Bob Swift (Deactivated)

Nov 14, 2011

Thanks for the contribution. You should now have access!

Scripts

.css-6cu6fo{box-sizing:border-box;-webkit-appearance:none;-moz-appearance:none;-ms-appearance:none;appearance:none;border:none;}Comments

Comments