Here are the steps, which need to be performed to create a report:

  • Add the Reporting Table View macro to the page.
    • If you need to have several reports on the same page, add one Reporting Table View macro for each report.
    • Reporting Table View macro should contain exactly one Reporting Jira/Confluence Data Provider macro inside its body, from which it takes input data.
    • Reporting Table View macro may have one to many Reporting Item macros inside its body.
    • Each Reporting Item macro contains parameters for a single table column.
    • The order of columns is the same as the order of Reporting Item macros in the Reporting Table View macro body.
  • Add one Reporting Jira/Confluence Data Provider macro to the Reporting Table View macro body.
    • Data providers return data as an array of JSON objects.
    • Reporting Confluence Data Provider returns data from current Confluence instance.
    • Reporting Jira Data Provider returns data from the specified Jira instance. If no Source is specified, a primary Jira application link is used.
    • Reporting Jira Data Provider for Server/Datacenter Source parameter should be the name of the Application link.
    • Reporting Jira Data Provider for Cloud Source parameter should be the URL of the appropriate Jira instance. CelesteCS Reporting for Confluence Cloud - Jira Integration plug-in must be installed on the specified Jira instance, to be able to read data on behalf of the current user account.
  • Add one to many Reporting Item macros to the Reporting Table View macro body.
    • Reporting Item contains all the information about a single column of the report: header, cell body and footer settings.
    • The header content may be specified as a plain text or as a formula (expression). In case of expression it is convenient to use the AllItems special variable, which is an array of all items, returned by the data provider. You may specify explicit fields, count the numbers of elements and perform other calculations over these data.
    • Body content is the main part of all reporting macros elements. In case of expression it is convenient to use the CurrentItem special variable, which is the current item from the array of all items. When a report is populated, all the items from the data provider are enumerated creating a row for each item.
    • The footer content may be specified as a plain text or as a formula (expression). In case of expression it is convenient to use the AllItems special variable just like in a header.
    • In case when no Reporting Item contains header text, the table header is not shown. The same is for the footer.