Report Bucket Definitions

Configure your bucket definitions in the Report Bucket Definitions application. The Bucket Name is the unique identifier which allows you to select which bucket to reference when running a bucketed report. 

Each report bucket definition is configured with columns that sort the records into categories based on the bucket type. There are several bucket types to select from, such as: 

  • Relative Date—The records in the report are organized based on date ranges which are relative to a specific date. 
  • Relative Period—The records in the report are organized based on date ranges which are relative to a specific period within a fiscal year. 

The bucket type selected determines which fields populate in the form for configuration. 

The Bucket Columns subtable dictates the date ranges for each column in the report. The bucket columns subtable is different depending on which bucket type is selected. For example, with a bucket type of Relative Date, the subtable is the BucketByRelativeDateSubtable. You can find the name of the subtable by selecting the help text icon. The data item name is found along the bottom of the help text box.  See the Report bucket example topic for more information. 

Merge Text Template Setup

Create the labels for your columns in the Merge Text Template Setup application. There are several considerations during configuration, such as:

  • The Template Type should be either Text or Text Area.
  • The Template should be formatted with a structure of ${FieldName} and whatever additional criteria you want. For example, ${BucketRelativeDateLow}+ Days or ${BucketRelativeDateLow} - ${BucketRelativeDateHigh} Days
  • In the Input Type Hints subtable, define each variable you included in the template. This allows the report bucket definition to identify the column header templates. 
    • The Input Name can be any field from the Bucket Column subtable in the Report Bucket Definition application. To view all of the available field options, open the BucketByRelativeDateSubtable and BucketByRelativePeriodSubtable subtables in the Table Definitions application.

For example, the BucketActualDateHigh field isn't visible in the Report Bucket Definitions application, but it is in the Bucket Column subtable. Select this field in the merge text template to create a column label that uses the highest date found within the column date range. If your column dates are 01/03/2022-01/09/2022, the column label for a merge text template configured as Week Ending ${BucketActualDateHigh} would be Week Ending 01/09/2022.

Report bucket example

This is a hypothetical example of how report bucket definitions can help you categorize your report data based on specified date ranges. 

The bucket type determines which input and date fields are available for configuration. The Relative Period Setup subtable fields determine the date ranges for each column. There are several fields to consider in the subtable, such as:

  • Lower range bound—Dictates the lowest date range in that column, such as the relative date (low) or relative period (low). 
  • Higher range bound—Dictates the highest date for the date range in that column, such as the relative date (high) or relative period (high). 
  • Label—Dictates what the column is labelled. 

Relative Date

For report bucket definitions with a bucket type of Relative Date selected, there are several fields to consider, such as:

  • Time Unit—Dictates whether the values in Relative Date (Low) and Relative Date (High) are counting in day or week increments. 
  • Start Date Input—Dictates the date which the Relative Date (Low) and Relative Date (High) are dependent on. The start input date specifies a report parameter name from the report version application. 
  • Date Field—Dictates which field from the record is checked by the bucket definition to determine if the record falls within the selected date range. 

The table below shows how different values would impact the date ranges for each column with a bucket type of Relative Date. 

With a Time Unit of...With a Start Date Input of...With a Relative Date (Low) of...With a Relative Date (High) of...The column shows any records that fall into the date range of...
DaysApril 1, 202200April 1, 2022
DaysApril 1, 2022-1010March 22, 2022 - April 11, 2022
Days (Invert Time Units checkbox selected)April 1, 202207March 24, 2022 - April 1, 2022
WeeksApril 1, 202200April 1, 2022 - April 7, 2022
Weeks April 1, 202202April 1, 2022 - April 21, 2022
Weeks (Invert Time Units checkbox selected)April 1, 202201March 19, 2022 - April 1, 2022

Relative Period

For report bucket definitions with a bucket type of Relative Period selected, there are several fields to consider, such as:

  • Starting Period Input—Dictates the period within the fiscal year which the Relative Period (Low) and Relative Period (High) are dependent on. 
  • Starting Fiscal Year Input—Dictates the fiscal year for the starting period input. 
  • Period Data Field—Dictates which field from the record is checked by the bucket definition to determine if the record falls within the selected period.  
  • Fiscal Year Data Field—Dictates which field from the record is checked by the bucket definition to determine if the record falls within the selected fiscal year. 
  • Aggregate Adjustment Period Input—Dictates if there is an adjustment period for the company's fiscal year which should be included in the report. 

The table below shows how different values would impact the date ranges for each column with a bucket type of Relative Period in a standard 12 period year fiscal calendar with period 13 as an adjustment period. 

With a Starting Fiscal Year Input of...With a Starting Period Input of...With a Relative Period (Low) of...With a Relative Period (High) of...The column shows any records that fall into the date range of...
2020 (no adjustment period)500Fiscal Year 2020, Period 5
2020 (no adjustment period)1-12Fiscal Year 2019, Period 12 - Fiscal Year 2020, Period 3
2020 (with adjustment period)2-24Fiscal Year 2019, Period 13 - Fiscal Year 2020, Period 6
2020 (with adjustment period)1-10Fiscal Year 2019, Period 13 - Fiscal Year 2020, Period 1

Enable bucket definitions for report version applications

Application developers use report bucket definitions in interactive reports and report version applications to group records into columns based on defined categories, such as date ranges. 

Report Builder

To allow users to select bucket definitions for use in their report version applications, you must first configure them in Report Builder. There are several sections in Report Builder which bucket definitions can be used in, such as the Header, Group Header, Footer, Group Footer, and Report Summary. Only one column needs to be set up for a bucket definition in Report Builder. Each content item in that column must have the bucket definition selected in the Bucket Definition field. Once that column is configured, the system duplicates the configuration information at runtime, such as the width and height, for each column found in that report bucket definition's subtable.

When a bucket definition is selected in Report Builder, additional options for Display Fields are available, such as: 

  • Bucket Field Value—Indicates that the individual field values show beneath the bucket definition columns that their records fall into. If a record does not fit into a bucket definition column, it prints on the report as a value of zero.  
  • Bucket Subtotal—Indicates that each column should have a subtotal of all the records listed in the bucket definition. 
  • Bucket Total—Indicates there should be a total for all of the records included in the bucket definition. 
  • Bucket Running Total—Indicates there should be a running total for each consecutive group in the report. The running total looks at the upper bound in the range defined in the bucket subtable, so any record that falls within that range in the bucket definition is included. The value for each date range column is added to the previous date range columns found in the table.

After you configure a bucket definition in Report Builder, you can enable the Bucket Definition field in report version applications. The field is a text table lookup report input where users can specify the actual bucket definition at runtime in their report version applications. 

Learn more about Report Builder in the Report Builder topic. 

Nextworld delivers already configured report bucket definitions, but you can also create your own in the Report Bucket Definition application. 

See the Report bucket example and Configure report bucket definitions topics.


Merge Text Template Setup application

Application developers use the Merge Text Template Setup application to create concatenated header values for report bucket definitions. 

Report buckets dynamically categorize records in their reports based on date ranges organized into column. The column headers must be configured with a merge text template record to show the correct value at report runtime. 

For example, the BucketActualDateHigh field isn't visible in the Report Bucket Definitions application, but it is in the Bucket Column subtable. Configure this field in the merge text template to create a column label that uses the highest date found within the column date range. If your column dates are 01/03/2022-01/09/2022, the column label for a merge text template configured as Week Ending ${BucketActualDateHigh} would be Week Ending 01/09/2022.

To configure:

  • The Template Type should be either Text or Text Area.
  • The Template should be formatted with a structure of ${FieldName} and whatever additional criteria you want. For example, ${BucketRelativeDateLow}+ Days or ${BucketRelativeDateLow} - ${BucketRelativeDateHigh} Days
  • In the Input Type Hints subtable, define each variable you included in the template. This allows the report bucket definition to identify the column header templates. 
    • The Input Name can be any field from the Bucket Column subtable in the Report Bucket Definition application. To view all of the available field options, open the BucketByRelativeDateSubtable and BucketByRelativePeriodSubtable subtables in the Table Definitions application.

Learn more in Configure report bucket definitions.

Report Bucket Definition application

Application developers and users use the Report Bucket Definition application to create or modify bucket definitions.

Report bucket definitions allows users to dynamically categorize records in their reports based on date ranges in individual columns. Date ranges can be configured in several formats, such as days, weeks, or fiscal periods. 

Learn more in the Report bucket example and Configure report bucket definitions.