Overview of deploying add-ins

Add-ins are uploaded to ArcGIS Online or Portal for ArcGIS, and from there an operation view author can include the add-in within an operation view.

When a user opens an operation view, referenced add-ins are automatically downloaded to a cache on the local machine. Updates to add-ins are also automatically downloaded.

How to deploy add-ins to users

Use the following steps to deploy an add-in to other users as part of an operation view:

1. First develop and test the add-in locally.

   See the Testing add-ins topic for more information.

2. Upload the .opdashboardAddin add-in file to ArcGIS Online or Portal for ArcGIS.

   For more information see the How to upload a new add-in topic.

3. Open and edit the operation view in which the add-in will be configured.
   Note:

   It is recommended that operation views containing add-ins are configured using this end user installation, in order to ensure the developer has a compatible application.

4. Choose Widgets, then Manage Add-Ins.

   the Manage Add-Ins dialog box appears.

5. In the Manage Add-Ins dialog box, tap or click Add. Browse to the uploaded add-in, and tap or click Open. Dismiss the Manage Add-Ins dialog box.
   Caution:

   During development, add-ins are loaded from a specific location by using the /addinpath parameter when starting the application. In order to correctly deploy the add-in to other users however, it must first be uploaded, then included in an operation view by using Manage Add-Ins. By using the downloaded add-in, the unique number identifying the item in ArcGIS Online or Portal for ArcGIS is included in the operation view.

6. Author the operation view as usual, for example by choosing Widgets, then Add Widget, to include any widgets from the downloaded add-in.
7. Save and share the operation view as usual, for example by using the Share panel to share the operation view and the referenced add-in.

Now users can open the shared operation view, at which point the add-in will be automatically downloaded to the local machine cache.

Deploying updates to add-ins

Updates to the add-in will also be automatically downloaded when a user opens the operation view.

See the How to update an add-in topic for more information.

Removing an add-in

Add-ins can be removed from ArcGIS Online or Portal for ArcGIS.

How to remove an add-in

Sharing add-ins with other users

Like other resources from ArcGIS Online or Portal for ArcGIS, an add-in must be shared with the same users that the operation view and other online resources are shared with. The Share panel in the application allows you to share all referenced online resources with a single action.

End users of the application are not generally aware of the difference between functionality provided by add-ins and out-of-the-box system functionality. However, there is one exception to this. If an end user opens an operation view that references an add-in that they do not have access to, the user will see a warning. In this case the author should ensure that intended users have access to all of the items required by using the Share panel in the application to update sharing settings.

Although the Share panel should ensure that all items have the same access level as the operation view, this does not prevent subsequent changes to sharing permissions, or the deletion of the item entirely.