Skip to end of metadata
Go to start of metadata

Suppliers are services provided by various plugins which provide information about particular content. This is made particular use of by the Reporting Plugin, which uses suppliers to generate the content of the reports displayed. This is done by using supplier keychains in macros such as report-info, as well as with parameter injection in macros like link-page and date-filter.

Available Suppliers

NamePrefixSummarySource
Attachment SupplierattachmentSupplies information about attachments in Confluence.Reporting Plugin
Boolean SupplierbooleanAllows some simple post-processing on boolean values.Reporting Plugin
Child Counter Supplierchild-counterProvides access to the 'current' and 'next' counter for the number of children added to a page in Confluence.Linking Plugin
Class SupplierclassProvides information about object classes.Reporting Plugin
Collection SuppliercollectionProvides information about collections of items.Reporting Plugin
Comment SuppliercommentSupplies information about comments attached to Pages or News Items in Confluence.Reporting Plugin
Content SuppliercontentSupplies information about Confluence content, such as pages, news items, attachments and comments.Reporting Plugin
Date SupplierdateProvides information about dates.Reporting Plugin
Debug SupplierdebugProvides access to various objects useful for debugging.Reporting Plugin
Email SupplieremailSupplies information about email addresses.Reporting Plugin
Expanded SupplierexpandedThis provides access to the 'expanded' object created by the [expand-on] and expanding-reporter macros.Reporting Plugin
Global SupplierglobalThis supplier can be used from any context, and provides information about global values, such as the current user, the date/time, etc.Reporting Plugin
Grouped SuppliergroupedProvides access to the results of the {grouping-reporter}.Reporting Plugin
Label SupplierlabelProvides information about Confluence content labels.Reporting Plugin
Link SupplierlinkProvides information about links coming from Confluence content.Reporting Plugin
Mail SuppliermailSupplies information about archived email files stored in Confluence.Reporting Plugin
Map Entry SupplierentryProvides access to the key and value of a specific map entry.Reporting Plugin
Map SuppliermapProvides information about 'Map' collections, which are collections of information with a key/value relationship.Reporting Plugin
Match SuppliermatchThis provides access to match values using regular expressions.Reporting Plugin
News Suppliernews/blogpostSupplies information about news items (a.k.a blog posts) in Confluence.Reporting Plugin
Number SuppliernumberProvides information about numbers.Reporting Plugin
Object SupplierobjectProvides general information about any object.Reporting Plugin
Page SupplierpageSupplies information about Confluence pages.Reporting Plugin
Query SupplierqueryProvides access to the query objects created by reporters such as local-reporter, content-reporter, etc.Reporting Plugin
Reference SupplierreferenceProvides information about references, which are the data type used by Scaffolding list-data-related macros.Scaffolding Plugin
Report SupplierreportProvides access to information about the current report.Reporting Plugin
Request SupplierrequestProvides access to the headers and parameters passed in the HTTP request for the current context.Reporting Plugin
Scaffold Data SupplierdataProvides access to data set using Scaffolding Data macros.Scaffolding Plugin
Session SuppliersessionProvides access to the HTTP Session context.Reporting Plugin
Space SupplierspaceThis supplier provides key values for Confluence Spaces.Reporting Plugin
Stats On Supplierstats-onPerforms basic statistical analysis on values in a Collection of items.Reporting Plugin
Stats SupplierstatsProvides access to calculated statistics on a set of data.Reporting Plugin
Task SuppliertaskProvides access to information about specific tasks created by a Tasklist macroTasklist Suppliers Plugin
Tasklist SuppliertasklistProvides access to the items in a Tasklist.Tasklist Suppliers Plugin
Text SuppliertextProvides information about text values.Reporting Plugin
Tracking Data SuppliertrackProvides information from the Tracking Plugin regarding content view counts.Tracking Plugin
User Group Supplieruser-groupProvides information about user groups.Reporting Plugin
User SupplieruserProvides information about Confluence Users.Reporting Plugin
Value SuppliervalueFinds or creates specific values for use with keychains.Reporting Plugin
Variable SuppliervariableRetrieves variables set with the report-variable macro in the current context.Reporting Plugin

Providing your own Suppliers

The Supplier architecture has been designed to allow 3rd-party plugins to provide their own supplier implementations. This can be advantageous for both users and plugin developers for many reasons, including the following:

  • Teach me Once: Consistent method for accessing and displaying data across plugins.
  • Don't Reinvent the Wheel: Enables use of existing plugins (such as the Reporting Plugin and Linking Plugin) while accessing new data sources.

For more information on how to provide or make use of suppliers in your own plugin, check out the Confluence Supplier Library documentation.

See Also

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.