Overview
An Embedded Report allows users to display a Report from a Child App directly within a Record in the Parent App. This makes it easier to view and manage related information without navigating between Apps.
For example, a Projects App can display associated Actions, Risks or Milestones within each Project Record. An Audit App could similarly display its associated Audit Questions, allowing users to answer questions without opening each Child Record individually.
Embedded Reports automatically display only the Child Records linked to the current Parent Record, making them particularly useful for managing related information in one place.
Contents
- Prerequisites and Example
- Configuring an Embedded Report
- Using an Embedded Report
- Creating and Editing Child Records
- Embedded Report Functionality
- Important Considerations
- Related Articles
Pre-Requisite & Use Case
To use an Embedded Report, the App containing the Report must be a Child App of the App in which the Embedded Report Field is created.
In this example, we will use:
- Parent App: Projects
- Child App: Action Tracker
- Report: Milestones Report
We will configure an Embedded Report within the Projects App to display the Milestones Report from the Child Action Tracker App.
When users open a Project Record, the Embedded Report automatically displays the Milestones associated with that Project, subject to the Report's configured filters and the user's Record access permissions.
Configuring an Embedded Report
Step 1: Create or Select a Report in the Child App
In App Studio, open the Child App and create or select the Report you want to embed.
In our example, we will use the Milestones Report from the Action Tracker App.
The Report can be configured with the required Fields, sorting, grouping, filters and Actions in the same way as any other Report.
Step 2: Create the Embedded Report Field
Open the Parent App in App Studio. In our example, this is the Projects App.
Navigate to the Fields configuration.
Create a new Field and select Embedded Report as the Field Type.
Configure the Field's basic properties and Embedded Report settings.
Basic Field Configuration Options
The Embedded Report Field uses the same basic configuration properties as other Field Types.
Label: The name displayed for the Embedded Report Field in the Workspace.
Identifier: A unique identifier for the Field within the Parent App.
For further information, see Basic Field Configuration Options.
Embedded Report Configuration
The following settings determine which Report is displayed and how much space it occupies.
Setting |
Description |
Embedded App |
Select the Child App containing the Report. In our example, Action Tracker. |
Embedded Report |
Select the Report to display from the chosen Child App. In our example, Milestones Report. |
Height |
Specify the vertical space occupied by the Embedded Report within the Parent Record. |
The Height setting controls the vertical space available for the Embedded Report. The Report is displayed within a fixed-height area, with internal scrolling when its content exceeds the available space.
Choose a Height that provides enough space for users to comfortably view and interact with the Report.
Note: Lenses cannot be selected directly as Embedded Reports. To provide user filtering options, configure the appropriate Fields using Preset Filters.
Step 3: Add the Embedded Report Field to a Template
Once the Embedded Report Field has been created:
- Open the relevant Template in the Parent App.
- Add the Embedded Report Field to the Template.
- Position and size the Field as required, as you would with any other Field.
- Save your changes and publish the App.
When users open a Parent Record using this Template, the Embedded Report displays the related Child Records.
//Screenshot// - Screenshot: Embedded Report Field positioned on the Parent Template — additional screenshot recommended
Step 4: View the Embedded Report in the Workspace
Open a Project Record in the Workspace using the Template containing the Embedded Report.
The Report displays the Action Tracker Records associated with that Project, using the Milestones Report's configured layout and filters.
There is no need to manually configure an additional filter to restrict the Report to the current Project. This relationship is handled automatically.
Screenshot: Embedded Report displayed within the Project Record — use the updated Workspace screenshot
Using an Embedded Report
An Embedded Report provides the same standard functionality as its underlying Report.
Depending on the Report's configuration, users can:
- Select column headings to sort Records.
- Apply available Report Filters.
- View Records using the configured sorting and grouping.
- Perform available Report Actions.
- Open and work with Child Records directly from the Report.
Filtering and Sorting
Embedded Reports use the filtering, sorting and grouping configuration of the underlying Child Report.
For example, a Milestones Report could have a Base Filter that displays only incomplete Milestones.
When embedded within a Project Record, it will display only the incomplete Milestones associated with that Project.
Users can also apply any additional filters made available through the Report configuration.
Report Actions
Report Actions are accessed using the ellipsis (...) menu in the top-left corner of the Embedded Report.
To perform a Report Action:
- Select the ellipsis menu in the Embedded Report.
- Choose the required Action.
- Select the relevant Records, where applicable.
- Select Confirm Action to execute the selected Action.
The available Actions depend on the underlying Report configuration and the user's permissions.
Creating and Editing Child Records
Embedded Reports allow users to create and edit Child Records directly from the Parent Record.
The experience depends on how the Create and Edit Actions are configured on the underlying Child Report.
Default Create and Edit Behaviour
When no customised Create or Edit Actions are configured:
- Add Record opens the full-page screen for creating a new Child Record.
- Edit Record opens the full-page screen for editing the selected Child Record.
Once the Record has been saved, users can return to the Parent Record using the back arrow.
When a Child Record is created through the Embedded Report, it is automatically linked to the current Parent Record.
The new or updated Record will appear in the Embedded Report if it meets the Report's configured filters and the user has permission to view it.
Using Pop-Up Templates for Create and Edit
For a more integrated experience, the Child Report can be configured to open a Pop-Up Template when users create or edit Child Records.
This allows users to complete these actions without navigating away from the Parent Record.To configure this behaviour:
- Create the Pop-Up Templates in the Child App. Create the Templates that will be used for creating and editing Child Records.
- Create the Action Fields in the Child App. Create a separate Action Field for each operation. When configuring each Action Field, specify whether it opens a Create or Edit Pop-Up Template.
- Configure the Child Report's Actions. Open the Report's Actions configuration and assign the appropriate Action Fields: Assign the Create Action Field to the Report's Create Action.Assign the Edit Action Field to the Report's Edit Action.
- Embed the Child Report in the Parent App. Create an Embedded Report Field in the Parent App and select the Child Report, as described in the configuration steps above.
- Add the Field to the Parent Template. Position the Embedded Report Field on the relevant Parent App Template, then save and publish the changes.
Important: Create and Edit require separate Action Fields. An Action Field configured to open a Create Pop-Up can only be selected for the Report's Create Action. Similarly, an Action Field configured to open an Edit Pop-Up can only be selected for the Report's Edit Action.
This allows you to use different Templates for creating and editing Records while ensuring that each Action performs the correct operation.For more information on configuring Report Actions, see the Actions section of the Table Report article.
Screenshot: Child Report Actions configuration showing Create and Edit Action Fields — additional screenshot recommended
Example: Creating a ToDo from a Project
In this example, a Projects App has a Child ToDo App. An Embedded Report displays the ToDo Records associated with the current Project.
The Report's Create Action has been configured to open a Pop-Up Template.
Screenshot: Project Record showing the Embedded ToDo Report — 01M5HWZ5C4K2WKPBZB5X86Q36X
When the user selects Add Record, the configured Pop-Up Template opens without navigating away from the Project Record.
The user can enter the details of the new ToDo and save the Record while remaining within the Project.Once saved, the new ToDo Record is automatically linked to the current Project and will appear in the Embedded Report if it meets the Report's configured filters and the user's access permissions.
The same approach can be used for editing existing ToDo Records by configuring the Report's Edit Action to open an appropriate Edit Pop-Up Template.
Important Considerations
Parent and Child Record Relationships
An Embedded Report automatically displays only the Child Records linked to the current Parent Record.
When new Child Records are created through the Embedded Report, they are automatically linked to the Parent Record.
Report Filters
An Embedded Report respects the underlying Report's filtering configuration, including Base Filters.
This means a Child Record may be correctly linked to the Parent Record but not appear in the Embedded Report because it does not meet the configured filters.
Record Permissions
Embedded Reports respect the access permissions configured for the Child Records.
Users can only access the Child Records and perform the operations their permissions allow.
Report Visibility
A Report can be selected and used as an Embedded Report even when its normal Report visibility is set to hidden.
This is useful when a Report is intended to be accessed through Parent Records rather than directly from the Child App's Report navigation.
Workspace Experience
Embedded Reports respect the Workspace Experience configuration of the Child App.
Publishing and Resynchronisation
When changes are made to the underlying Child Report, such as adding a column to an embedded Table Report, the Child App must be resynchronised for those changes to appear immediately in the Workspace.
Resynchronise the Child App containing the Report, not just the Parent App containing the Embedded Report Field.
If the Child App is not manually resynchronised, the changes will be picked up through the normal App synchronisation process.
Related Articles
Comments
0 comments
Please sign in to leave a comment.