Skip navigation
All Places > Survey123 for ArcGIS > Blog > 2017 > July
2017

Tile Package Kreator

Tile Package Kreator -  the desktop utility used for the easy creation of Tile Packages (i.e. local basemaps that you can take offline in Survey123 for ArcGIS, Collector for ArcGIS and ArcGIS Runtime apps) has just been updated! Version 1.2 comes complete with a number of enhancements that will make the app easier and more intuitive to use. To find out how to use it - please see the following blog:Taking your maps offline with Tile Package Creator.

 

Esri Labs projects are developed by Esri employees and are inspired by our interactions with ArcGIS users like you. Esri Labs projects are free to use but are not official Esri products. These projects do not go through the rigorous software development cycle so they are not holistically tested, documented or supported by Esri technical support.

 

But for now let’s run through what’s new:

 

New functionality

You can now navigate to your desired location using a place name or address, and once there, you can draw polygons (as well as squares and polylines) to define your export extent. If you want to revisit the extent at later date, you can now save these drawn extents as spatial bookmarks (which can be exported to geojson too). TPK 1.2 will also enable you to interactively define the range of zoom levels you want to export – so if you want to export for example levels 4-12, this is now possible.

 

Improvements

To make life easier, you can now switch tile services/basemaps without having to return to the gallery, and any public tiled service that you added to app will be persisted (so no need to keep re-entering them). There have also been a number of bug fixes related to the UI and file management.

 

If you want to get your hands on the latest version of the app – please visit here: ArcGIS Marketplace

The latest version of the guide can be downloaded here: Guide

And finally - to provided feedback, please go here: github.com

As stated in the 2.3 release blog post, custom form report templates are now available in Survey123. This feature allows for exporting data submitted from Survey123 into printable documents. The highlight is that the look and feel of the output report can be easily customized to include headers, footers, external images, images from survey, the map from survey etc. Your hard copy survey report documents can be fully customized to meet your business needs.

 

This feature is now in Beta and as such there are some limitations around this functionality, but given how important this is to many of you we wanted to share it with you early.

 

In a nutshell, Custom Form Report Templates are authored in Microsoft Word, your templates will include banners, tables, text etc. but also placeholders with specific syntax that our Survey123 reporting engine understands.  The templates are uploaded and associated to your survey to define what the report(s) should look like.  When you want a report, Survey123 will replace your placeholders with real data and you will get a nice printable document back.  It is a simple approach, yet very powerful!

 

I am going to assume that you already have surveys published, and lots of data in them… so let’s get started!

 

Getting Started

 

In the Survey123 website, open the Data tab for a survey you own. 

 

 

 

Next, select a row from the table, and then select the “Custom Print (Beta)” option by clicking on the pen icon.

 

 

Now , click on the “Upload New Template” button

 

 

This dialog describes in detail what placeholders you need to insert into your Word document.  Note that the placeholders are unique to each survey. To make things easier, you can even click the link in blue titled “Click here to see an example.” to download sample template associated to survey. That is often the best starting point.

 

 

 

Note that you will be able to handle all question types including images and repeats.  Once you are happy with your template, upload it so you can use it later.  You can associate more than one template with every survey.

 

Learning by example and some additional tips

 

I will get into the specifics using the Water Violation Report survey which is available in the community gallery of Survey123 connect.

 

Here is a screenshot of the report template I created and the result I got after using it:

 

 

As shown in the template above, you can use expressions to return survey results. The syntax to access the data related to a question is ${fieldname} or ${%fieldname} when working with images (signatures, photos, maps).  

 

 

 

Tip 1: Check the help!

 

To learn more about the different formats for which a question type may be returned, click on the Show more options button as shown in the screenshot below. This option will only be available for question types with multiple return formats.

 

 

At this point, I will show you how to work with several question types including images, repeats, select_multiple, geopoint etc.

 

Tip 2: Images

 

For all images captured, the expression to return an image is ${%fieldname|size:460:0} – this expression will return an image with a width of 460px while persevering the aspect ratio. There are several other formats for which you can return an image- you can view all possible formats by clicking on the “Show more options” button on an image question. A screenshot showing all possible return formats for an image question is shown below. The image question is from the water violation report survey and the field name is violationphoto.

 

 

 

Tip 3: Maps

 

For all geopoint questions, the standard expression to return the map is ${%fieldname}- this expression will return a map with a standard size. You may return the longitude value, or latitude value using the expression shown in the screenshot below. The geopoint question is from the water violation report survey and the field name is violationlocation.

 

 

 

Tip 4: Formatting dates

 

For a dateTime question, the expression to return date and time is ${field_name|format: ’MM/DD/YYYY HH:MM:SS’}.

 

Tip 5: Working with multiple choice questions

 

For all Select_multiple questions, the expression to return the result is ${field_name}- this will return all selections made. A screenshot showing all possible return formats for a select_multiple question is shown below. The select_multiple question is from the water violation report survey and the field name is violationtype.

 

 

 

 

Tip 6: Working with Repeats

 

For a repeat, the expression ${#repeatname} indicates the beginning of the repeated area while the expression ${/repeatname} indicates the end of the repeated area. Put all the repeated questions & expressions between the two tags. If you want to print repeated records within a table, put the expression ${#repeatname} in the first cell of the repeated section and the expression ${/repeatname} in the last cell of the repeated section. Please note that repeatname is a placeholder for the name of the repeat.

 

Limitations on custom form report templates:

 

  • At this point, it is not possible to define the zoom level of your map through your template. However, as a workaround, you can zoom in the report preview in the Survey123 website and that will set the zoom level when you print. You can specify the web map used and the scale through the mapSettings property: ${location|mapSettings:"<web map ID>":<scale>}
    ${location|mapSettings:"10df2279f9684e4a9f6a7f08febac2a9":264800}
  • Only authors of a form can edit a template. This is more by-design than a limitation, but I thought I should make you aware
  • When the Individual Response tab is accessed by selecting a feature point on the map, a “hanging issue” arises when custom printing. The bug associated with this issue is currently being worked on.
  • Currently, you can only print individual records, but we are working on adding batch printing to the custom form template feature. With version 3.0, batch printing was introduced.
  • The function to create reports is only available from the website, but we plan on making it available through our Survey123 REST API so it can be invoked from the Survey123 apps as well as programmatically.
  • For on-premises support (when working with your ArcGIS Enterprise Portal):
    • The custom form report feature only works in ArcGIS Enterprise Portal (10.5) and above
    • Photos submitted to image questions will not work
    •  The ArcGIS Enterprise must be visible from the Internet
    •  IWA authentication is not supported

 

Summary

 

 

 We're really excited about this new feature because we believe it will meet the needs of our users in the following ways.

  • Creating backups of survey submissions.
  • Creating beautiful forms that give more context to survey data.

 

This feature is still in Beta which means its functionality will only get better. Now go use the Custom Report Template feature and let us know if you have any suggestions on possible improvements.

On this day 48 years ago, Apollo 11 moon-landed Neil Armstrong and pilot Buzz Aldrin. They spent a bit over 2 hours outside their lunar module Eagle and gathered 20Kg of rocks. The moon-walk and the rocks were of marginal importance: What mattered most was to be the winner of a race that started on November 3, 1957, when the Soviet Union launched Sputnik 2.  The Race to the Moon, if you ask me, looked like a perfect way to sort out the rivalry between the US and the Soviet Union.  Much better anyways than how rivalry played out down here in Earth.

 

2.3 is for the most part a maintenance release but it has a couple of nice surprises...

 

Before we start, as with every new update: Clear your browser cache! 

 

Custom branding for your forms in Survey123 Web Designer

 

The Survey123 Web Designer lets you easily create smart forms in ArcGIS using a graphical user experience. With every update we extend its functionality so you can build more and more sophisticated forms. Many of  you have requested better control over the look and feel of the survey. 

 

With this update you can now add a custom header to your own surveys. The header can include rich text and even images.  This is a great  feature if you want to brand your surveys to fit the corporate colors and logo of  your organization or initiative.

 

 

On top of this, through the Web Designer's Appearance tab you can also now toggle the survey description, footer and header as well as better control the font and content of your question hints through a Rich Text Editor control.

 

Last by not least, the new Note question type lets you add rich content anywhere within your form. You can add images, html links and much more. Notes are a great way to spice up your forms, but they are not just about the looks: Through notes you can include useful tips for users to properly complete the forms.

 

 

Open your Survey123 Connect forms in a web browser (Beta)

 

With this release, you can now open your surveys authored in Survey123 Connect for ArcGIS from a web browser. This is a feature that has been on the works since November 2016 and we feel it is pretty much complete at this moment.

 

Following a conservative approach, we have flagged this feature as Beta, but made it available to all of you from the Survey123 website.

 

To open your Survey123 Connect surveys from a web browser, open the Collaborate tab in the Survey123 website.  You will now always  find a survey link available, even if  your survey was published from Survey123 Connect for ArcGIS.

 

You can also launch your Survey123 Connect forms in your browser right from Survey123 Connect. Once published, you can open your survey in a web browser, through the button intermediately below the Publish in the Survey123 toolbar. 

 

 

While the new Web Form can handle the vast majority of the XLSForm features supported by Survey123 Connect, there are some exceptions:

 

  • Barcode questions.
  • media::audio, body::esri:inputMask and body::accuracyThreshold columns
  • Signature appearance on image questions
  • Compact appearance on Groups
  • Autocomplete appearance on select_one questions
  • Extraction of X,Y,Z values from a geopoint  using the pulldata() function
  • Property() function

 

Other than the above, your web browser should  be able to handle anything you author in Survey123 Connect for ArcGIS: Groups, Repeats, Notes custom expressions in Constraints, Relevant and Calculation columns etc

 

There are some known issues and things to be aware at the moment:

 

  • The Print functionality is limited to one page. This issue is on the works.
  • Concatenating strings in calculations requires you to use the concat function. You cannot concatenate strings just by using the + operator.

 

If you find more issues, please report them through Esri Support Home. We are looking forward to refine the new Web Forms and move them away from Beta!

 

Custom Form Reports (Beta)

 

This is an experimental feature at the moment, but given how badly many of  you have  been asking for it we have brought it forward in Beta so you can try it out. 

 

The basic requirement is to be able to generate a printable document out of the data submitted via Survey123 smart forms.  Ideally, one should have total control over the look and feel of the printed document: headers, footers, the map, tables, size of photos etc.

 

The approach we propose lets you author Form Report templates in Microsoft Word. Following a series of simple rules, you define placeholders in your Word document which our Survey123 report engine will replace with values from the forms submitted.  As the owner of a survey you can associate one or more Custom Form Report templates with a survey, which can be used later to either print specific surveys submitted, or may be to back-up the captured data digitally or on paper.   This workflow is conceptually close to Microsoft's Office Mail Merge functionality, although the exact syntax is specific to Survey123.

 

I will describe briefly how to get going with this:

  • In the Survey123 for ArcGIS website, open the Data tab for one your surveys.
  • Expand the data table and select one of the rows.
  • One the panel on the right, look for the 'Custom Print (Beta)' label and then click on the pencil icon.

 

 

  • A new dialog will describe what placeholders you can use in your Form Report Template. Note that you can even download a bare bones Report Template specifically built for your survey.  That is a great starting point.
  • Once you have your Template  in place, upload it so it gets associated with your survey.
  • Use the Print button to generate a report for the selected  survey.

 

We are at the very beginnings of this, but you will get an idea of where we  want to go with it.  Note that you should be able to handle all types of questions  including photos, signatures and repeats.

 

For more details on this, please read Tega's blog post on it

 

Developers

 

AppStudio for ArcGIS 2.3 now includes the Survey123 field app and Survey123 Connect source code. Note that in order to extend or brand Survey123 you will need an AppStudio for ArcGIS Standard license.

 

Other fixes and enhancements

 

Survey123 website

 

  • The Data and Analyze tabs are  now available for  surveys published on top of pre-existing feature services
  • BUG-000105667 In Survey for ArcGIS, it seems to be impossible to switch Rating style back from "Label" to "Icon", as it locks to "Label" once selected.
  • BUG-000106171 Survey123 for ArcGIS, when a survey created on survey123.arcgis.com website contains a required number question and you enter a value >10, all other preceding answers will not submit to the service.
  • BUG-000105700 Signing onto survey123.arcgis.com website using SAML authentication does not work after updating to Survey123 for ArcGIS v2.1 release.

 

Survey123 Connect 

 

Now available for download on Windows, Mac  and Linux. This update improves publishing of surveys against ArcGIS Server Enterprise feature services, particularly when these services have related tables.

 

Note that  starting  with  this  version, any survey published  against ArcGIS Enterprise Hosted feature services using the ArcGIS Data Store must include all question names in lowercase. This is to ensure  that names of questions in your XLSForm match exactly feature  service field names in your feature service (The ArcGIS Data Store does not  support upper case characters in field names).

 

When working against existing feature services (in ArcGIS Online or ArcGIS Enterprise), Survey123 Connect will validate at publishing time that all XLSForm question names perfectly match field names in your feature service.

 

Survey123 field app

 

Now available in the Apple, Amazon and Google Play stores.  Its build number is 2.3.29. The most  significant fixes include:

 

  • Signatures are no longer submitted cropped in iOS devices. Note that the signature image will still appear to be cropped in the field app in iOS, but the signature will be submitted correctly to ArcGIS.
  • Barcode scanner now beeps when a successful read is  achieved.
  • Surveys in the Drafts, Sent and Outbox folders will no longer disappear when the field app is updated from the  iTunes store.
  • BUG-000103801 Photos cannot be taken or submitted in Survey123 for ArcGIS field app on iPhone (6 or 7) using landscape view; everything is rotated an additional 90 degrees.
  • Distress appearance on integer type of questions now displays  correctly on iOS devices
  • Slider used to  control the label size setting in the Survey123 field  app now displays correctly in Android devices
  • BUG-000104998 Attempting to modify and resubmit a survey using the Survey123 for ArcGIS field app returns the following message, "Code 1000. Must declare the scalar variable '@ObjectId'."
  • BUG-000105055 Unable to send edits to service from Survey123 for ArcGIS Inbox if the OBJECTID or GLOBALID field contains capital letters.

 

Next Steps

 

Our next release is planned for late August or early September. Our focus continues to be focusing on quality improvements as well as:

 

  • Adding support for feature updates on surveys with repeats
  • Delivering a setup experience for the Survey123 website and Survey123 API

 

We update  our builds  of Survey123 in the Early Adopter  Program nearly every Friday, in case that you want to test new features coming up.

 

For more details on What is New in this, and prior releases, check out our What is New help topic.