Documentation

Dynamic Content Macro

A Confluence macro that loads remote content as an iframe. Dynamic Content Macros render content on every page request and are suitable for add-ons that need to display content that changes over time, that calls for dynamic interaction, or that is specific to the authenticated user.

Since Dynamic Content Macros are rendered in an iframe, you are able to include your own style sheets and javascript. You can use these to create a rich, interactive experience for your users. When your macro is exported to a static format such as PDF or Word, you can use the renderModes property to define a mapping between a certain type of output device and a static macro implementation. This will allow you to create a static view of your macro's data where an interactive model is not appropriate.

For most modules, you do not need to be concerned with iframe sizing. It's all handled for you. However, an exception exists for inline macros.

An inline macro is a type of macro that generates content within the text flow of a paragraph or other text element in which the macro appears, such as a status lozenge. To implement an inline macro, follow these general guidelines:

  1. In your macro-page declaration in the add-on descriptor, set the output-type attribute to inline. (Alternatively, if this value is set to block, the macro content will appear on a new line in the page output.)
  2. If the output content should occupy a certain width and height, set those values as the width and height attributes for the element.
  3. To prevent the macro output from being automatically resized, set the data-options attribute in the script tag for all.js to "resize:false". This turns off automatic resizing of the iframe.
  4. If the size of the macro output content size is dynamic, call AP.resize(w,h) immediately after the DOM of your iframe is loaded.

Example

The following macro example is an adaptation from the Google Maps add-on. The source is hosted on Bitbucket.

{
  "modules": {
    "dynamicContentMacros": [
      {
        "width": "200px",
        "height": "200px",
        "renderModes": {
          "pdf": {
            "url": "/render-map-pdf"
          },
          "default": {
            "url": "/render-map-static"
          }
        },
        "url": "/render-map?pageTitle={page.title}",
        "description": {
          "value": "Shows a configurable map"
        },
        "icon": {
          "width": 80,
          "height": 80,
          "url": "/maps/icon.png"
        },
        "documentation": {
          "url": "http://docs.example.com/addons/maps"
        },
        "categories": [
          "visuals"
        ],
        "outputType": "block",
        "bodyType": "none",
        "aliases": [
          "map"
        ],
        "featured": true,
        "parameters": [
          {
            "identifier": "view",
            "name": {
              "value": "Map View"
            },
            "description": {
              "value": "Allows switching between view types"
            },
            "type": "enum",
            "required": true,
            "multiple": false,
            "defaultValue": "Map",
            "values": [
              "Map",
              "Satellite"
            ],
            "hidden": false
          }
        ],
        "autoconvert": {
          "urlParameter": "url",
          "matchers": [
            {
              "pattern": "https://www.example.com/maps/{}/{}"
            },
            {
              "pattern": "https://www.example.com/map-editor/{}"
            }
          ]
        },
        "editor": {
          "url": "/map-editor",
          "editTitle": {
            "value": "Edit Map"
          },
          "insertTitle": {
            "value": "Insert Map"
          }
        },
        "name": {
          "value": "Maps"
        },
        "key": "dynamic-macro-example"
      }
    ]
  }
}

Properties

key

Type
string
Required
Yes
Description

A key to identify the macro. Keys must only contain alphanumeric characters and dashes, and must be globally unique. Prefixing it with the name of your add-on is the best way to ensure this.

name

Required
Yes
Description

A human readable name.

url

Type
string

uri-template
Required
Yes
Description

The link to the add-on resource that provides the macro content. This URL has to be relative to the add-on base URL.

Additional context parameters can be passed as variables in the URL:


 {
   "url": "/macro-renderer?body={macro.body}&spaceid={space.id}&pageid={page.id}"
 }
 

Since macro bodies can be of arbitrary size and may contain sensitive data, care must be taken as to how its passed to your connect add-on. You have three options to gain access to the body:

  • If you can predict the size of your body and it is consistently less than 128 characters, you can include it in the GET request using the {macro.body} parameter.
  • If you know your macro contains a body that will often exceed the 128 character threshold (or is known to contain sensitive data), then you can include the {macro.id} parameter and use the Confluence REST api to call back to collect the body.
  • If you want, you can include, {macro.body}, {macro.id}, and {macro.truncated}. This way your plugin can call back to confluence only if {macro.truncated} is 'true'. This will allow you to skip the callback if it's not needed. This would be useful for macros that don't contain sensitive data of an unpredictable size.

Note: If you include the {macro.body} in your URL you are potentially leaking sensitive data to any intermediate host on the internet. This may result in the body being cached or indexed by a third party. If you are concerned about the security of your macro, you should always use the {macro.id} and use the Confluence REST API to collect the body.

Here's an example:

Declare the variables that are later required to fetch the macro content in the URL:


 {
   "url": "/render-macro?pageId={page.id}&pageVersion={page.version}&macroId={macro.id}"
 }
 

Then use the Confluence REST API to collect the body, for example directly from the iframe:


 AP.require("request", function(request) {
     var pageId = getUrlParameter("pageId");
     var pageVersion = getUrlParameter("pageVersion");
     var macroId = getUrlParameter("macroId");
     request({
         url: "/rest/api/content/" + pageId +
              "/history/" + pageVersion +
              "/macro/id/" + macroId,
         success: function(response) {
             var macro = JSON.parse(response);
             process(macro.body);
         }
     });
 });
 

Preview Mode: If you use the {macro.id} in your URL, the REST api will not return the macro body during a preview request, because the page has not been saved yet. You can use the {output.type} parameter to detect whether the macro is rendered in preview mode and adapt the response accordingly.

Note: macro.body will not be truncated when renderingMethod field was set to POST in static content macro. Refer to the Static Content Macros for information on how to set this field.

Currently supported variables for macros are:

  • macro.hash: The hash of the macro body (deprecated, use the macro.id)
  • macro.id: The id of the macro
  • macro.body: The macro body, truncated to 128 characters
  • macro.truncated: True if the macro body was truncated, false of not
  • page.id: The page ID, e.g. 1376295
  • page.title: The page title, e.g. My Page
  • page.type: The page type, e.g. page
  • page.version: The page version, e.g. 6
  • space.id: The space ID, e.g. 65537
  • space.key: The space key, e.g. AC
  • user.id: The user ID, e.g. admin
  • user.key: The user key, e.g. ff80808143087d180143087d3a910004
  • output.type: The output type, e.g. display or preview

Context parameters for macros are also required in the URL. Please see the Macro Input Parameter documentation for details.

aliases

Type
string, … ]
Description

Define aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.

autoconvert

Description

URL patterns associated with this macro. If a URL matching a defined pattern is pasted into the editor, this macro will be created and will replace the URL string.

bodyType

Type
string
Defaults to
none
Allowed values
  • rich-text
  • RICH-TEXT
  • plain-text
  • PLAIN-TEXT
  • none
  • NONE
  • Description

    The type of body content, if any, for this macro.

    categories

    Type
    string, … ]
    Description

    The categories the macro should appear in. A macro with no category will show up in the default 'All' category.

    Currently, the following categories are supported by Confluence:

    • admin: Administration
    • communication: Communication
    • confluence-content: Confluence Content
    • development: Development
    • external-content: External Content
    • formatting: Formatting
    • media: Media
    • navigation: Navigation
    • reporting: Reporting
    • visuals: Visuals & Images

    description

    Description

    A description of the macro's functionality.

    documentation

    Type
    Description

    A link to the documentation for the macro.

    editor

    Description

    The configuration of a custom macro editor. This is useful if the parameter input field types are not sufficient to configure the macro.

    featured

    Type
    boolean
    Defaults to
    false
    Description

    Whether the macro should be "featured", meaning having an additional link in the "Insert More Content" menu in the editor toolbar.

    height

    Type
    string
    Description

    The preferred height of the macro content.

    hidden

    Type
    boolean
    Defaults to
    false
    Description

    If set to true, the macro will not appear in the macro browser.

    icon

    Type
    Description

    A link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog. The URL can be absolute or relative to the add-on base URL.

    imagePlaceholder

    Description

    The image rendered in the editor as the macro placeholder. It can only be used with bodyless macros and will behave just like a regular macro placeholder. Any parameter changes in the macro browser will cause the image to be reloaded - so that changes can be seen.

    outputType

    Type
    string
    Defaults to
    block
    Allowed values
    • block
    • BLOCK
    • inline
    • INLINE
    • Description

      How this macro should be placed along side other page content.

      parameters

      Type
      Description

      The list of parameter input fields that will be displayed.

      propertyPanel

      Description

      The configuration of a property panel. Specify a hidden iframe to be loaded in the macro's property panel.

      renderModes

      Description

      Since Dynamic Content Macros are rendered in an iframe, you are able to include your own style sheets and javascript. When your macro is exported to a static format such as PDF or Word, you can use the renderModes property to define a mapping between a certain type of output device and a static macro implementation. This will allow you to create a static view of your macro's data where an interactive model is not appropriate.

      width

      Type
      string
      Description

      The preferred width of the macro content.