This post is article 28 from the 30 Articles App series for SharePoint
Web components can also be deployed programmatically using a remote event receiver InstalledEventEndpoint or an UpgradedEventEndpoint. If you are adding components in other than the app web you should also implement an UninstallingEventEndpoint that uninstalls those same components.
Handling the app updated event :
Your sharepoint app should have valid UpgradedEventEndpoint refering to your remote service.
In web project , open AppEventReceiver.svc.cs file and add a conditional structure to the ProcessEvent to handle appUpdated event like following.
if (properties.EventType == SPRemoteEventType.AppUpgraded)
using (ClientContext cc = TokenHelper.CreateAppEventClientContext(properties, true))
// CSOM code that accesses the app web
using (ClientContext cc = TokenHelper.CreateAppEventClientContext(properties, false))
// CSOM code that accesses the host web
// Other update code as per your need
Provide conditional structure to handle the app updated event on subsequent updates
Version ver2OOO = new Version("220.127.116.11");
if (properties.AppEventProperties.PreviousVersion < ver2OOO)
// Code to update from 18.104.22.168 to 22.214.171.124 is here.
Version ver3OOO = new Version("126.96.36.199");
if (properties.AppEventProperties.PreviousVersion < ver3OOO)
// Code to update from 188.8.131.52 to 184.108.40.206 (previous update code) is here.
// Code to update from 220.127.116.11 to 18.104.22.168 is here.
catch (Exception e)
// Make sure you catch all exceptions while updating and rollback to undo if that is necessary.
result.ErrorMessage = "error message : " + e.Message;
result.Status = SPRemoteEventServiceStatus.CancelWithError;
In some cases, you might need to migrate data or upgrade schema. If your old data is somewhere that can be accessed by a remote event handler, you can implement migration logic in an InstalledEventEndpoint web service of the new app. Alternatively, if the new app has access to the old data, you can put the migration logic in code that runs the first time that a user starts the new app. If the old data cannot be accessed by either the remote handlers or the new app, you can create an update of the old app that adds a data export capability and a UI for the capability. Users would first update the old app, and then use it to export the data to a location where the new app can access it. You include the capability and UI to import data in the new app.
This post is article 27 from the 30 Articles App series for SharePoint
When an app is installed, the SharePoint host environment records the version number for the installed app instance. App catalog sites always track their version number with the Office Store and detect if there is any update is available or not. The upgrade process by the SharePoint app model provides user-friendly experience which looks like below steps.
The app tile you will show “An update for this app is available” approx. 24hrs after an app update is published to the app store.
By default, SharePoint checks every 24 hours for updates to installed apps. A farm administrator can change this value to whichever is suitable. SharePoint Management Shell command, where h is the number of hours between checks.
Set-SPInternalAppStateUpdateInterval -AppStateSyncHours h
If you need to run this update immediately then you can click on “About” from the app tile – > get it and trust it to update the app.
Make sure you do not change the ProductID number.
Major steps that may be needed when you create an update for an app for SharePoint :
- Raise the Version number in the App element of the appmanifest.xml file. (MUST BE DONE)
- Change the AppPermissionRequests and AppPrerequisites section of the appmanifest.xml file.
- If your updating app-web components then Add any new components to the Feature exactly as you would if you were creating a new app for SharePoint project. Change existing files as needed. Open the Feature XML for editing, Increment the Version attribute of the Feature element.
- Updating host-web components – custom actions and app parts is easier than in the app web. You don’t need any update semantics. Just add/change the custom actions and app parts. When the app for SharePoint is updated, SharePoint always applies any new element manifest files and reapplies any changed element manifest files with the most recent version. When you update an app part, SharePoint replaces the old version with the new version in the Web Part gallery. Be sure to change the Name property of the ClientWebPart object when you update an app part. Doing this ensures that, when the app is updated, SharePoint will remove the old version of the app part (which is no longer part of the app) from all pages to which it was added. Users will need to re-add the new version to pages.
You can also deploy web components programmatically using a remote event receiver, which I will cover in next article.