Table of contents
TOC
Collapse the table of content
Expand the table of content

Sandbox solution transformation guidance

Vesa Juvonen|Last Updated: 12/21/2016
|
2 Contributors

Transform or convert your code-based sandbox solutions to the SharePoint add-in model. Learn about the options and strategies on converting existing code-based functionalities to SharePoint add-in model or alternative solutions.

Applies to: add-ins for SharePoint | SharePoint 2013 | SharePoint Online

Code-based sandbox solutions were deprecated back in 2014 and SharePoint online has started the process to completely remove this capability. Code-based sandbox solutions are also deprecated in SharePoint 2013 and in SharePoint 2016.

Transforming your sandbox solutions to the SharePoint add-in model involves analyzing your existing extensions, designing and developing your new add-in(s) for SharePoint, and then testing and deploying your add-in in your production environment.

What is a code-based sandbox solution in SharePoint

Sandbox solutions are customization packages, which can be used to deploy customizations to SharePoint in site collection level. If sandbox solution contains code, it has been executed in special isolated process with limited set of APIs to access SharePoint services and content.

There are two types of Sandbox solutions

  • Code-based sandbox solutions, which contain a custom assembly in the package
  • Declarative sandbox solutions, which only contain xml based configurations and related assets

Declarative (xml based) sandbox solutions can be further divided to following types based on their use case.

  • Site template – Generated using the “Save site as a template” functionality from existing sites
  • Design package – Generated using Design Manager from publishing site
  • Custom sandbox solutions - Created in Visual Studio for example for branding assets and do not contain assemblies

Code-based sandbox solutions can be further divided to following types based on the use cases.

  • Declarative sandbox solution with empty assembly
  • Sandbox solution containing InfoPath form with code
  • Code-based sandbox solutions with customizations like web parts, event receivers and/or feature receivers
  • Sandbox solutions with custom workflow action

When you are planning to move away from the sandbox solutions, you should be evaluating the functional and business requirements of specific solution and conclude the future design direction based on those.

Steps to perform transformation

When you transform your sandbox solutions to the SharePoint add-in model, you want to ensure that the impact on your users is minimal. Carefully analyze your current sandbox solutions, and then design your new add-in for SharePoint to meet the needs of your organization. We recommend the following process to ensure a successful transformation.

  1. Readiness. Learn about:

  2. Solution assessment. Analyze the functional and business requirements by:

    • Identifying deployed sandbox solutions in your current environment for which you either can use the SharePoint Sandbox Solution scanner (video) or use specific sandbox solution inventory script. The first one is a tool offering a lot of options and a detailed inventory, the latter is a PowerShell script giving you a basic inventory. Both tools are provided to you as open source by the SharePoint PnP team.

    • Reviewing requirements with your users. Consider asking your users to demonstrate how they use the existing sandbox solutions to perform their daily work.

    • Identifying, documenting, and designing new functionality to include in the new add-in for SharePoint. Consider reviewing your list of new feature requests from your users for additional ideas.

    • Identifying unused features, and agreeing with your users to omit this functionality from the new add-in for SharePoint.

    • For each solution, determining whether to replace it with an add-in for SharePoint or implement that either using with some out of the box capabilities or using some alternative solution.

  3. Solution planning. Design the new application using the SharePoint add-in model based on:

    • The requirements gathered in step 2.

    • Your analysis of the existing code. During your code analysis, consider identifying portions of the code that can be dropped (for example, the code is no longer being used, or the requirements have changed).

  4. Develop and test the SharePoint add-in model version of your application.

  5. Deploy your new add-in.

Replacing sandbox solution customizations

Here's typical customizations which are included in the sandbox solutions and potential transformation options. We are looking on adding further information for each of the customization types, so that you can will have real-world examples on the transformation options.

CustomizationTransformation options
Declarative solution with empty assembly

You can control assembly creation from Visual Studio solution project properties. See following KB article for detais - Remove assembly reference from your Sandbox solution created in Visual Studio.

Important: that when you use the SharePoint Sandbox Solution scanner the scan output will list which solutions have an empty assembly + the tool will create updated sandbox solution packages for you in which the assembly is dropped. You can then simply replace the existing sandbox solution with the updated one.

InfoPath form with code

If you have published an InfoPath form from the InfoPath client which contains code, it’s actually published to the SharePoint as a sandbox solution. This means that the form code is actually executed by the sandbox engine in SharePoint.

Moving away from the code-based InfoPath forms is dependent on the actual business use case. There are multiple different options from generating custom UI as add-in or to utilize other form techniques.

See more details on the options via our InfoPath transformation guidance article

Web Part

Web parts are typically converted either to add-in parts or they are implemented with fully client side technologies by using so called JavaScript embed pattern.

See following resources for additional information

  • Customize your SharePoint site UI using JavaScript
  • Create add-in parts to install with your SharePoint Add-in
  • How to update your SharePoint pages via the embedding of JavaScript
  • Cross site collection navigation
  • Visual Web Part

    Visual web parts are transformed in similar ways as normal web parts. User control used in visual web part will need to be also replaced, since in sandbox solution cases, it's included inside of the assembly.

    Event Receiver

    Event receivers can in many cases be replaced with the remote event receiver implementation. Remote event receivers do however need to hosted in some platform, typically on specific provider hosted add-in.

    See following resources for additional information

  • Use remote event receivers in SharePoint
  • How to use remote event receivers for your SharePoint add-ins
  • Feature Receiver

    Are typically replaced with a remote API based operation, like using CSOM or REST for applying the needed customization or configuration to site level. If needed API is missing from the remote APIs (CSOM/REST), report this gap using SharePoint UserVoice.

    Feature receivers are used for example to set a custom master page or theme to site, when they are activated. These kind of operations can be easily replaced with remote code based solutions or using PnP PowerShell, which provides easy commands for controlling site configuration.

    Custom workflow action

    Typical code migration path for these kind of customizations is to start using either SharePoint 2013 workflows, move using alternative solutions, like Microsoft Flow or using third party solutions.

    We are looking for adding specific articles on the transformation techniques for specific technical scenarios.

    Removing your sandbox code from your site

    When you deactivate your existing sandbox solution from sites, any assets or files deployed using declarative options will not be removed. If you have used sandbox solutions to introduce new code-based web parts, those functionalities will be disabled from the sites. This means that the pages are still rendering normally, so there's no direct end user impact when solution is deactivated, except removal of the code-based functionalities, like web parts.

    How will support of code-based sandbox solution be removed from SharePoint Online?

    Support will be removed by disabling code-based operations to be executed from sandbox-solution-based code. This means that your sandbox solutions will not be explicitly deactivated from the solution store, but any code based operation will no longer be performed. Sandbox solutions will ‘remain in activated’ status in the solution gallery. Features deployed using sandbox solutions will not get deactivated automatically, which means that possible code associated to feature deactivation or uninstall handlers won't be run.

    All declarative definitions in the sandbox solution will continue working after this change is be applied in SharePoint Online.

    Additional resources

    © 2017 Microsoft