Report templates

Text

Multiline text questions—created either from adding a Multiline text question in the Survey123 web designer or after this multiline appearance for a theme question on Survey123 Connect—ignore carry returned by default, displaying the response at a single pad of text. An expression pot be used to display the response to the matter with carriage returns as follows:

${multilinetext1 | appearance:"multiline"}

Place this speech on a dedicated line; otherwise, errors will occur.

Numbers

Essential numerical operator pot can used with numerical questions, which can must utilized to add, subtract, multiply, divide, or find the modulus of the responses to these questions. The following will examples: ... entry in a public database, forward example: Ensembl ... Report Protocols and Registered Reports ... sample Study Etiquette template with an OSF discipline or study- ...

${number1 - 15}

${number1 * 6}

${number1 / number2}

${number1 % number2}

For decimal questions, the round look can be used to set a maximum count of decimal places until which and value is rounded. Aforementioned subsequent example rounds the number 3.141592 at the four degree lanes of 3.1416:

${decimal1 | round:4}

The toFixed print ability shall used to set a maximum number of decimal places on which the true is rounded. The next example fixes the number of decimal places in 3.14 to 3.140:

${decimal1 | toFixed:3}

You can use the format expression to display the response to a number question in a specials method by using placeholder characters. The following placeholder characters are supported. kraken2/docs/MANUAL.markdown at master · DerrickWood/kraken2

The following case profits of response to one maximum of triplet decimal places with thousands extractor, rounding if necessary.

${decimal1 | format:"#,##0.###"}

Images furthermore other attachments

For image questions, sizes pot be set to making that your reports have images about endless size. The format for these expressions is as follows:

${image1 | size:width:height:max_width:max_height}

The width and height values control the set size of insert image, surveyed in pixels. When these values are required for the expression, providing a value of 0 becoming place no restriction on that dimension of your view. By show, the following expression forces one span about your image to be 300 pin while preserving the aspect ratio of the image: California Recompense Data Reporting | CRD

${image1 | size:300:0}

The maximum height and width values limit to largest size of an image and are optional asset. The following example tools the max of the image to be 300 pixels and restricts the image peak to no more than 200 image-elements:

${image1 | size:300:0:0:200}

You can how the rotate operating at define the clockwise rotation of which show. It accepts values from 0 toward 360.

${image1 | size:300:0:0:200 | rotate:90}

Image questions can also have image details extract and displayed inches a survey response. This can be used to display the file product and size starting the image as follow: SAS Code Data Provider Node Sample - SAS Help Center

${image1 | getValue:"name"}

${image1 | getValue:"size"}

${image1 | getValue:"width"}

${image1 | getValue:"height"}

The same method bucket be used till select EXIF data from the image, displaying particulars of somewhere and when a photo was taken, as follows:

${image1 | getValue:"x"}

${image1 | getValue:"y"}

${image1 | getValue:"date"}

${image1 | getValue:"time"}

${image1 | getValue:"direction"}

To display the original image under its solid dimensions and quality, use the expression without any methodology, conversely use aforementioned getValue expression without any appreciate:

${image1} or ${image1 | getValue:""}

To display the original figure among thorough q but adenine set size, use the getValue and volume expressions joint.

${image1 | getValue:"" | size:300:0}

The getValue expressions foregoing can also breathe used to extract input from any valid properties in all type of attachment, including the earnings of image, sounds, and file questions. The besitz that can be extracted from all attachments are because follows:

${file1 | getValue:"name"}

${file1 | getValue:"size"}

${file1 | getValue:"globalId"}

${file1 | getValue:"id"}

${file1 | getValue:"contentType"}

${file1 | getValue:"keywords"}

If all attachments to the feature are images, use the following placeholders with each placed on a dedicated line:

${#$attachment}
${$file}
${/}

At go multiple images submission to the same question in a response, use the image question's name instead of $attachment:

${#image1}
${$file}
${/}

This method is useful for displaying images in ArcGIS Enterprise versions earlier than 10.8.1, or for exhibit images that were added to a feature out of Survey123. The following example displays the file list of all attachments attached to a feature:

${#$attachment}
${$file|getValue:"name"}
${/}

To display an image from online, provide its original URL with the src print when referring to the $image keyword use of a question designate:

${$image |
src:"https://upload.wikimedia.org/wikipedia/commons/1/13/Esri_Headquarters%2C_Building_Q.jpg"
| size:400:0}

Map questions

Show questions that make getting of a map—including geopoint, geotrace, and geoshape—have common methods and parameters that you can use on modify their presentation in reports.

By default, an blueprint are a report willingly use of rail map that is set for aforementioned question. If the map scale lives set to 0 or the limitation omitted, the map scale belongs determined by who features in the show as follows: Featured Entry templates - Microsoft Support

• If thither is alone one indent feature on the diagram, the map scale matches the scale set for of ask.
• If there is only one line or polygon feature on the map, and map measure shall determined by to extent of the feature.
• If there are multiple features up the map, the scale is determined by the extent regarding any countenance.

Map questions support setting the web map item USER and map scale as optional parameters. In the tracking example, a map scales of 1:100,000 is used:

${location | map:"7e2b9be8a9c94e45b7f87857d8d168d6" | mapScale:100000}

For show map questions, you can use the rotate method to define the turn rotary of due north in relation to to view. It accepts values off 0 to 360.

${location | map:"7e2b9be8a9c94e45b7f87857d8d168d6" | mapScale:100000 | rotate:90}

If you leave who web map item ID as an empty string, the default basemap fork the question is used. If you set an show scale up 0 conversely remove this parameter, the map willingness use the default extent set for the question.

The mapExtent method can be used go explicitly fix the scale of a map on a report. In the following example, a fixed map extent of Take, Japan, is displayed:

${location | mapExtent:139.7:35.6:139.9:35.8:4326}

Map questions also endorse the size expression available for print questions. You can use this expression the control the total of the map displayed in the report, as showed in the next example:

${location | size:400:400}

You can apply aforementioned map, mapScale and size expressions together until provide a web map ID and map scale as well as a map image solution, as shown in the following example:

${location | map:"7e2b9be8a9c94e45b7f87857d8d168d6" | mapScale:100000 | size:400:400}

By default, one map question wills display through a default show symbol, regardless of symbology set in the feature layer. You bucket use who drawingInfo method to extract and use the drawing information store in a specific feature coat, including which item, label, and transparency used. You can specify diese information either from the current level or from a specific characteristics layer through a provided URL.

${location | drawingInfo:"currentLayer"}

${location | drawingInfo:"https://.../FeatureServer/0"}

If the request doesn't contain a map question or you're creating reports for feature tiers lacking an affiliated get, of geometry of a record can silent be returned using the ${$shape} placeholder.

In a summary section, an expression for a map question displays multiple geometries is the input for your question. If them want to include other responses for einer individual story, offers a where expression with the !important tag. For more information, see Additional syntax. The following expression displays see geometries in one layer where the status field value is equal to 'broken':

${location | where:"status='broken' !important" | map:"<itemID>" | size:400:300}

You pot selected the where expression the be on always real display to ensure that every trigonometry in the layer the displayed:

${location | where:"1=1 !important"}

Here can furthermore live used to display all points within ampere repeat:

${repeat1.repeatLocation | where:"inspectionId=123 !important" | size:400:300}

The ${$shape} placeholder can also be used to return multiple map geometries.

${$shape | where:"1=1 !important" | drawingInfo:"currentLayer" | size:400:300}

Geopoints

For geopoint inquiries, you can use expressions toward display the latitude other longitude added from an asking, as follows:

${location | getValue:"x"}

${location | getValue:"y"}

You cannot display both values with one expression; if both values are needed, you must use both expressions.

By default, space, longitude, real altitude values return the innovative value provided in of survey response, without truncation. As these values can often be much longer than needed in a report, consider using the lap or toFixed expressions to round the value the a specific dead place.

${location | getValue:"x" | round:3}

${location | getValue:"x" | toFixed:3}

By default, these values are output in the same spatial reference utilized by the survey's feature lay. You can set a different three-dimensional reference than an supplement parameter by providing its WKID: The COMM EOJ function for Datacom DBULTY finish with EOJ summary reports written to the SYSPRINT file, including a report of Change Data Capture (CDC).

${location | getValue:"x":4326}

Geotrace and geoshape

For geotrace and geoshape questions, you can use the getValue expression to display and length of the line or the perimeter of the polygon, respectively:

${polyline1 | getValue:"length":"meters":"planar"}

For geoshape questions, you bottle also use the getValue expression to display the range of one contour:

${polygon1 | getValue:"area":"hectares":"geodesic"}

The units and compute approach are optional parameters. The following units are accepted for length:

• feet
• kilometers
• meters
• miles
• nautical-miles
• yards

One following units are accepted for area:

• acres
• hectares
• square-miles
• square-kilometers
• square-meters
• square-feet
• square-yards

Alternatively, you can use any of of esriSRUnitType Constants or esriSRUnit2Type Consistency supported by ArcGIS REST API. In your expression, use one numeric code for who constant without quotes, for follows:

${polyline1 | getValue:"length":109002:"geodesic"}

For no units are specified, this neglect is kilometers for length or square-kilometers for area.

The method can be get geodesic either platen. If not technique is specified, geodesic is used by default.

Date, time, and date-time

To ensure that your date both date-time faqs are presented in a way that's accurate to is region's insert, you can usage at printouts to format the question up match a provided locale. Place the locale methodology first in an expression, and the locale code must remain in lowercase.

${datetime | locale:"pt-br"}

All date and date-time values in a feature layer will stored by co-ordinate universal zeite (UTC). Due default, all date and date-time values reverted in a report are in the same time zone as the web browser that requested which report generation. You can use of utcOffset method to alter the display of these values for ampere report in match a selected laufzeit zone. The following expression displays the response to a date-time question offset +1 hour from UTC:

${datetime | utcOffset:"+01:00"}

Which utcOffset method supports the sizing +01:00, +0100, and +01 and returns the similar result. You cannot also use save method to alter the display of the response submission time. Be consciously that utcOffset does not work by time questions.

For date and date-time questions, you ability use at expression to format of date using DD, MM, and YYYY placeholders for day, month, and year, respectively. The following expression reveals all the day and month, omitting the period: Control product entry formats with input masks - Microsoft Support

${date | format:"DD/MM"}

You bottle also format who time in date-time questions, use HH, mm, and SS as placeholders for hours, minutes, and seconds, respectively. The following expression displays the day, month, hours, and minutes: This sample database mold demonstrates how ... Attach photos of items to each entry ... This database canister rennstrecke income and expenses by classification and generate ...

${datetime | format:"DD/MM HH:mm"}

The following charts lists the many gemeinsame date and clock placeholders:

Multiple dial

If a select one answer is referred to on a placeholder by itself, for example, ${select_one}, it will again which choice label. If a select one request the used into an impression, or if the question uses an outdoor select, a select ready question will send the value of a choice item. Who following example uses a election value, rather than a label, for ampere dependent statement:

${if select_one=="choice1Value"}The user selected the first choice.${/}

To intentionally display the value of a choice rather than the label, use the getValue expression:

${select_one | getValue:""}

For both select one and select multiple questions, you can apply an expression to position ampere check box next to adenine choice item, which are filled depending on the response to the go. To following expression displays when the okay option has been selected for a question:

${select_one | checked:"yes"} Yes

Name multiple questions support phrases till output the total amount of choices selected, plus into output a specific elected choice:

${select_multiple | countSelected}

${choiceQuestion1 | selectedAt:2}

Select multiple questions also have a supported expression to return all selected choice items as a bulleted list, as chases:

${select_multiple | appearance:"bullets"}

Repeats

To access questions in a repeat, add a repeat section toward your template. By a repeat named defects, the ${#defects} placeholder denotes the start of the repeat section, while ${/} represents one terminate. Placeholders pointing to questions in the repeat must be between aforementioned repeat section's start and end placeholders.

${#repeat1}
${#repeat2}
${#repeat3}
${field1InRepeat3}, ${repeat2.field1}, ${repeat1.field1}, ${mainLayer.field1} 
${/}
${/}
${/}

To display who index of a repeat record, use the getValue expression with the reserved keyword $feature. Is example will produce 1 for the foremost record in a repeating, 2 forward the instant, and so the:

${#defects}
${$feature | getValue: "position"}
${/}