In order to create a report based on your forms' data, you must first enable the forms in Apricot Results Reporting (ARR). To learn how to do this, click here. Once this setting has been changed, it takes at least fifteen minutes before the Tier 1 form becomes available as a reporting universe, or data source, in the ARR interface. To learn how to access ARR, click here.
Follow the steps listed below to learn how to create a basic Results report within ARR.
Step 1: Select a data source
From the ARR homepage, select "Web Intelligence" under Applications.
This will create a blank report, and you'll be asked to select a data source for the new document. Select the first option, "Universe", then click the OK button to generate a list of all available reporting universes.
All Tier 1 forms in your organization that have been enabled in ARR will have its own associated universe on this list, and they'll contain data for each associated Tier 2 form that's been enabled for ARR too.
You'll also see standard universes that do not have your database's unique ID or form names in the titles; however, we recommend avoiding these as beginner report builders as they are more technically demanding to work with.
Select the Tier 1 form you want to build your report with, and click the OK button at the bottom-right. For our example, we've selected the Participant Profile universe.
Step 2: Select your report objects
Once you've selected a universe, the Query Panel window will appear. On the left menu, click the arrow next to the Tier 1 form name to view all its fields. You'll find folders for the associated Tier 2 forms that have been enabled in ARR toward the bottom of the Tier 1 folder.
The fields you see under each form are called "objects" in ARR. They are represented by the blue icons and are the data points generated from our selected universe. There are also arrows next to certain objects you can click to find "details" represented by green icons; these are more specific fields within the object, like a program or site's ID.
Carefully consider what data you plan to report on, and bring only the objects you need over to the "Results Objects" panel. You can double-click the object name from the left menu or drag and drop it into the Results Objects section. Clicking on an object in this section will highlight it in the object menu on the left so you can locate them easily.
The fields here will be automatically generated into a table when you run the report query for the first time. You can drag and drop your Results Objects to reorder them in the panel, which will adjust the order of the columns in the table.
Step 3 (optional): Add a query filter
The next step of creating a new query is the filtering the data brought into the report as necessary. Dragging an object from the left-hand menu into the Query Filters panel allows you to specify what subset of data you want to see your selected objects for. We recommend doing this wherever applicable, as it prevents your report from pulling unnecessary data that could slow down reporting performance.
For example, you can create a query filter based on the Site Name object and choose which site(s) you want to see associated data for. The first dropdown field shows available operators, such as "In List," "Equal To," "Not Equal To," and more.
The three-line icon (or hamburger menu) to the right expands some filter options. Selecting "Constant" here will allow you to manually type in the value you want to filter the report by each time the report is run. If you previously selected the "In List" operator, choosing "Value(s) from list" here will generate the available values for the selected object.
You can also select "Prompt" from the filter options to allow users flexibility to choose what to filter the report by each time they run the report. They'll have the option to enter the value manually or select from the list of values.
Step 4: Run the report
Once you've set up your query, select "Run" in the bottom-right corner of the Query Panel.
This will generate your first table in the new report. To the right are the "dimensions," or data points we chose to include in the Results Objects panel. Any objects you create within the report later, otherwise known as variables, will also be listed here. To ensure this panel is visible, click the clipboard icon in the top-right corner of ARR.
Step 5 (optional): Add queries and report tabs
At the top of the ARR page, under the Data section, you'll find an icon depicting a graph and gear. Clicking this will open the Query Panel again for you to make adjustments to your included objects or query filters. Be sure to select "Apply Changes and Close" at the bottom of the Query Panel once you're done.
Note: Any objects you add to the query after the report's initial run will be added to the Dimensions panel, but will have to be manually dragged into the existing table.
A report can have multiple queries to include different data from a universe, or data from different universes. The 'Add Query' button is at the top-left of the Query Panel window, and you'll follow the same steps for selecting a data source as your first query.
Click 'Run' at the bottom of the Query Panel, and you'll be asked whether you want to create a new report (or tab within your document) for the table generated from the query. You can also choose to insert the new table in the same report tab as the first table, or omit the table altogether from the report and just include the selected objects in the report.
If you choose to create a new report, you'll now see two tabs in your document named "Report 1" and "Report 2". Click on the arrows to rename your tabs; you can also create blank reports by clicking the '+ New' button in this dropdown.
Step 6: Save the report
Click the floppy disk icon at the top-left corner of ARR, then select Save to add your new report to a folder.
Name your report and use the arrows to navigate to the folder you want to store the report in. Finally, click Save to be brought back to your report.
We recommend you click the Save icon often as you continue building your report so as to not lose any of your work. To learn more about saving reports, click here.
What else do you need help with?
Not what you're looking for? Navigate to overview