Update attachment keywords for existing images in Survey123 data from REST

Summary

A feature report containing survey information including maps, signatures and images can be generated after a survey is submitted. However, in some instances, the images captured are not exported to the Word document of the ArcGIS Survey123 feature report.

Specifically, some images are not exported in reports generated from Survey123 website when ${image_question_name} is used in the report template.

This is a known limitation that attachments do not show up in the reports created in Survey123 website if they have been added to the survey's hosted feature layer outside Survey123 apps, such as ArcGIS Field Maps or a web app. For instance, adding attachments through the web map or a web application in ArcGIS Online, which can result in missing tags. See: ArcGIS Survey123 Known issues. This is also mentioned in existing bugs BUG-000126416, BUG-000111958, BUG-000139638.

This issue also happens in ArcGIS Enterprise versions prior to 10.8.1. ArcGIS Enterprise 10.8.1 supports attachment keywords. This attribute is necessary when generating ArcGIS Survey123 reports from the Survey123 web site in a Portal for ArcGIS environment, as Feature Service report templates use keywords to reference each image.

Data created before 10.8.1 gains the attribute keyword attribute, but the field does not auto-populate with the keyword. Therefore, image attachments are not printed on the reports.

Procedure

When looking at existing submissions on the individual form view in Survey123 website, these images show up under attachments section instead of under each image question.

There are several different ways to work around this issue.

• Return images that are missing a keyword as attachments in the feature report
• Update attachment keywords (this document)
• Re-upload attachments from Survey123

1. Open the Data tab in Survey123 website.
2. Click on the record with the image attachment missing the keyword.
3. Right-click on the attached image and open in new tab, as shown in the next image.

4. Note the attachment id in the URL, 17, in this example:

https://services.arcgis.com/Wl7Y1m92PbjtJs5n/arcgis/rest/services/service_84a27a9dc1264f1c86a540038c2f00f7/FeatureServer/0/8/attachments/17?token=

5. Replace the “attachments/<attachment-id>” with “updateattachment” in the URL. The example URL should now look like the following:

 https://services.arcgis.com/Wl7Y1m92PbjtJs5n/arcgis/rest/services/service_84a27a9dc1264f1c86a540038c2f00f7/FeatureServer/0/8/updateattachment?token=

6. Fill out the form:
   1. The Attachment ID is listed in the URL after /attachments (from Step 4).
   2. The Keywords, is the name of the image question to associate this image with.
7. Click the Update Attachment button.

8. The screenshot below shows that that this image now appears under the image question in form view and will be printed in the report.

9. Repeat steps 3 to 7 for other attachments that are missing keywords to update them, as shown in the next screenshot.