Sharepoint Online Custom Solution Resources Applies To: Office 365 Dedicated – Legacy Release
Total Page:16
File Type:pdf, Size:1020Kb
SharePoint Online Custom Solution Resources Applies to: Office 365 Dedicated – Legacy Release Topic Last Modified: 2014-04-07 This section describes resources available to customers and third party providers building custom solutions for SharePoint Online Dedicated. Custom Solutions Resources for SharePoint Online Dedicated The resources available to developers of SharePoint Online custom solutions include: Custom Solution Policies and Process (FTC) This article describes the policies and process that govern how Microsoft and its subscribers to SharePoint Online for enterprises dedicated plans validate and deploy custom solutions to the SharePoint Online environment. SharePoint Online Custom Solution Developer's Guide (Dedicated Plans) This article provides SharePoint Online Dedicated plan customers with guidelines and best practices to help you develop custom solutions that you can deploy to the SharePoint Online environment. Submitting Custom Solutions to SharePoint Online Using MSOCAF This article describes how to use Microsoft SharePoint Online Code Analysis Framework (MSOCAF), which is the tool you use to validate and submit SharePoint Online custom solutions. SharePoint Online Custom Solution Resources Legacy Release Office 365 Dedicated & ITAR-support Plans © 2015 Microsoft Corporation. All rights reserved. Page 1 of 222 Custom Solution Policies and Process (FTC) Topic Last Modified: 2014-04-11 This article describes the policies and process that govern how Microsoft and its subscribers to SharePoint Online Dedicated validate and deploy custom solutions to the SharePoint Online environment. These custom solutions include solutions and products that are developed by third parties and code developed in-house by customers. Custom solutions can be deployed to any web application in the SharePoint Online Dedicated environment (Portal, Team, Partner, or Personal Sites). Topics include: Custom Solution Policies and Process Introduction Custom Solution Process Custom Solution Policies Custom Policies and Process Appendix SharePoint Online Custom Solution Resources Legacy Release Office 365 Dedicated & ITAR-support Plans © 2015 Microsoft Corporation. All rights reserved. Page 2 of 222 Custom Solution Policies and Process Introduction Topic Last Modified: 2014-04-16 Introduction This article describes the policies and process for creating, validating, and deploying custom solutions for SharePoint Online using the full trust code method. This method helps ensure a successful deployment of your custom solutions. Custom solutions can be deployed to any web application in the SharePoint Online Dedicated environment (Portal, Team, Partner, or Personal Sites). Your custom solutions can include solutions and products that are developed by third parties, as well as code that you develop in-house. The goal of these guidelines is to ensure that a custom solutions deployed to the SharePoint Online environment can be operated, managed, secured, and scaled following established best practices. To meet that goal, Microsoft: Checks whether an existing custom solution, or an out-of-the-box solution, can accomplish the same goals as the proposed custom solution. Reviews the high-level design of custom solutions. Provides feedback to ensure your custom solutions can be hosted by SharePoint Online. Evaluates the custom solution deployment package and the final custom solution code to ensure they can be deployed to and hosted on the SharePoint Online environment. The review incorporates manual test cases and follows best practices established by Microsoft. Deploys custom solutions in Microsoft test environments for a complete deployment review and release verification. These guidelines are only for fully trusted code that is deployed or executed by Microsoft on Microsoft SharePoint 2010 or Office SharePoint Server 2007 servers. Typically, this includes code based on SharePoint Online Custom Solution Resources Legacy Release Office 365 Dedicated & ITAR-support Plans © 2015 Microsoft Corporation. All rights reserved. Page 3 of 222 Microsoft .NET Framework and dependent files, but can also include Windows PowerShell scripts or batch files. These guidelines do not apply to other methods of customizing a SharePoint Online environment, such as: End-user solutions. A customization that is performed through a web-based mechanism, such as applying style sheets, out-of-the-box Web Parts, or page templates. Authored site customization. A customization that is performed by web designers using HTML editors, such as customization of master pages or page layouts. This also includes declarative solutions using SharePoint Designer and SharePoint site administrative pages in a browser, such as data access with Business Connectivity Services or connecting list and data view Web Parts. Sandboxed solutions (partially trusted code). A customization created by developers. These solutions typically contain .NET Framework–based code and dependent files deployed to SharePoint site collections by your site collection administrators. However, we do recommend analyzing the code of a sandboxed solution by using the Microsoft SharePoint Online Code Analysis Framework tool (MSOCAF). For an introduction to the MSOCAF tool, see About MSOCAF. To learn more about using sandboxed solutions, see Appendix A: SharePoint Online Policies for Sandboxed Solutions. Security Note: Please keep the following in mind when using these guidelines: The policies and process described here don’t apply to standard configurations. They apply only to custom solutions. Don’t include standard Configuration Request (CR) changes when you submit your copy of the deployment guide (MSODeploymentGuide). For standard configurations, contact your Microsoft service delivery manager (SDM) to submit a CR for the standard configuration change. Use the CR templates available on the Service Administration portal. Benefits When you develop custom solutions with Microsoft, you gain: A structured process. Microsoft uses a structured review process to help with custom solution performance, scalability, availability, and upgrade. Experience in deploying custom solutions. Microsoft has extensive experience with deploying custom solutions, including custom-written, off-the-shelf, and hybrid solutions that rely on custom code and third-party products. SharePoint Online Custom Solution Resources Legacy Release Office 365 Dedicated & ITAR-support Plans © 2015 Microsoft Corporation. All rights reserved. Page 4 of 222 Capacity planning experience. Microsoft has experience with evaluating how a custom solution is managed, monitored, and instrumented, and whether it has the ability to scale, Microsoft can also suggest an infrastructure design to meet your needs. What You Should Know You should have experience with: Internet Information Services (IIS). Life-cycle-based development and testing of .NET Framework-based code. For more developer resources about the development process and best practices, see SharePoint Online Custom Solution Developer's Guide (Dedicated Plans). Custom Solution Reviews Microsoft reviews the proposed design of your custom solutions at an early stage and the packaged solution after it has been developed. Microsoft waits until after you validate the service before reviewing any of your custom solutions. If you choose to develop and submit farm-level custom solutions for deployment by Microsoft, you can do so after purchasing custom solution credits. You must allow the necessary time for these reviews when you schedule custom solution development and deployment, as described in Custom Solution Process. You will receive a change window schedule from your service delivery manager (SDM) to help you calculate the work-back dates for: Developing your custom solution. Submitting a deployment package. The test and review process. SharePoint Online Custom Solution Resources Legacy Release Office 365 Dedicated & ITAR-support Plans © 2015 Microsoft Corporation. All rights reserved. Page 5 of 222 Custom Solution Parameters When Microsoft acknowledges receipt of a custom solution that you have submitted for deployment, you‘re charged for one or more custom solution credits. The number of custom solution credits you’re charged is based on the amount of code and the number of solution packages as detailed in Custom Solution Scoping Policy. Note: Credits are purchased as a Deployment and Upgrade Pack. For more information, contact the relevant sales team. However, you aren’t charged a custom solution credit when an update to a custom solution falls within the scope of the original SharePoint Online High Level Design (HLD) document. For example, you aren’t charged when you update a custom solution to work with a newer version of SharePoint, or if you discover a bug that requires a code change but not an HLD change. There is also no charge for reviewing third-party solutions for use in the SharePoint Online environment or for deploying those third-party solutions. About MSOCAF Microsoft SharePoint Online Code Analysis Framework (MSOCAF) is the tool you use to validate and submit SharePoint Online custom solutions. MSOCAF includes a set of executable rules to help you analyze custom solutions you plan to deploy to SharePoint Online prior to submitting those solutions for deployment. This means you can identify and address any code issues before submission. Important: You must use MSOCAF and submit a deployment manifest to complete the custom solution deployment process. Important: MSOCAF performs