The Adaptavist Group LogoDocumentation

Cloud Macro Guide

Add macro

To add the Task Manager for Confluence (TMC) macro:

  1. When editing, select Insert macro icon in the Confluence editor toolbar from the toolbar
  2. Find the macro by name and select it

You can also select the centered Centered macro width icon in the Confluence editor , medium-width Medium-width macro icon in the Confluence editor , and full-width Full-width macro icon in the Confluence editor icons to adjust the width of some macros. Select the trashcan icon Trashcan icon in the Confluence editor toolbar used to remove the macro to remove the macro.

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the Task Manager for Confluence (TMC) macro to see it.

Authorization/Configuration macro

To configure the TMC macro after adding it to your Confluence page, follow these steps:

  1. After adding the TMC macro, a "Configure Task Manager for Confluence" popup will appear in the Edit mode of Confluence page.
  2. In the popup, select the available Jira source that was previously added on the Task Manager for Confluence - Configuration page.
  3. Enter your user email associated with the selected Jira source.
  4. Enter the API token for authentication. This token acts as a secure form of authentication instead of using a password.
  5. Once you have entered the necessary information, click on the "Authenticate" button to establish a connection with the selected Jira source.

Use JQL to Sort and Filter

Once you have authorized the Jira source in the TMC macro configuration, you will have access to the JQL (Jira Query Language) field to sort and filter the issues that you want to display
  1. Enter any JQL query directly into the JQL field.
  2. After entering the JQL query, click on the "Validate JQL query" button. This will validate the query syntax and check if it returns any results.

  4. Push the "Insert" button to save changes/configuration.
  5. Publish the Confluence page.Example of a Confluence page displaying Jira issues returned by the validated JQL query

Change Authorized User Credentials

If you need to change the credentials for the authorized user in the TMC macro configuration, you can follow these steps:
  1. Next to the authorized user email, you will find an edit icon (pencil). Click on this edit icon.
  2. A User email and API token fields will appear, allowing you to modify the credentials.
  3. Update the fields.
  4. After making the desired changes, push the "Authenticate" button Authenticate button used to save the updated authorized user credentials

Authorization in the macro on the published page

It's important to note that each user would need to go through this authorization process individually to access the TMC macro. Once authorized, you will have access to the TMC macros features.

To authorize the TMC macro and access its functionality, follow these steps:

  1. Navigate to the Confluence page where the TMC macro has been added.
  2. In the TMC macro, you will find fields to enter your user email and API token.
  3. Enter your user email
  4. Enter the API token corresponding to your user account. The API token serves as a secure form of authentication instead of using a password.
  5. Click on the "Authenticate" button to complete the authorization process.
  6. Push the "Continue" button
Note: Each user must be authorized in the macro to use it

Search documentation

Start typing to search the docs.