topic Re: Dynamic image in Report Template in ArcGIS Survey123 Questions

Dynamic image in Report Template

CarlosSousaFerreira — Mon, 14 Jun 2021 16:47:17 GMT

I'm trying to include a dynamic image content in my report template using the value of one field to construct the image URL.

It says in the documentation of the Report template that this could be achieved through the $image keyword.

I've tried including a text like this in my template:

${$image | src:"https://anyserver.com/dynamicpage.ashx?data=${my_field}"}

But, when I try to load the template to the survey in survey123.arcgis.com, it raises an error:
Erro: An error occurred when checking the report template. The tag beginning with "${$image |" is unclosed. The tag beginning with "}"" is unopened.

I guess it is not liking the field data I'm trying to add to the image URL, but how can I do this?

Re: Dynamic image in Report Template

Jim-Moore — Tue, 15 Jun 2021 06:09:33 GMT

Hi @CarlosSousaFerreira while variable substitution in the src string isn't supported in the way you've demonstrated above (i.e. for substituting part of the URL string), you can use the value from a question as the complete URL. If your survey is published from Survey123 Connect, one option would be to construct the full URL in a hidden text question in your survey, then use this as the image source. For example, if you concatenate https://anyserver.com/dynamicpage.ashx?data= and ${my_field} in a hidden text question named image_url, your report template syntax could then look like:

${$image | src:image_url}

Hope this helps. Best, Jim

Re: Dynamic image in Report Template

CarlosSousaFerreira — Tue, 15 Jun 2021 11:45:29 GMT

Thanks! This work like a charm!
However, it makes me create a new field for the image_url value. Is there any way to avoid this?

Re: Dynamic image in Report Template

Jim-Moore — Thu, 17 Jun 2021 07:00:22 GMT

Hi @CarlosSousaFerreira following discussion with colleagues, it turns out it is possible to concatenate strings in an expression in the report template itself, using the plus symbol (+). So your report template syntax could look something like:

${$image | src:"https://anyserver.com/dynamicpage.ashx?data=" + my_field}

Note that this method is not documented; we're still assessing the best way to implement this syntax, but this should hopefully be useful for now.

Also note that when calling a question value within an expression, you drop the ${} syntax from the question name. So in this case ${my_field} is entered as my_field when inside the ${$image} expression.

Best, Jim

Re: Dynamic image in Report Template

CarlosSousaFerreira — Fri, 18 Jun 2021 10:51:17 GMT

Hi @Jim-Moore. Thank you so much for your help. That configuration works and it adds the value of my_field to the url, but it automatically removes the question mark (?), so it drives the url invalid. I've tried to substitute the question mark with ? and it doesn't remove it, but it still gives me an error when printig the report, even though the generated url is valid:

Re: Dynamic image in Report Template

Jim-Moore — Tue, 22 Jun 2021 05:21:55 GMT

Hi @CarlosSousaFerreira thanks for raising this. On further discussion with colleagues, this is a known issue: a question mark (?) in an image source URL in the template will cause a print error. We're working on resolving this issue for the next release. Perhaps surprisingly, the issue does not occur if the question mark is in the answer to a question, so in the meantime, the workaround is to use the method described above, i.e. concatenate the URL in a separate text question and then use the question name as the image source. We'll endeavour to update this post with any developments. The fix should hopefully be included in our next beta website update on EAC as well. Best, Jim

Re: Dynamic image in Report Template

CarlosSousaFerreira — Tue, 22 Jun 2021 09:20:41 GMT

OK. Thanks! Hoping to see the fix for this in the next version. Take care, Carlos

Re: Dynamic image in Report Template

ZhifangWang — Tue, 03 Aug 2021 08:23:48 GMT

Hi @CarlosSousaFerreira ,

As we rolled out a security update late last week, it includes the fix to this "question mark in the image src" issue. It should work as expected now on the Survey123 website.

If you still observe any issues, please let us know.

Re: Dynamic image in Report Template

CarlosSousaFerreira — Tue, 03 Aug 2021 10:04:26 GMT

Hi @ZhifangWang ,

Just tested and it now works using the format proposed by Jim-Moore: ${$image | src:"https://anyserver.com/dynamicpage.ashx?data=" + my_field}! This is great!

Many thanks!

Best regards,

Carlos

Re: Dynamic image in Report Template

DarraghOSullivan — Thu, 20 Jan 2022 03:05:38 GMT

Hi Jim,

Does this also work with other parameters? For example, I'd like to set the map scale to be dynamic within reports, based on another field, e.g.:

${Trail_Issue_Location|mapSettings: "949207afa6524b9889bdebaa6b84XXXX":Trail_Length * 1000 |size:200:200}

I've tried this out but can't get it to work...

Thanks, Darragh

Re: Dynamic image in Report Template

Jim-Moore — Thu, 20 Jan 2022 06:03:21 GMT

Hi @DarraghOSullivan

Yes, you can use a question value in an expression filter for a map question (and most other question's expressions too!). The syntax in your example looks good. What issues are you encountering? Does the report fail to generate (and if so, is there an error message)? If the report does print, is the map missing? Is the question a geopoint, geotrace, or geoshape?

Best, Jim

cc: @ZhifangWang

Re: Dynamic image in Report Template

DarraghOSullivan — Thu, 20 Jan 2022 07:51:33 GMT

Hi @Jim-Moore

Thank you for confirming. I realised that the question value was not within the repeat where the map question was, but in the main survey. I had only tried once and assumed it was not a valid approach. I have tried again and it works well. Thank you, Darragh