Notation Guide

Print Help Tips
External Content

Ways to include, summarise or refer to content from other servers.

Notation Comment
{jiraissues:url=http://jira.xml.url}

{jiraissues:url=http://jira.xml.url|
columns=type;key;summary}

{jiraissues:url=http://jira.xml.url|
count=true}

{jiraissues:url=http://jira.xml.url|
cache=off}

{jiraissues:url=http://jira.xml.url?
os_username=johnsmith&os_password=secret}

{jiraissues:url=http://jira.xml.url|
anonymous=true}
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details.

To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters.

You can control how wide the {jiraissues} macro renders by specifying a width parameter. To specify the width in percentage, use width=XX%. To specify the width in pixels, use width=XXpx. If unspecified, the width will be 100%.

Not specifying columns will lead into the default column list and order.

Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, status, resolution.

Specifying count=true will cause the macro to just print out how many issues were in the list, without printing the list.

Using cache=off will force the macro to refresh its internal cache of Jira issues.

Note: Certain filters may require a logged-in user in order to work. If a trust association has been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your jira issues URL.

You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously.

Example:

Atlassian JIRA (This file is an XML representation of some issues)
Key Summary Assignee Status Res Updated
TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

{jiraissues:url=http://jira.xml.url}

{jiraissues:url=http://jira.xml.url|
columns=type;key;summary}

{jiraissues:url=http://jira.xml.url|
count=true}

{jiraissues:url=http://jira.xml.url|
cache=off}

{jiraissues:url=http://jira.xml.url?
os_username=johnsmith&os_password=secret}

{jiraissues:url=http://jira.xml.url|
anonymous=true}
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details.

To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters.

You can control how wide the {jiraissues} macro renders by specifying a width parameter. To specify the width in percentage, use width=XX%. To specify the width in pixels, use width=XXpx. If unspecified, the width will be 100%.

Not specifying columns will lead into the default column list and order.

Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, status, resolution.

Specifying count=true will cause the macro to just print out how many issues were in the list, without printing the list.

Using cache=off will force the macro to refresh its internal cache of Jira issues.

Note: Certain filters may require a logged-in user in order to work. If a trust association has been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your jira issues URL.

You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously.

Example:

Atlassian JIRA (This file is an XML representation of some issues)
Key Summary Assignee Status Res Updated
TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

{jiraportlet:url=http://jira.portlet.url} Imports and displays JIRA 3 portlet into a Confluence page.

You can get the URL for the portlet by configuring the portlet into your JIRA dashboard. While in configuration mode, you can copy the portlet URL from the top of the portlet display.

Note: Certain filters may require a logged-in user in order to work. Hence you may need to append:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your portlet url.

{collapsiblerss}

Displays an rss feed within a page that can be hidden (by each user) until there is a new item to display.

  • url the url of the feed to display
  • maxItems (optional) the maximum number of feed entries to display.
  • showTitlesOnly (optional) If true only the feed titles will be displayed, defaults to false.

{im:myscreenname|service=AIM}
{im:me@hotmail.com|service=MSN|showid=false}

Displays a graphic indication of whether an IM user is online. You must supply a valid user ID as the default argument and the desired service.

Parameters

  • (default) - The user id/screen name.
  • service - The name of the service to check. May be 'aim', 'gtalk', 'icq', 'msn', 'sametime', 'skype', 'wildfire' or 'yahoo'.
  • showid - (optional) If 'false', the user's id will not be shown.

{sql:dataSource=TestDS|output=wiki}
select * from test
{sql}


There are *{sql:dataSource=TestDS|table=false} select count(*) from test01 {sql}* rows in table test01


{sql:dataSource=TestDS|p1=%test%|showsql=true}
select * from test01 where a1 like ?
{sql}

Displays the result table(s) or values from an SQL statement(s), usually a query. Consider using the sql-query macro for simple queries. Data from single or multiple results sets are formatted usually as a table for display. Multiple SQL statements (semi-colon separated) can be specified within a single sql macro body (subject to support provided by specific databases). This macro supports common table capabilities with other table based macros (table-plus, csv, and excel).

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use: Four identical macros sql, sql1, sql2, and sql3 are provided to enable recursive use of the macro.

  • dataSource - Required parameter. Formerly known as the jndi parameter. For compatibility the jndi parameter will be still be used if the dataSource parameter is missing. Specify the datasource name defined in the application server. Do not use the standard prefix (java:comp/env/jdbc/) as it is added automatically if necessary. Specific values of this parameter may be restricted for security reasons. See your administrator for details.
  • output - Determines how the output is formated:
    • html - Data is output as a HTML table (default).
    • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
  • script - Location of sql statement. Default is the macro body only.
    • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • global page template name - Data is read from a global page template.
    • space:page template name - Data is read from a space template.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
  • border - The border width in pixels. Defaults to normal table border width.
  • width - The table width in pixels. Default is 100%.
  • rowOrientation - By default, data is oriented with rows appearing vertically (in rows) and columns in columns. Specify rowOrientation=horizontal to have rows appear horizontally (as columns) and columns appear as rows.
  • columnLabel - By default, database column names are used as column labels. Specify columnLabel=true to have database column labels used for column labels. Note that most databases default the column label to be the column name when no explicit column label is provided. Fly-over text for a column label will be the column name when columnLabel=true. Fly-over text for a column label will be the database column label when columnLable=false or by default.
  • escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Set escape=true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
  • convertNull - Default is true. Converts SQL NULL values to blank. Set to false to have NULL values show up as 'null'.
  • table - Default is true. Set to false to not format the data in a table. This option can be used to run queries that produce single values that you want to include in text.
  • noDataError - Default is false. Set to true to show an macro error when no data is returned from the query.
  • expandArray - Default is true to have array fields expanded one entry per line for vertical row orientation.
  • showSql - Default is false. Set to true to show a panel with the sql statement.
  • macros - Default is false. Set to true to execute any macros so their value can be passed to the SQL query.
  • SQL parameter markers - SQL supports parameter markers in statements - these are identified by ?'s. Parameters p1, p2, ... are substititued for the parameter markers. This can be used to parameterize complex scripts stored as attachments or files.
    • p1 - first parameter marker
    • p2 - second parameter marker
    • ... - ...
  • autoCommit - Advanced use only. Default is true. Set to false for sql that explicitly controls its own rollbacks and commits.
  • transactionIsolation - Advanced use only. Set the transaction isolation level for the sql statements. The default will be used unless this parameter is set to a valid value from the following list:
    • READ_COMMITTED (default) - any changes made inside a transaction are not visible outside it until the transaction is committed.
    • READ_UNCOMMITTED - allows transactions to see uncommitted changes to the data.
    • REPEATABLE_READ - rows that are read retain locks so that another transaction cannot change them when the transaction is not completed.
    • SERIALIZABLE - Tables are locked for the transaction so that WHERE conditions cannot be changed by other transactions that add values to or remove values from a table
    • NONE - Database does not support transactions
{sql-query:dataSource=TestDS|output=wiki}
select * from test
{sql}

Displays a result table or values from an SQL select statement. The statement must produce a single result set. Use the sql macro for more complex select or other statements. The sql-query macro is recommended for better performance.

This macro supports the same parameters as the sql macro, the primary difference is to restrict what statements can be run.

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use: Four identical macros sql-query, sql-query1, sql-query2, and sql-query3 are provided to enable recursive use of the macro.

{junitreport:directory=file:///c:/test-reports}
(currently only picks up result files in XML format. Set ant formatter to "xml")

{junitreport:url=file:///test-reports/TestRep.xml}
Displays the results of a series (or single) JUnit test.

Success Rate Tests Failures Time(s) Time(s)
93%
14 1 0 1.531

{rss:url=http://host.com/rss.xml}

{rss:url=http://host.com/rss.xml|max=5}

{rss:url=http://host.com/rss.xml|showTitlesOnly=true}

Display the contents of a remote RSS feed within the page. Note: feeds are cached for 60 minutes before being retrieved again.

The 'max' parameter can be used to limit the number of entries displayed.

Example:

Sample RSS Feed (RSS 2.0)
(Feed description here...)
My Item ( Dec 30, 2003 06:53)
And part of the item content here...
Another Item ( Dec 30, 2003 06:53)
And part of the item content here...

You can specify 'showTitlesOnly=true' to show only the RSS feed titles. This parameter defaults to false.

You can specify 'titleBar=false' to hide the feeds titlebar. This parameter defaults to true.

You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {rss:url=http://example.com/path/to/target/location}. This parameter defaults to true.