{"id":2054052,"date":"2023-08-28T12:30:46","date_gmt":"2023-08-28T19:30:46","guid":{"rendered":"https:\/\/www.esri.com\/arcgis-blog\/?post_type=blog&p=2054052"},"modified":"2024-06-07T10:27:01","modified_gmt":"2024-06-07T17:27:01","slug":"get-started-with-survey123-reports","status":"publish","type":"blog","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports","title":{"rendered":"Get started with Survey123 reports"},"author":344552,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"_searchwp_excluded":""},"categories":[37511],"tags":[771522,29441,42371],"industry":[],"product":[36691],"class_list":["post-2054052","blog","type-blog","status-publish","format-standard","hentry","category-sharing-collaboration","tag-report-template","tag-reports","tag-survey123","product-survey123"],"acf":{"authors":[{"ID":344552,"user_firstname":"Barbara","user_lastname":"Webster","nickname":"bwebster","user_nicename":"bwebster","display_name":"Barbara Webster","user_email":"bwebster@esri.com","user_url":"","user_registered":"2023-08-16 18:22:23","user_description":"","user_avatar":""}],"short_description":"Share your Survey123 results with others by exporting your data to a Word or PDF format report. ","flexible_content":[{"acf_fc_layout":"content","content":"

One of the features of Survey123 is exporting custom PDF or Word format reports based on survey data. If you are new to Survey123 or haven\u2019t explored Survey123 reports yet, this blog will help you get started with creating reports.<\/p>\n

Reports are generated based on a report template associated with the survey. A report template is a Microsoft Word document that provides the report formatting and includes placeholders to indicate where survey data should be inserted when the report is exported. Since the template is a Word document, almost any formatting options that are possible in Word can be included in your template. This could include images or logos, text formatting, tables, headers, and footers. This customizability is useful for designing visually appealing reports, but it is also useful when adhering to a required report format, for example when submitting data to a government agency. See below for examples of report templates and an example of an exported report.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":2054082,"id":2054082,"title":"Frame 3","filename":"Frame-3-1-scaled.jpg","filesize":459075,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-scaled.jpg","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/frame-3-5","alt":"","author":"344552","description":"","caption":"","name":"frame-3-5","status":"inherit","uploaded_to":2054052,"date":"2023-08-16 18:42:48","modified":"2023-08-16 18:42:48","menu_order":0,"mime_type":"image\/jpeg","type":"image","subtype":"jpeg","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":2560,"height":1686,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-213x200.jpg","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-scaled.jpg","medium-width":396,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-scaled.jpg","medium_large-width":768,"medium_large-height":506,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-scaled.jpg","large-width":1640,"large-height":1080,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-1536x1012.jpg","1536x1536-width":1536,"1536x1536-height":1012,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-2048x1349.jpg","2048x2048-width":2048,"2048x2048-height":1349,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-706x465.jpg","card_image-width":706,"card_image-height":465,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-3-1-1640x1080.jpg","wide_image-width":1640,"wide_image-height":1080}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"image","image":{"ID":2054062,"id":2054062,"title":"Frame 2","filename":"Frame-2-scaled.jpg","filesize":368157,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-scaled.jpg","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/frame-2-12","alt":"","author":"344552","description":"","caption":"","name":"frame-2-12","status":"inherit","uploaded_to":2054052,"date":"2023-08-16 18:41:10","modified":"2023-08-16 18:41:10","menu_order":0,"mime_type":"image\/jpeg","type":"image","subtype":"jpeg","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":2560,"height":1686,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-213x200.jpg","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-scaled.jpg","medium-width":396,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-scaled.jpg","medium_large-width":768,"medium_large-height":506,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-scaled.jpg","large-width":1640,"large-height":1080,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-1536x1012.jpg","1536x1536-width":1536,"1536x1536-height":1012,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-2048x1349.jpg","2048x2048-width":2048,"2048x2048-height":1349,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-706x465.jpg","card_image-width":706,"card_image-height":465,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-2-1640x1080.jpg","wide_image-width":1640,"wide_image-height":1080}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"content","content":"

The Survey123 website is the central hub for viewing submitted data and managing various survey settings and features, including reports. The report template is added to the survey by uploading the template file in the Manage templates option on the Reports tab on the survey\u2019s Data tab. Once at least one report template is uploaded, reports for one or multiple records can be exported.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":2057302,"id":2057302,"title":"report_export_compressed","filename":"report_export_compressed.gif","filesize":4666320,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/report_export_compressed","alt":"","author":"344552","description":"","caption":"","name":"report_export_compressed","status":"inherit","uploaded_to":2054052,"date":"2023-08-18 21:07:21","modified":"2023-08-18 21:07:21","menu_order":0,"mime_type":"image\/gif","type":"image","subtype":"gif","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":1220,"height":692,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed-213x200.gif","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","medium-width":460,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","medium_large-width":768,"medium_large-height":436,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","large-width":1220,"large-height":692,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","1536x1536-width":1220,"1536x1536-height":692,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","2048x2048-width":1220,"2048x2048-height":692,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed-820x465.gif","card_image-width":820,"card_image-height":465,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/report_export_compressed.gif","wide_image-width":1220,"wide_image-height":692}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"content","content":"

Report types \u2013 individual vs. summary<\/h2>\n

There are two types of reports in Survey123: individual reports and summary reports. It\u2019s also possible to include both in the same report, in which case they would be individual and summary sections.<\/p>\n

An individual report<\/em> displays the data for a single survey record, while a summary report<\/em> displays data for multiple records in one report. Summary reports often aggregate the data using statistics. For example, if we have a survey that documents a water violation, an individual report will show details for a single specific water violation. A summary report, on the other hand, would display statistics for multiple violations, for example the total count of violations or the total count of each type of violation.<\/p>\n

The report template’s syntax determines whether a report will be a summary report or an individual report. A summary report has a designated start tag and end tag, and everything between the two tags will be treated as a summary section.<\/p>\n"},{"acf_fc_layout":"content","content":"

Report templates<\/h2>\n

Report templates support a wide array of options for displaying your survey data, but there are a few ideas that are the core components<\/span> to even the most complex reports:<\/p>\n

\u2022 Question placeholders \u2013 Returns the value for the question name indicated. For example: ${question_name}<\/code><\/p>\n

\u2022 Repeat start\/end tags \u2013 Accesses questions within a repeat in a survey. Questions from the repeat can be displayed by including question placeholders between the start and end tags.<\/p>\n

\u2022 Methods and parameters \u2013 Methods and parameters are additional syntax appended to start tag or question placeholder that modifies the returned value in some way.\u00a0For example, the syntax ${geopoint1 | getValue:\"x\"}<\/code> will return this geopoint\u2019s x-coordinate because the getValue method is applied to the question placeholder and the parameter is set to x.<\/p>\n

\u2022 Summary sections \u2013 Aggregates the question values for multiple survey records. A summary section is designated with a summary section start tag ($<$summary><\/code>) and end tag ($<\/><\/code>).<\/p>\n

These are the foundational concepts for creating a report template, but it\u2019s not necessary to create report templates from scratch. There are several resources<\/span> to help you get started with a report template quickly.<\/p>\n

Quick reference<\/h4>\n

The first resource for getting started with building a template is the quick reference. This option provides examples and descriptions for various methods and parameters that can be used for each question in your survey.<\/p>\n

These syntax snippets include the question names from your survey, so they can be copied and pasted directly into your report template. The quick reference section is a good way to discover the different report syntax options that are available.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":2054352,"id":2054352,"title":"Frame 4","filename":"Frame-4-1-scaled.jpg","filesize":251534,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-scaled.jpg","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/frame-4-2","alt":"","author":"344552","description":"","caption":"","name":"frame-4-2","status":"inherit","uploaded_to":2054052,"date":"2023-08-16 21:24:59","modified":"2023-08-16 21:24:59","menu_order":0,"mime_type":"image\/jpeg","type":"image","subtype":"jpeg","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":2560,"height":1579,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-213x200.jpg","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-scaled.jpg","medium-width":423,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-scaled.jpg","medium_large-width":768,"medium_large-height":474,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-scaled.jpg","large-width":1751,"large-height":1080,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-1536x947.jpg","1536x1536-width":1536,"1536x1536-height":947,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-2048x1263.jpg","2048x2048-width":2048,"2048x2048-height":1263,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-754x465.jpg","card_image-width":754,"card_image-height":465,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-4-1-1751x1080.jpg","wide_image-width":1751,"wide_image-height":1080}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"content","content":"

Sample templates<\/h4>\n

Another resource for getting started with report templates is the sample template option in the Survey123 website. This option generates a report template that includes the labels and placeholder syntax for all questions and repeats in your survey. You can then modify this template by removing unwanted questions, reordering questions, adding methods, and so on.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":2054272,"id":2054272,"title":"Export a report template","filename":"Export-a-report-template-1.gif","filesize":2142715,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/export-a-report-template-2","alt":"","author":"344552","description":"","caption":"","name":"export-a-report-template-2","status":"inherit","uploaded_to":2054052,"date":"2023-08-16 20:49:09","modified":"2023-08-16 20:49:09","menu_order":0,"mime_type":"image\/gif","type":"image","subtype":"gif","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":1048,"height":768,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1-213x200.gif","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","medium-width":356,"medium-height":261,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","medium_large-width":768,"medium_large-height":563,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","large-width":1048,"large-height":768,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","1536x1536-width":1048,"1536x1536-height":768,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","2048x2048-width":1048,"2048x2048-height":768,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1-635x465.gif","card_image-width":635,"card_image-height":465,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Export-a-report-template-1.gif","wide_image-width":1048,"wide_image-height":768}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"content","content":"

Esri templates gallery<\/strong><\/h4>\n

If you\u2019d like to see examples of completed report templates, some of the Esri templates available in Survey123 Connect include report templates that can be used with the samples. You can find these by opening Connect, clicking Esri Templates, and searching for \u201creport template\u201d. The survey template description includes a hyperlink to the report template.<\/p>\n"},{"acf_fc_layout":"image","image":{"ID":2054362,"id":2054362,"title":"Frame 5","filename":"Frame-5-1-scaled.jpg","filesize":263047,"url":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-scaled.jpg","link":"https:\/\/www.esri.com\/arcgis-blog\/products\/survey123\/sharing-collaboration\/get-started-with-survey123-reports\/frame-5-2","alt":"","author":"344552","description":"","caption":"","name":"frame-5-2","status":"inherit","uploaded_to":2054052,"date":"2023-08-16 21:25:52","modified":"2023-08-16 21:25:52","menu_order":0,"mime_type":"image\/jpeg","type":"image","subtype":"jpeg","icon":"https:\/\/www.esri.com\/arcgis-blog\/wp-includes\/images\/media\/default.png","width":2560,"height":1375,"sizes":{"thumbnail":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-213x200.jpg","thumbnail-width":213,"thumbnail-height":200,"medium":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-scaled.jpg","medium-width":464,"medium-height":249,"medium_large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-scaled.jpg","medium_large-width":768,"medium_large-height":413,"large":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-scaled.jpg","large-width":1920,"large-height":1031,"1536x1536":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-1536x825.jpg","1536x1536-width":1536,"1536x1536-height":825,"2048x2048":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-2048x1100.jpg","2048x2048-width":2048,"2048x2048-height":1100,"card_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-826x444.jpg","card_image-width":826,"card_image-height":444,"wide_image":"https:\/\/www.esri.com\/arcgis-blog\/app\/uploads\/2023\/08\/Frame-5-1-1920x1031.jpg","wide_image-width":1920,"wide_image-height":1031}},"image_position":"center","orientation":"horizontal","hyperlink":""},{"acf_fc_layout":"content","content":"

Documentation<\/strong><\/h4>\n

The final resource for exploring report templates is the Survey123 Report templates documentation<\/a>. This documentation describes all the supported report functionality, and includes a helpful table of all the methods and parameters that can be used in reports.<\/p>\n"},{"acf_fc_layout":"content","content":"

What are the requirements for authoring and generating a Survey123 report?<\/h2>\n

Surveys in ArcGIS Online<\/strong><\/em> are generated by an ArcGIS Online premium service. If your survey is hosted in ArcGIS Online, each report will cost 0.5 credits plus 0.5 credits for each additional survey record included in the report (except summary reports).<\/p>\n

Survey123 reports can be used with ArcGIS Enterprise<\/strong><\/em> with some exceptions. The following list of exceptions was written by Ismael Chivite when the report functionality was originally released in 2019 but is still applicable.<\/p>\n