Create a Report

Last updated 3/05/2024

Step 1: Add a Report

1. Click the Add Item button and give your report a title.

Figure 1 - Add a report

Step 2: Select a Data Source

A data source can be a saved table or query in Five, or an external connection that you have established in Five. All the fields and records you wish to display in your report must be in your data source. You can add multiple data sources and they will all be available to use in your report.

1. Click the Data Sources tab.

Figure 2 - Data Sources tab

2. Click the Add Data Sources button.

Figure 3 - Add Data Sources button

3. Select a data source.

Figure 4 - Data Source field

4. Click the Save button in the form app bar.

Figure 5 - Save button

Step 3: Open the Template to Design Your Report

1. Click the General tab.

Figure 6 - General tab

2. Click in the Template field.

Figure 7 - Template field

Step 4: Create the Report

The template is used to design your report. It has a ribbon that holds tools that are common to most text editors which can be used to design your report.

Add a Header

1. Click the Header tool.

Figure 8 - Header tool

The Header dialog window enables you to repeat the number of times you want to add the header.

• None - will only show the header on the first page.
• Every - will make the header repeat on every page of your report.

The Height field is for you to adjust the height of your header.

2. Set the definitions for your header and click the Insert button.

Figure 9 - Header window

tip

Columns and rows can be inserted in the header!

Click inside the header to have access to the popup ribbon. To have extra columns or rows in the header:

• Click the Add Column button and make a selection of before or after. Columns can be resized by dragging the divider.
• Click the Add Row button and make a selection of above or below.

Figure 10 - Add Column and Add Row buttons

Add Your Company Logo

Your company logo and small logo attached on the Instances form are automatically available in the Tags dropdown. For this example, the logo will be added to one of the columns in the header.

3. Postioned in a cell, select Logo in the Tags dropdown.

Figure 11 - Logo tag

Add a Heading

tip

The Insert Format Block tool is used to select your heading level!

Figure 12 - Insert Format Block tool

4. In a cell, type and format your heading.

Figure 13 - Add a heading

Add a Table

Once your table is added, you can then use the Insert Fields tool to add captions and records.

The Fields window will hold all the data sources that you selected outside the template and function helpers, whether they are inbuilt or custom written by you. While in the Fields window you can:

• Select the captions and fields from your data source.
• Use helper functions to format your returned data.
• Select how you want to apply the records in your table.

5. Click the Insert Table button tool and highlight the rows and columns.

Figure 14 - Insert Table tool

6. Click the Insert Fields tool.

Figure 15 - Insert Fields tool

7. Select your data source in the Data Source field.

8. Select Captions in the Reserved Field field.

Figure 16 - Fields window

9. Select all the fields you require from your data source in the Fields field.

Figure 17 - Fields window

10. Apply to the row.

Figure 18 - Fields window

11. Click the Insert button.

Figure 19 - Fields window

tip

Ensure you are in the first clean cell of your table under the caption row!

12. Click the Insert Fields tool again.

13. Select Built In in the Category field.

14. Select _Each in the Function field.

info

The _Each function will iterate over a set of records in your data source. It will loop through your records and separate each row returned from your data source.

15. Select your data source in the Data Source field.

16. Select all the fields you require from your data source in the Fields field.

17. Apply to the row and click the Insert button.

Figure 20 - Fields window

Add a Footer

18. Click the Footer tool.

Figure 21 - Footer tool

19. Set the definitions for your footer and click the Insert button.

Figure 22 - Footer window

Add Page Numbers

20. Click the Insert Page Number tool.

Figure 23 - Insert Page Number tool

21. Click the Insert button.

Figure 24 - Page Number window

Step 5: Save a Report

1. Click the Save button in the editor app bar.

Figure 25 - Save button

2. Click the Save button in the form app bar.

Figure 26 - Save button

tip

To generate your report in your application, you need to make a menu item and reference this report!

Download a Report

In Windows, once the report has generated in your application, you can click the Save button and the report will be downloaded to your local computer in a PDF file.

Figure 27 - Save button

In Mac, once the report has generated in your application, you can click the Download button and the report will be downloaded to your local computer in a PDF file.

Figure 28 - Download button

Print a Report

Once the report has generated in your application, you can click the Print button.

Figure 29 - Print button