Additional configuration

Survey configuration file

A key benefit of the 3D Public Survey application is that you can get structured feedback on your survey questions. This is done by defining all possible answers as domain values per question. Domains and domain values of the answers to your survey questions are defined when you create the Survey Response layer using the survey configuration file.

The survey configuration file allows you to author the possible answers to your survey questions. You can find an example configuration file in the MapsandGeodatabase/ConfigurationFiles directory.

Type Description
[DOMAINS] List of domain names. These are the names for the domains that hold the possible survey answers.
[DOMAIN_VALUES] List of domain values for the named domains. These are the possible answers to your survey questions.
[APP_FIELDS] Application required fields. Do not modify.
[FIELDS] User definable response fields. These fields will hold the answers to the survey questions. The survey questions are defined in the layer pop-ups. The answers are defined by the domains.
[FIELDS_ALIAS] Field alias names for response fields.
[FIELDS_LENGTH] Field lengths for response fields.
[FIELD_DOMAIN] Assigns domains that hold the possible answers to the response fields.
[VALUE_REQUIRED] If NON_NULLABLE, the user must provide an answer in the 3D Public Survey application.

The questions to the possible answers you defined previously are stored in the Survey Response layer pop-up configuration. When configuring the survey questions, make sure the [FIELDS] names in the configuration file are the same as the {question} fields in pop-up configuration.

Survey questions and fields used to store answers
An example of a pop-up configuration

Application settings

Use the configuration.json to configure the 3D Public Survey application to your organization's needs. Help text, user access, branding logo, and chart colors can all be configured by modifying the following parameters:

Parameter Description
titleText The title to be displayed on the splash page and at the top of the survey form. If the survey web scene ArcGIS Online item has a title, its text is used instead.
splashText The text to be displayed on the splash page below the title. If the survey web scene ArcGIS Online item has a summary, its text is used instead.
helpText The text to be displayed in the help pop-up box. If the survey web scene ArcGIS Online item has a description, its text is used instead.
finishText If the survey web scene has slides, the text to be displayed after at least one survey has been submitted for each slide.
showGuest Specifies if the 3D Public Survey application will allow guest or anonymous access.
  • true to allow guest (anonymous) access
  • false to disallow guest (anonymous) access
allowGuestSubmissions If guest logins are permitted, specify if 3D Public Survey application will allow guest anonymous answers.
  • true to allow guest (anonymous) answers
  • false to disallow guest (anonymous) answers
showFacebook Specifies if the 3D Public Survey application will allow Facebook access.
  • true to allow Facebook access
  • false to disallow Facebook access
facebookAppId If Facebook logins are permitted, register the application with Facebook.
showGooglePlus Specifies if the 3D Public Survey application will allow Google+ access.
  • true to allow Google+ access
  • false to disallow Google+ access
googleplusClientId If Google+ logins are permitted, register this application with Google.
showTwitter Specifies if the 3D Public Survey application will allow Twitter access.
  • true to allow Twitter access
  • false to disallow Twitter access
surveyNotificationPolicy Determines if and how the survey form treats important/required questions.
  • allImportant the form checks each field to see if it is nullable. If it is nullable, it is considered an optional field; otherwise, it is a required field that must be completed before the form reports that the policy has been satisfied.
  • >=1 at least one question must be answered
  • all all questions must be answered
showSeeResponsesButton Show the See responses button.
  • true to see responses button
  • false to hide responses button
useWebmapOrigImg Specifies which image to use for the splash screen. This is the image displayed when the application starts.
  • true to use the original image stored as the thumbnail of the web scene item on ArcGIS Online
  • false to use the default image specified by splashBackgroundUrl.
splashBackgroundUrl URL of the splash screen background image.
clusterSymDisplay Object containing three properties that control the display of survey feature clustering icons:
  • averagingFieldName name of field to use for averaging responses
  • averagingColorStops list of value-color pairs for controlling the color of the icons; icon is colored by interpolation using the stop points
  • featureCountSizeStops pair of value-size pairs for controlling the size of the icons; icon is sized by interpolation using the stop points
pieChartColors Object containing color descriptions keyed by question field name. For each entry, specify either a Dojo case-sensitive color theme name or a list of hexadecimal color specifications in the form # red green blue.
brandingIconUrl URL to an image to use for branding at the bottom of the survey form.

Survey settings

There are several options available regarding the types of survey responses that can be presented on the survey panel.

The general form for the definition of a question is:

  • question text {answer field name} {display style}

With one line per question. If the answer field name and display style are omitted, the configuration line is interpreted instead as a subtitle:

  • subtitle text
Answer field name

This is the case-sensitive name of the field to receive the answer to the question.

Display style

This is a case-sensitive style name for the question. Five styles are defined:

Type Description Pop-up tag
Button Presents survey responses in the form of rectangular buttons. Use this option if you have a domain of values applied to a field. {button}
List Presents survey responses in the form of radio buttons. Use this option if you have a domain of values applied to a field. {list}
Drop-down Presents survey responses in the form of a drop-down menu. Use this option if you have a domain of values applied to a field. {dropdown}
Text Allows users to manually type in their response. Use this option if you have a text field in your data, without a domain applied. Length settings on the field will be enforced in the application. {text}
Number Allows users to manually type in a number response, or use arrows to incrementally set a number value. Use this option if you have a number field in your data, without a domain applied. {number}

The button, list, and drop-down styles require coded-value fields to build their choice display. The text style uses a single-line text-entry display if the question field has a length less than 32 characters, otherwise, a multi-line text-entry display is used.

Top