Versions Compared

Key

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

...

Click “Add” to set up a task to automatically generate a report on a regular basis.

...

无标题-20241128-030035.pngImage Added

The settings include:

Settings

Description

Page Title

The page title of the generated report. You can use variables to name the title, such as $reporter etc.

  • $week: Current week

  • $reporter: Corresponding reporter

  • $project: Corresponding project

  • $creator: User who set up an automatic and periodic report

  • $startDate: The start time of the period in the report

  • $endDate: The end time of the period in the report

  • $createdDate: Generation time of the report

  • $startDate_endDate: The start and end time of the period in the report

Jira Link

The data source about Jira in the report.

New PageNode

The page location in the report.

Template Type

Click to switch between "Blueprint Template" or "User Template".

Template

Templates for report generation based on.

Reporter/Project

The reporter/project for the report, which toggles based on the selected blueprint or report type.

Node Classification

The page directory structure where report is stored, support by year, month, week, project, reporter.

Repeat

The date of the scheduled generation. For example, if every Tuesday is selected, it means that the report will be automatically generated at 0:00 every Tuesday.

Report generation time

The start date for generating reports on a scheduled basis. For example, if the start date is selected as last Monday, then the end date is last Sunday (last Monday+7 days).

If the difference between the report generation date and the report start date is less than seven days, then the end date is the report generation date

Click "Save" to add successfully.

...

...

Macro parameter setting

Macro parameter setting can realize dynamic replacement of macro parameters in templates.

For example, the template contains a jira macro whose Jql parameter value is "project = TW and created <= 2022-06-01". If the report is generated periodically from this template, this part of the report will be fixed, showing the project " TW" Jira data at the "2022-06-01" time node.

Through the macro parameter replacement setting, when each report is generated, "TW" can be replaced with the project corresponding to this report, and "2022-06-01" can be replaced with the report generation date, the start date of the period, and the end date of the period.

The operation steps are as follows:

Click “Macro Param” to pop up the configuration window of Macro Param Replacement.

...

Click “New Param Replacement” to set a replacement rule for macro parameters:

  • Param Content: The macro parameter to be dynamically replaced.

  • Replace To: The replaced target macro parameter, including Report Creation Date, Start Date(Period), End Date(Period), Reporter’s Name, Reporter’s Full Name, Project Name, Project Key.

  • Date Offset: The date offset is only showed when replacing to the three types of "Report Generation Date", "Start Date(Period)", and "End Date(Period)". The number of days can be increased or decreased based on the date of the corresponding dynamic parameter, and the upper and lower limit is 365 days.

...

Click "Save" to add successfully.

Generate reports now

Click "Generate Now" to check whether the report automation configuration is working as expected, if not, you can adjust the configuration at any time.

...