Versions Compared

Old Version 23

changes.mady.by.user Saumya Sunder (Inactive) (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Saumya Sunder (Inactive) (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table plus
autoNumbertrue


VariableReplacement
$current_user_idCurrent logged in user's id or blank if not logged in.
$current_user_nameCurrent user's full name or blank if not logged in.
$current_user_emailCurrent user's email address or blank if not logged in.
$current_user_timezone_idCurrent user's time zone setting id (example: America/Chicago). The default time zone will be used if the user is not logged in.
$current_user_timezone_offsetCurrent user's time zone setting offset (in hours) from GMT (examples: -6, 5.5) The default time zone will be used if the user is not logged in.
$current_timeCurrent date and time in the default Confluence format or format specified by the dateFormat parameter.
$current_time(<date format>)Current date and time in the format provided in parentheses. The date format provided must be valid. See Examples - Date Field Selection. Since 4.8.
$page_titleTitle of the current page.
$page_idNumeric id of the current page.
$page_urlFull url of the current page.
$page_tinyurlTiny url of the current page.
$space_nameSpace name of the current space.
$space_keySpace key of the current space.
$confluence_homePath to the Confluence Home directory.
$base_urlBase URL for Confluence.
$request_stringEncoded request parameters after a button press.
$include_page(<page reference>)

Includes un-rendered page source at the point of the variable and then proceeds to apply variable replacements as normal (not available for the wiki version of the macro). This means that the variables on the page being included will be replaced under the context of the original page. This means things like $page_title will represent the original page. Further more, this enables scenarios where one wants a template like page that can be brought in with substitution variables based on fixed parameters (run-now) or user input (run). This can prevent duplication in a number of user cases. The included content is inline with the surrounding content but starts a new line. Included pages cannot have ) in the title to avoid ambiguity. There may be some cases where this may not produce the expected results because the context of the included page is not used and some content and macros depend on that. For instance, finding attachments or page properties. User needs to be aware of the consequences and differences of including page source versus including rendered content. Even with that restriction, there are many examples where this will work nicely. Recursion is not supported. Some macro interactions may also not work as expected. For example,cache macro refresh and similar. Examples:

  • $include_page(include) 
  • $include_page(myspacekey:The title of the page to include)
  • $include_page(page_to_include, alternate_page) : If page_to_include does not exist, alternate_page will be considered. (Since v5.4.0)
%property_key%Property value. See content-properties for more information. Note that on recent versions of Confluence, page properties set using the Page properties macro are no longer stored as Confluence content properties and are no longer available for access (sad). See RUN-205.
%metadata_name%Metadata value. See content-properties for more information.



Tip
titleReplacement

Replacement occurs for variables found within the body of the macro just prior to rendering the body. It cannot replace variables produced by the rendering process like data produced by downstream macros.

  • Variable in sql macro body works select * from test_address1 where last ='Jones'

    • Variable in sql script coming from file will not work.

    The file contains same query:

    select * from test_address1 where last ='Jones'
    select * from test_address1 where last ='$page_title'

    To know more about replacement refer to Variables.