A report data source table can be a standard table or a flat table. Learn more about flat tables in the Flat table reports topic.
All the data stored in the data source table becomes available in the Report Builder application. Report Builder is where you build a report template and the report structure. The template is an outline of which data items you want represented in the report, and the structure determines how the report and data looks when the report is generated by users. Learn more about Report Builder in the Report Builder section.
Application developers can create report templates and report version applications that allow business users to generate reports.
In order for users to run reports, you need to build a report table over the Report Builder template, and a Report Version application over the report table. The Report Version application is where users can define their criteria for what data they want reflected in a report.
The diagram below depicts the report building process using the following Nextworld objects:
Data source table—The standard or flat table with data that you want to be displayed in a report. This can be a new or existing table. | |
Report Builder—Define basic information about the report and design a template for how you want data presented in the generated report. | |
Report table—Create a table to build a report version application over. | |
Report Version application—Build an application of type Report Version over the report inputs table, and specify the report. In this application, users can specify parameters and run the report. | |
Report version—Business users can create multiple records in the report version application, each with different parameters. | |
Report—Business users can run a report version record to view a finalized report. |
Email reports configuration
Configure emails to be sent automatically when a report is generated with the Message Event Definitions, Logic Block Builder, Message Template Setup, and Message Definitions applications. Successful report generations are included as a PDF attachment on the emails.
Configure report emails with the following applications:
- Message Event Definitions application—Define the event that triggers the message to be sent. Specify the table which you want to retrieve records from which can include addresses for your emails, or interpolated values for your message content. The report execution triggers the message event.
- Logic Block Builder application—Define the parameters for the Queue Report action. You can configure the event to be queued based on report success, or report failure.
- Message Template Setup application—Define the content for the messages. Reference the table from the message event to include interpolated values in your message content.
- Message Definitions application—Define the message template, message event, and associated configuration. Together, they create the automated messages and notifications which the system sends to recipients when the report is queued.
Message Event Definitions
In the Message Event Definitions application, create a message event and define the tables you want associated with your messages. This is most commonly the table the report version application is built over, but it could be any table that contains relevant information you want to reference in your message.
Logic Block Builder
In the Logic Block Builder application, configure a Queue Report action. In the details of the action, you must:
- Specify the report version application.
- Enter the name of the message event in either the Queue Message Event on Report Success, or Queue Message Event on Report Failure section.
If the logic is configured on Report Success, the PDF is automatically included in the configured messages if the report successfully generates.
For Report Failure, only the message from the message template is included.
Message Template Setup and Message Definitions
In the Messages Template Setup application, create your message and designate the recipients. You can optionally include interpolated values from a table your message event is built over.
Once your message event, logic block, and message template have been configured, reference them in a message definition. There are additional configuration options available for messages. Learn more in the Message configuration topic.
Report Execution History application
Use the Report Execution History application to review records for successful and failed report executions.
Each record contains information about a report execution, such as the report parameters, output files, and error messages if the execution failed. Only user initiated executions are traced within the application.
Execution Inputs page
Review information about the execution attempt, such as the status, report version, and the user who ran the report.
Execution Variables page
Review additional details about the report which was executed, such as associated logic blocks and security settings.
Errors page
Review any error messages populated during execution.
Output page
Review the report output, including the attachment and a preview of the data.
Report Settings application
Adjust reports to fit your needs with the Report Settings application.
Report settings override aspects of existing reports. You can create and apply report settings to change the format of currency items, apply watermarks, and more.
Create report settings in the Report Settings application. There are different types of report settings, including:
- Default report settings—Apply automatically to every report version created from the specified report. Reports can only have one default report setting. To create a default report setting, specify a report in the Default Report Name field in the Report Settings application.
- Report version settings—Apply to an individual report version only.
If you apply a report version setting to a report that has a default report setting, both settings apply. However, if there are conflicts between the settings, the report version setting overrides any conflicting values.
For example, a report may have a default report setting that applies your company name as a watermark and sets the ReportPaperSize to Letter (8.5 x 11in) 215.9 x 279.4mm. You create a report version and apply a report version setting that does not specify a watermark, but displays currency values without currency codes and sets the ReportPaperSize to A4 (8.25 x 11.75in) 210 x 297mm. When you run the report, it has the company watermark, displays no currency symbols, and has a ReportPaperSize of A4 (8.25 x 11.75in) 210 x 297mm.
Report layouts
System administrators use the Report Builder application to create alternate layouts for their reports. Business users can select these alternate layouts in report version applications.
A report layout has the same components as its parent report, but with an alternate template design created in Report Builder. When a business user creates new versions of a report in a report version application, they can select an alternate report layout as an input.
For example, you may need to adjust the position of the signature line on a check based on the format required by a bank. You could create a report layout over the existing check report and move the signature line to the correct position. When business users access the report version application to run their check report, they can create a new report version and specify the report layout. When they run the report, the signature line on the check is in the correct position.
Report layouts are records in the Report Builder application. Create report layouts with the Create Alternate Layout row action on the report you need an alternate layout for. After you save the report layout record, you can open it in Report Builder and adjust the design of the report template. Learn more about designing report templates in Report Builder.
Configure application links in Report Builder
Configure a report with links to applications with the Report Builder application. This allows users to select links in the report output that open records that hold related information.
In the Report Builder application, you must:
- In the Structure panel, select the Application Links section.
- In the Detail panel, configure application links in the subtable. You can select the application, application settings, and form you want to open. This is most often the list form.
- Select the Edit Mappings button to open the Data Mapper. Map the report values as the source, and the application you're linking to as the destination. Make sure everything you want mapped when you create the application link is configured. See the Data mapper topic for more information.
- Select the content item which you want to display as a link in the report output. You can select content items in either the Structure or Viewer panel.
- In the Editor panel, use the Application Link field to select the application link to use. This can be the application link you just configured.
Ways to include reports in application records
You can configure reports to be automatically attached or associated with application records.
Options include:
- Configure an application link to navigate to a report version from the application record. Optionally, data map specific fields to provide change the functionality.
- Attach a report version record to the application record. Use the inline attachment viewer to view the attached report.
- Use the Queue Report action to run a designated report version application in the background. Send the report output to a desired location, such as an application record or a centralized table.
Navigate to a report version with an application link
If you would like an application link to run a report automatically then it must meet the following criteria. On the Actions page in the Application Builder application, you must:
- Add a new application link to the Application Links subtable.
- Name the application link and define the report version application that the link should open to.
- Choose
Containerin the Form field. - Choose
Containeras the Destination Region for all your data mappings. - Add an additional field mapping into a value that doesn't exist in any report versions. For example, map a constant such as
NonExistentVersioninto one of your report inputs.
If you don't want your application link to run a report automatically, configure your data mappings to match an existing report version.
You can data map the following fields to achieve different functionality in your application link:
ReportDisplay—Control what type of file the report is formatted in. For example, PDF.ReportAttachmentRecordId,, andReportAttachmentName—Control if the report version is saved to the application record.ReportAttachmentTableReportAttachmentRegenerate—If you provide the ReportAttachmentRecordId, ReportAttachmentName, and ReportAttachmentTable parameters and leave this cleared, the previously generated report is attached. If you select this, a new report is generated and overwrites the previous record.
Export Excel/CSVs in Report Builder
Excel and CSV outputs are created by default when reports are generated. Configure the report information and columns you want included in the outputs in Report Builder.
All report outputs, such as Excel, PDF, CSVs, and Word, are created by default when reports are generated. If you don't want all output formats included, select Report in the Structures panel. The Output Formats field on the Detail panel allows you to select which outputs you want created when the report is generated. If a value is selected, the rest of the outputs are excluded. If none are selected, all the report outputs are created when the report generates.
Column Configuration
Each content item in the report has an optional Export Column field in the Details panel. Add an export column value to reposition content items so that headers and footers can align with detail content items in the same column. The content item with the largest pixel width determines the size of the column in CSVs and Excel.
Select the Exclude From Excel Output checkbox if the content item should not be included in the output. This can be selected in individual content items, or from a section level if all content items in that section should be excluded.
Select the Show Export Columns toggle in the Report Builder to show the configured export column values in the Viewer panel. The number for each column appears next to the content item it is configured on.
Once the report is generated, the outputs are accessible from the Report Executions application.
Group records in a report
Use the Add Group function in Report Builder to group and summarize report data in the report outputs. Configure report groups with values such as Company Name, GL Account number, or Ledger Name, to show summarized data in the rows of the report.
You can select one, or many, values to group by. For example, if you grouped by Company and GL Account 1, and both Company A, and Company C have records associated with that GL account. All of the records for Company A in GL Account 1 would be summarized in one row, and all of the records for Company C in GL Account 1 would be summarized in a second row. See the Group report records example topic for more information.
Column headers for each Group Header are created in the report. The Group Header section shows the first record in the dataset that matches the Group By criteria and content items selected.
Group Footers are created when a Group Header is configured. Use Group Footers to show aggregated and summarized data for all the of rows included in the output.
See the Group report records configuration topic for more information.
Group report records example
This topic shows a hypothetical example of how Group By configurations can be used in Report Builder.
The group headers are prioritized based on the order which they are listed in the report template.
Group Header 1: GL Account 1
Group Header 2: GL Account 2
Group Header 3: Org Unit
| Fiscal Year 2022, Period 1 | Fiscal Year 2020, Period 3 | ||
| GL Account 1 | |||
| Org Unit 1 | Summarized data for all records for Org Unit 1, in GL Account 1, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 1, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Org Unit 2 | Summarized data for all records for Org Unit 1, in GL Account 2, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 2, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Org Unit 3 | Summarized data for all records for Org Unit 1, in GL Account 3, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 3, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Group Footer | Total summarized data for all Org Units, in GL Account 1, in Fiscal Year 2022, Period 1 | Total summarized data for all Org Units, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| GL Account 2 | |||
| Org Unit 1 | Summarized data for all records for Org Unit 1, in GL Account 2, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 1, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Org Unit 2 | Summarized data for all records for Org Unit 2, in GL Account 2, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 1, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Org Unit 3 | Summarized data for all records for Org Unit 3, in GL Account 2, in Fiscal Year 2022, Period 1 | Summarized data for all records for Org Unit 1, in GL Account 1, in Fiscal Year 2020, Period 3 | |
| Group Footer | Total summarized data for all Org Units, in GL Account 2, in Fiscal Year 2022, Period 1 | Total summarized data for all Org Units, in GL Account 1, in Fiscal Year 2020, Period 3 | |
Group report records configuration
Configure the Group By feature in reports with the Report Builder application.
Prerequisite
In the Report Builder application, open the report you want to configure. In the Structure panel, select Sort and configure the sorts you want used in the report template. You can select which value you want to sort by, and how you want to sort it. For example, Sort Ascending and Company Name.
Group Header and Group Footer
To configure Group Headers and Group Footers in Report Builder:
- In the Viewer panel, on the Detail section, select the Add Group
button to create a Group Header and Group Footer.
- In the Viewer panel, select the Group Header section you created. In the Details panel, select the value or values you want to group by. For example,
Company Name. - Optionally, select a Dynamic Indent Field value to control the depth of indent you want used for that group. For example, you may want each Group Header indented at a different depth.
- Configure the Group Footer section you created. Optionally, select a Display field value, such as
Subtotal,Aggregation,Minimum, orMaximum. If you are using Dynamic Indent Fields in the Group Header, select the Dynamic Indent checkbox in the Group Footer.
Multi-currency groups in reports
Group multi-currency records in reports by configuring sorts and groups in Report Builder. By grouping by currency code, records are more organized in a report, and make it easier to perform calculations for groups of records with the same currency code.
Group records by currency code
First, add a sort to order the records by their currency code. Then configure a multi-currency group within a group header by selecting a currency field for the records to be grouped by. When the field you are using to group by is a currency field, Nextworld automatically groups records by their currency code.
For example, if your driver table contains currency records with both United States Dollar (USD) and Canadian Dollar (CAD) currency codes, sort records by their currency code and configure a multi-currency group. In the report output, one group displays USD records and another group displays CAD records.
Multi-currency calculations
You can only preform calculations with currency records that have the same currency code. If you try to configure a currency formula in a report with records that have different currency codes, the formula field is left blank in the report output. Instead, configure formulas within the Group Footer or Detail sections to see accurate calculations of currency records for each group in the report output.
Configure report layouts with customer defined attributes
System administrators configure report layouts to include their customer defined attributes (CDAs) using the Customer Defined Attribute Management and Report Builder applications.
Customer Defined Attribute Management application
In the Customer Defined Attribute Management application, you must:
- Configure a type CDA profile.
- In the Configure Reports application step, select Activate for Report checkbox on the report you want to include your CDAs.
- In the Activations application step, Activate the configuration.
Report Builder
In the Report Builder application, you must:
- Use the Create Alternate Layout action on the report you want to display your CDAs. Learn more in Report layouts.
- Open the new report layout and add your CDAs as content items. Users can select this new report layout in their Report Version applications.
Subreports
Subreports are portions of one report, such as a subtable or check stub, placed inside of a different report.
Subreports are added to other reports in the Report Builder application. You can select the location for the subreport, as well as the inputs you want passed from the report template to the subreport. For example, you may want to pass inputs for the Company name and Org Unit so that the subreport only shows data relevant to whichever Company you are viewing in the main report. This allows you to see different sets of data in the subreport depending on what record is being viewed in the main report.
Learn more in Configure subreports in Report Builder.
Configure subreports in Report Builder
Configure subreports in Report Builder to reference a report template inside of another report template.
Prerequisites
You must already have a record created in the Report Builder application for the report you want included as a subreport.
Report Builder
In the Report Builder application, you must:
- Select the section of the template you want the subreport to populate in, and add a new Content Item.
- In the Details panel, select
Subreportin the Type field. - Enter the name of the report template you want to reference.
- Select the Inputs from the report template that you want passed into your subreport.
Configuration considerations
- You can configure a subreport inside another subreports. Additional levels of nested subreports are not permitted.
- There is no limitation on the amount of subreports you can add into a report, though performance will decrease.
- Subreports do not need to be configured with page margins.
- The size of the subreport is dependent on the page size and content height. Subreports expand to the size of the output they create.
Learn more in Subreports.