Configure Quick Report

What is the Quick Report template?

The Quick Report template is for creating citizen engagement apps that allow users to capture an observation and submit it to an online service.

When you create an app from this template, you need to provide a title to create an app. Use the Settings tool to customize your quick report.

Requirements

The requirements for the Quick Report template are as follows:

  • The web map version must be 2.0 or later or the map will fail to load.
  • (Optional) Allow the collection of photos and enable attachments on your feature service.
  • (Optional) Symbolize your feature service by category to use the symbols as categories in a list when creating a report.
  • (Optional) Provide a publicly hosted mobile map package (MMPK) item on your organizational account to view a map in offline mode. Use the mobile map package item ID property to configure this. If your MMPK was not created with the ArcGIS Pro Publisher extension with anonymous use enabled, you must configure Quick Report with a secured feature service layer to view the offline map.

Create an app

You can create a Quick Report app in ArcGIS AppStudio.

  1. Start ArcGIS AppStudio.
  2. Click New App on the toolbar.
  3. From the category list, choose Template.
  4. Choose Quick Report from the list of templates, provide an app title, and click Create.

Customize your app

Once you've created your app, you can customize it by changing the app settings.

Start AppStudio and, in the side panel, click Settings > Properties. The following table lists the contents of the tabs on the Quick Report Properties tab, sorted by the tab on which they appear, and their purposes. They can also be modified directly in the app's appinfo.json file. If you change any of these properties, click Apply to save them before starting your app again.

Start Screen property contents

Property JSON nameTypeDescription

Background image

startBackground

String (image URL)

Image used for the Start page background.

Base font size

baseFontSize

Number

Sets the base font size used throughout the app.

Title Font File

customTitleFontTTF

String (file path)

Sets the custom font style to be used for titles and headings throughout the app.

Text Font File

customTextFontTTF

String (file path)

Sets the custom font style to be used for text throughout the app.

Show logo

startShowLogo

Boolean (true|false)

Shows or hides the logo and its link on the Start page.

Logo

logoImage

String (image URL)

Image used for the logo displayed on the Start page.

Logo URL

logoUrl

String

URL opened from the logo on the Start page.

Phone number label

phoneLabel

String

Label displayed for the phone number.

Phone number

phoneNumber

String

Phone number provided in the app.

Website label

websiteLabel

String

Label displayed for the website.

Website

websiteUrl

String

Website URL provided in the app.

Email label

emailLabel

String

Label displayed for the email address.

Email address

emailAddress

String

Email address provided in the app.

Social media label

socialMediaLabel

String

Label displayed for the social media URL.

Social media

socialMediaUrl

String

Social media URL provided in the app.

Form property contents

PropertyJSON nameTypeDescription

Webmap ID

webMapID

String

A public web map ID that provides information for the user to choose a report location. All default basemaps are provided as web maps.

Mobile map package item ID

offlineMMPKID

String

The public MMPK item ID that can be used to download an offline map.

Feature service address

featureServiceURL

String

The URL of the feature layer in which to capture the observation record.

Layer IDs of the feature service

featureLayerId

String

ID of the feature layer in which to capture the observation record. You can add one or multiple feature layer IDs from the same feature service as a comma-separated list. For example, 0,1,2.

Payload URL

payloadUrl

String

Configure an optional URL to send information about a successfully submitted report to an external webhook service in JSON format. For more information, see Wikipedia's page on webhooks.

Thank you message

thankyouMessage

String

Feedback text to be shown when the user submits a report. Supports HTML links.

Report Help Link

reportHelpUrl

String

Help or instructions to fill out the report. Can be a local HTML file or a URL.

Allow skipping of attachments

allowPhotoToSkip

Boolean (true|false)

Enables the user to skip the attachment upload in the form. If false, the user must provide at least one attachment. This can be a photo, audio, or video (if enabled).

Show album

showAlbum

Boolean (true|false)

Enables the user to choose a photo from an album. The default value is true.

Enable select files (BETA)

enableSelectFiles

Boolean (true|false)

Enables the user to choose files as attachments. The default value is true.

Enable video recorder (BETA)

supportVideoRecorder

Boolean (true|false)

Enables video recording of up to 30 seconds to be attached as part of the report.

Enable audio recorder (BETA)

supportAudioRecorder

Boolean (true|false)

Enables audio recording of up to 2 minutes to be attached as part of the report.

Maximum allowable number of attachments

maximumAttachments

Options (combo box)

Limits the number of attachments per feature. Attachments can be photos, audio, or video (if enabled). Accepts values from 1 to 6.

Colors property contents

PropertyJSON nameTypeDescription

Background color

pageBackgroundColor

String (color value)

Color used for the app page background.

Text color

textColor

String (color value)

Color used for the text.

Header text color

headerTextColor

String (color value)

Color used for the header text.

Header background color

headerBackgroundColor

String (color value)

Color used for the header background.

Button color

buttonColor

String (color value)

Color used for buttons throughout the app.

Distribute your app

There are many ways you can distribute your app. For details, see Distribute your app.