English

How To: Add Survey123 for ArcGIS as a registered application to Portal for ArcGIS 10.3.1

Summary

Survey123 for ArcGIS became available after Portal for ArcGIS 10.3.1 was released. This application does not have a pre-registered App ID in versions of Portal for ArcGIS prior to 10.4. The following procedure allows customers running Portal for ArcGIS 10.3.1 to register the Survey123 for ArcGIS App IDs with Portal. Customers are then able to use the Survey123 application with Portal for ArcGIS 10.3.1.
 

Note:
If planning on upgrading to Portal for ArcGIS 10.4 from 10.3.1, do not use this procedure. Upgrade Portal and install Survey123 normally. See KB46344.

Procedure

Adding Survey123 as a registered application involves registering two App IDs – one for Survey123; and one for Survey123 Connect.

Use the following steps to add Survey123 and Survey123 Connect as registered applications to Portal for ArcGIS 10.3.1.

A. Add and share the Survey123 for ArcGIS app

  1. Open the ArcGIS Portal Directory sharing application and login as a member with administrative privileges. The URL format is:
https://webadaptorhost.domain.com/arcgis/sharing/rest
  1. Navigate to the administrative user’s content
http://webadaptorhost.domain.com/arcgis/sharing/rest/content/users/<username>
  1. Under Supported Operations, choose Add Item.
  2. In the Add Item form, enter:
  • Title: survey123
  • Type: Application
  • Type Keywords: Application
  • Tags: survey123
  1. Click Add Item.
  2. On the User Item page, under Supported Operations, click Share Item.
  3. On the Share Item page, set Share with Everyone to True.
  4. Click Share Item.

B. Register the Survey123 app

  1. On the User Item page, select and copy the ID value.
  2. Under Related Operations, click Register App.
  3. On the Register App page, enter:
  • Item ID: This is the ID copied in Section B, step 1.
  • App Type: Select multiple from the dropdown
  • Redirect URIs: Enter ["urn:ietf:wg:oauth:2.0:oob"] - This value allows the successful authentication response to be sent to the portal URL.
  1. Click Register App. The Registered App page displays the App ID.
  2. On the Registered App page, copy the App ID value.

C. Change the Survey123 App ID

  1. Open the ArcGIS Portal Directory admin application and login as a member with administrative privileges. The URL format is:
https://webadaptorhost.domain.com/arcgis/portaladmin
  1. Navigate to Home > Security> OAuth > Change App ID.
  2. On the Change App ID page, enter:
  • Current App ID: This is the App ID copied in step 5, Section B.
  • New App ID: Enter survey123
  1. Click Change App ID.

D. Add and share the Survey123 Connect app

  1. Open the ArcGIS Portal Directory sharing application and login as a member with administrative privileges. The URL format is:
https://webadaptorhost.domain.com/arcgis/sharing/rest
  1. Navigate to the administrative user’s content.
http://webadaptorhost.domain.com/arcgis/sharing/rest/content/users/<username>
  1. Under Supported Operations choose Add Item.
  2. In the Add Item form, enter:
  • Title: survey123connect
  • Type: Application
  • Type Keywords: Application
  • Tags: survey123connect
  1.  Click Add Item.
  2. On the User Item page, under Supported Operations, click Share Item.
  3. On the Share Item page, set Share with Everyone to True.
  4. Click Share Item.

E. Register the Survey123 Connect app

  1. On the User Item page, select and copy the ID value.
  2. Under Related Operations, click Register App.
  3. On the Register App page, enter:
  • Item ID: This is the ID copied in step 1 of Section E.
  • App Type: Select multiple from the drop-down
  • Redirect URIs: Enter ["urn:ietf:wg:oauth:2.0:oob"] - This value allows the successful authentication response to be sent to the portal URL.
  1. Click Register App. The Registered App page displays the App ID.
  2. On the Registered App page, copy the App ID value.

F. Change the Survey123 Connect App ID

  1. Open the ArcGIS Portal Directory admin application and login as a member with administrative privileges. The URL format is:
https://webadaptorhost.domain.com/arcgis/portaladmin
  1. Navigate to Home > Security> OAuth > Change App ID.
  2. On the Change App ID page, enter:
  • Current App ID: This is the App ID copied in step 5, Section E.
  • New App ID: Enter survey123connect
  1. Click Change App ID.

Related Information