QuickCapture project item

A QuickCapture project is an item in your ArcGIS organization. You can view and change its thumbnail, title, summary, description, and access constraints in your organization. Those updates are reflected the next time the project is updated on your mobile device.

QuickCapture designer

The following can be edited in the graphical interface for the project:

• General—Set the recommended location accuracy and display preferences.
• Layers—Manage layers used by the project. By setting a layer as default, any new buttons added to the project will use fields of that layer. For all layers used in the project, you can also set default values and variables for all fields within each layer.
• Project details—Edit the project thumbnail, title, data recovery email, summary, description, and terms of use. Hyperlinks can be used in the project description.
• Exclusivity groups—Prevent multiple line or polygon buttons from capturing data at the same time by placing them in a group. Only one button within a group can be active at any one time.

The following can be edited in the graphical interface for groups:

• Label—Label shown in the project for the group.
• Number of columns—Number of columns in the group.
• Default state—Expanded or collapsed. The default is expanded.
• Colors—Outline color of the group as a HTML hexadecimal value.

New groups can be created by dragging the group icon onto the project preview.

The following can be edited in the graphical interface for buttons:

• Label—Button label.
• Image—Button image.
• Size—Button size: small, medium, or large.
• Shape—Button shape: rectangle or rounded corner rectangle.
• Colors—Colors of the button background and outline as HTML hexadecimal values.
• Data—Type of data to be collected for each field when the button is tapped.
  • Take photos—Off, manual, or automatic.
  • Capture fields—These can be typed values or field variables that are entered manually or read from a feature layer domain.

New buttons can be created by dragging the button icon on the project preview. The new button will have the fields of the default layer. If a default layer has not been set for the project, the author will need to add the data source for the button by selecting it on the data tab of the button side panel. An existing button can be duplicated or deleted. Select the button in the project preview and choose the duplicate or delete button on the appearance tab of the button side panel.

These properties and more can also be edited by changing the project JSON. See project properties for a list of properties that can be modified in the JSON editor.

JSON editor

As the graphical interface functionality evolves, you can always edit the project JSON code directly. You can copy and paste code between the QuickCapture designer and your preferred JSON editor, or edit it directly in the designer. There is limited syntax checking in the designer; be careful when making edits. Checking code snippets in an online JSON validator may be useful.

Edits made and saved in the JSON editor can immediately be reviewed in the QuickCapture designer.

Project properties

When editing the project's JSON, you can modify the following properties:

• User Input—User-supplied string that can be used to populate attributes of a record.
• Preferences—Applicable to all records captured in a project.
• Basemap—Map displayed when reviewing data.
• Data Sources—Lists the feature layers used by buttons in the project.
• Template Groups—Represents a group of buttons.
  • Template—Represents a button.
    • captureInfo—How data is captured when a button is selected.
    • displayInfo—How a button will look.
    • fieldInfo—The attribute values that will be captured for the record.
    • cameraInfo—How photos are captured for the record.

Some of these properties are arrays of additional properties. The following subsections describe details of the property arrays.

{
   "basemap":{

   },
   "dataSources":[

   ],
   "itemId":"",
   "preferences":{
      "backgroundColor":"#f3f3f4",
      "horizontalAccuracyError":null,
      "horizontalAccuracyWarning":10,
      "distanceThreshold":null,
      "adminEmail":"quickcapture@esri.com"
   },
   "templateGroups":[

   ],
   "userInputs":[

   ],
   "version":""
}

{
   "basemap":{

   },
   "dataSources":[
      {
         "featureServiceItemId":"1f683747c06c4a7e9843a477b2ab41e0",
         "dataSourceId":0,
         "url":"https://services1.arcgis.com/e7dVfn25KpfE6dDd/arcgis/rest/services/LayerOne/FeatureServer/0"
      },
      {
         "featureServiceItemId":"2b313747c06c4a7e9843a477b2ab41e0",
         "dataSourceId":1,
         "url":"https://services1.arcgis.com/b45KpfE6dEf121/arcgis/rest/services/LayerTwo/FeatureServer/1"
      }
   ],
   "itemId":"",
   "preferences":{

   },
   "templateGroups":[

   ],
   "userInputs":[

   ],
   "version":""
}

{
   "mode":"automatic",
   "imageSize":"unrestricted",
   "required":true
}

Field variables

Field variables are used to automatically populate QuickCapture fields with common GIS attributes. Not all variables can be applied to all types of fields. For example, the timestamp variable only applies to fields of type date.

See field variables for lists of all variables that can be used in all types of fields.

When using these variables in the JSON editor, you must enter the variable name in the format of ${variable_name}. In the following example, the username variable is assigned to a field named NameOfUser.

{
   "fieldName":"NameOfUser",
   "value":"${username}"
}

Exclusivity groups

An exclusivity group is used to ensure only one button within the group is active at any time. Consider capturing a series of lines that represent the changing condition of a footpath. As you travel along the path, the condition may be excellent, good, or poor. Click the excellent button to start capturing a line representing an excellent section of footpath. When the condition changes, click the poor button immediately. Capture of the excellent line will stop and capture of the poor line will start.

Exclusivity groups are typically applied to polyline and polygon buttons, but you may also add point buttons that are continuous mode enabled. Buttons from different template groups can be included in a single exclusivity group, and multiple exclusivity groups can be applied to a project.

User input variable

The userInput variable value is populated by the app user and can be applied to one or more buttons in a project. The app user enters the value; however, the project author must define the buttons and fields to which the variable will apply.

Project authors can define a maximum of one user input per project, and when the user input dialog box will be shown: either when the project is launched, or after a button is pressed. The user input value can be applied to one or more buttons and fields and has the following properties:

The following example shows how a range domain user input is defined:

{
   "userInputs":[
      {
         "id":"001",
         "label":"Enter route number",
         "fieldType":"esriFieldTypeInteger",
         "required":true,
         "mode":"project",
         "domain":{
            "type":"range",
            "name":"route no",
            "range":[
               1,
               100
            ]
         }
      }
   ]
}

The following example shows how a codedValue domain user input is defined:

{
   "userInputs":[
      {
         "id":"001",
         "label":"Enter class",
         "fieldType":"esriFieldTypeString",
         "required":true,
         "mode":"project",
         "domain":{
            "type":"codedValue",
            "name":"Class",
            "codedValues":[
               {
                  "name":"Principle",
                  "code":"Principle"
               },
               {
                  "name":"Classified (Non-principle)",
                  "code":"Classified"
               },
               {
                  "name":"Unclassified",
                  "code":"Unclassified"
               }
            ]
         }
      }
   ]
}

The following example shows how a userDefined domain user input is defined:

{
   "userInputs":[
      {
         "id":"001",
         "label":"Enter route number",
         "fieldType":"esriFieldTypeString",
         "required":true,
         "mode":"button",
         "domain":{
            "type":"userDefined",
            "name":"route no",
            "inputMask":"9999",
            "multiline":false,
            "hint":"Enter a four digit route id"
         }
      }
   ]
}

Once userInput is defined, the project author can assign it for use in a field. The following shows userInput with an ID of 001 being used to populate a field named routeNo:

{
   "fieldInfos":[
      {
         "fieldName":"routeNo",
         "value":"${userInput:001}"
      }
   ]
}