Skip to main content

Using the Join Aggregate Function in Finished Reports

Garrick Guillory
Updated

The Join() aggregate function can be used in Finished Reports to combine multiple related text values into a single string.

This is useful when grouped records contain several values that you want to display together instead of showing them on separate rows.

What Is the Join Aggregate Function?

The Join() aggregate function combines multiple values from records in the same group into a single line of text.

For example, if a Finished Report is grouped by Client and each Client has several Disposition values, Join() can display those Disposition values together in one Label.

Example output:

Paid, Promise to Pay, Left Message

Instead of displaying each Disposition on a separate detail row, the values can be summarized together for the current Client group.

Why Use Join?

Use Join() when you want to:

  • Combine multiple related text values into one Label
  • Summarize grouped information in a more compact format
  • Reduce the need to display several detail rows
  • Display related values in a Group Header or Group Footer
  • Control how the returned values are separated, such as with commas

Join Aggregate Syntax

The basic syntax is:

[Collection][Condition].Join(Expression)

You can also specify a separator:

[Collection][Condition].Join(Expression, Separator)

For example:

[][[Client] == [^.Client]].Join([Disposition], ',')

This returns all Disposition values for the current Client group and separates them with commas.

Download Sample

A sample VDM View is available to demonstrate the Join aggregate configuration used in this article.

Download Sample View

Step 1: Open and Run the View

Open the VDM View containing the data you want to use and select Run View.

Step 2: Open Finished Reports Designer

After the View finishes running, open Finished Reports Designer.

Step 3: Select the Label

Select the Label where you want the joined values to appear.

This is commonly a Label within a Group Header.

Step 4: Open Label Tasks

Select the Label's smart-tag button to open Label Tasks.

Step 5: Open the Expression Editor

In Label Tasks, select the ellipsis button next to Expression to open the Expression Editor.

Step 6: Enter the Join Expression

Enter the Join() expression.

For example:

[][[Client] == [^.Client]].Join([Disposition], ',')

In this example:

  • Client identifies the grouping field.
  • [^.Client] references the Client value for the current group.
  • Disposition is the field whose values are combined.
  • ',' separates each returned value with a comma.

Step 7: Preview the Report

Select Preview and confirm that the grouped values are combined into a single string.

For example, multiple Disposition values for the same Client should appear together in one Label.

Save the Report

After confirming that the joined values display correctly, save the Finished Report.

Related Articles

Related articles

Comments

0 comments

Please sign in to leave a comment.