Skip to content

Commit 39226a1

Browse files
committed
Merge branch 'scenario-guidance'
2 parents 79072b2 + 35c4a00 commit 39226a1

17 files changed

+1755
-1
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Application Lifecycle Management
2+
3+
## Summary
4+
Microsoft SharePoint gives developers several options for creating and deploying applications that are based on SharePoint Online, or SharePoint 2013/2016 on-premises. SharePoint offers increased flexibility in the shape applications can take as well as new options for using standards-based technologies with applications. However, developers must be able to infuse quality, testing and Application Lifecycle Management (ALM) considerations into the development process. In this article you can find some useful references to the available options in the fields of ALM while developing SharePoint technologies.
5+
6+
## Available options
7+
8+
### SharePoint Add-Ins
9+
10+
_**Applies to:** SharePoint Online | SharePoint 2013 | SharePoint 2016_
11+
12+
The SharePoint Add-In Model introduces new development techniques, mainly based on client-side code. Thus, the ALM of SharePoint Add-In solutions is slightly different from the previous Sandbox or Full Trust Code (FTC) solutions. Here follow articles and videos about how to manage ALM with the SharePoint Add-In model.
13+
14+
### Articles
15+
* [SharePoint Application Lifecycle Management](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/sharepoint-server-application-lifecycle-management)
16+
* [Application Lifecycle Management (ALM) APIs](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins)
17+
* [Set up a general development environment for SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/set-up-a-general-development-environment-for-sharepoint)
18+
19+
### Solutions
20+
* [Tenant Information Portal](https://github.com/SharePoint/PnP-Tools/tree/master/Solutions/Tenant%20Information%20Portal)
21+
22+
### Videos
23+
* [PnP Webcast - ALM APIs for SharePoint Framework solutions and add-ins](https://www.youtube.com/watch?v=MUmd85-E5SI&index=1&list=PLR9nK3mnD-OUnJytlXlO84fQnYt50iTmS)
24+
25+
### SharePoint Framework
26+
27+
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2016 (FP2)_
28+
29+
The new development model of SharePoint Framework (SPFx) introduces new tools and techniques to develop SPFx solutions. Here follows a list of useful articles about ALM with SPFx.
30+
31+
### Articles
32+
* [Set up your Office 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
33+
* [Set up your SharePoint Framework development environment](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-development-environment)
34+
* [SharePoint Framework (SPFx) enterprise guidance](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/enterprise-guidance)
35+
* [Team-based development on the SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/team-based-development-on-sharepoint-framework)
36+
* [SharePoint Framework solutions governance considerations](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/governance-considerations)
37+
* [Application Lifecycle Management (ALM) APIs](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins)
38+
* [Working With: ALM API](https://github.com/SharePoint/PnP-JS-Core/wiki/Working-With:-ALM-API)
39+
40+
### Videos
41+
* [PnP Webcast - ALM APIs for SharePoint Framework solutions and add-ins](https://www.youtube.com/watch?v=MUmd85-E5SI&index=1&list=PLR9nK3mnD-OUnJytlXlO84fQnYt50iTmS)
42+
* [PnP Webcast - VSTS Build and Release Pipelines for SharePoint Framework Solutions](https://www.youtube.com/watch?v=0LysOXWbC2A)

docs/scenario-guidance/Branding.md

Lines changed: 239 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Business Processes
2+
3+
## Summary
4+
Managing business processes related to items or documents stored in Microsoft SharePoint is a very common use case, which can be solved using various techniques. In this article you can find the available options for designing and running business processes in SharePoint Online and/or SharePoint 2013/2016 on-premises.
5+
6+
## High-level guideline/general rules
7+
Before going through the most common available options for managing business processes, let's see some useful high-level guidelines and general rules:
8+
* Whenever you need to run long-running business processes, rely on asynchronous processes that can be executed in background and independently from SharePoint
9+
* Try to keep the processes as much simple as you can, using small building blocks eventually connected in a chain, rather than using huge processes that can be complex to maintain and difficult to debug
10+
* Try to use stateless processes as much as you can, to avoid allocating too many resources while running them and to define a more scalable solution, which can be hosted on multiple servers
11+
12+
## Available options
13+
14+
### Logic Apps
15+
16+
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2013 | SharePoint 2016_
17+
18+
Azure Logic Apps simplifies how you build automated scalable workflows that integrate apps and data across cloud services and on-premises systems.
19+
With Logic Apps you can build, schedule, and automate processes as workflows so you can integrate apps, data, systems, and services across enterprises or organizations. Logic Apps simplifies how you design and create scalable solutions for app integration, data integration, system integration, enterprise application integration (EAI), and business-to-business (B2B) communication, whether in the cloud, on premises, or both.
20+
21+
### Articles
22+
* [Logic Apps](https://azure.microsoft.com/en-us/services/logic-apps/)
23+
* [Quickstart: Build your first logic app workflow - Azure portal](https://docs.microsoft.com/en-us/azure/logic-apps/quickstart-create-first-logic-app-workflow)
24+
* [Get started with the SharePoint Online connector](https://docs.microsoft.com/en-us/azure/connectors/connectors-create-api-sharepointonline)
25+
* [Get started with the SharePoint connector](https://docs.microsoft.com/en-us/azure/connectors/connectors-create-api-sharepointserver)
26+
* [Choose between Flow, Logic Apps, Functions, and WebJobs](https://docs.microsoft.com/en-us/azure/azure-functions/functions-compare-logic-apps-ms-flow-webjobs)
27+
28+
### Videos
29+
* [Slice, dice, and route your SharePoint documents with Microsoft Flow, Azure Logic Apps, and Microsoft PowerApps](https://azure.microsoft.com/en-us/resources/videos/build-2017-slice-dice-and-route-your-sharepoint-documents-with-microsoft-flow-azure-logic-apps-and-microsoft-powerapps/)
30+
* [Microsoft Azure and Office 365 together: The modern business development platform](https://azure.microsoft.com/en-us/resources/videos/microsoft-ignite-2017-microsoft-azure-and-office-365-together-the-modern-business-development-platform/)
31+
32+
### Microsoft Flow
33+
34+
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2013 | SharePoint 2016_
35+
36+
Microsoft Flow is a service that helps you create automated workflows between your favorite apps and services to synchronize files, get notifications, collect data, and more. From within a Flow, you can connect to SharePoint Online or to an on-premises SharePoint 2013 or 2016 farm using the On-Premises Data Gateway to manage documents and list items. Moreover, Microsoft Flow is fully integrated with the modern lists and libraries of SharePoint Online.
37+
As a developer, you can extend Microsoft Flow, enabling even more powerful solutions for organizations and customers.
38+
39+
### Articles
40+
* [Get started with Microsoft Flow](https://docs.microsoft.com/en-us/flow/getting-started)
41+
* [Create a flow for a list or library in SharePoint Online or OneDrive for Business](https://support.office.com/en-us/article/create-a-flow-for-a-list-or-library-in-sharepoint-online-or-onedrive-for-business-a9c3e03b-0654-46af-a254-20252e580d01)
42+
* [Introducing Microsoft Flow integration for SharePoint Document Libraries](https://flow.microsoft.com/en-us/blog/flow-in-spo-document-libraries/)
43+
* [Choose between Flow, Logic Apps, Functions, and WebJobs](https://docs.microsoft.com/en-us/azure/azure-functions/functions-compare-logic-apps-ms-flow-webjobs)
44+
45+
### Videos
46+
* [Slice, dice, and route your SharePoint documents with Microsoft Flow, Azure Logic Apps, and Microsoft PowerApps](https://azure.microsoft.com/en-us/resources/videos/build-2017-slice-dice-and-route-your-sharepoint-documents-with-microsoft-flow-azure-logic-apps-and-microsoft-powerapps/)
47+
48+
### Workflow Manager of SharePoint 2013/2016
49+
50+
_**Applies to:** SharePoint Online | SharePoint 2013 | SharePoint 2016_
51+
52+
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the Workflow Manager engine. In SharePoint Online you can only use declarative workflows, designed in SharePoint Designer 2013, or Workflow Add-Ins built using Microsoft Visual Studio and the SharePoint Add-In Model. In SharePoint 2013/2016 you can eventually create custom code-based workflows or custom actions. However, you should be careful using code-based workflows on-premises, because that could be a road blocker while migrating to SharePoint Online and Office 365.
53+
54+
### Articles
55+
* [Get started with workflows in SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/get-started-with-workflows-in-sharepoint)
56+
* [SharePoint workflow development best practices](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/sharepoint-workflow-development-best-practices)
57+
* [Workflow actions and activities reference for SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/workflow-actions-and-activities-reference-for-sharepoint)
58+
59+
### Samples
60+
* [Create custom activities for workflow](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.Activities)
61+
* [Workflow.AssociateToHostWeb](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.AssociateToHostWeb)
62+
* [Call custom web services from a workflow](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.CallCustomService)
63+
* [Call custom web service update SharePoint via web proxy](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.CallServiceUpdateSPViaProxy)
64+
* [Handle custom events in a workflow](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.CustomEvents)
65+
* [Workflow with custom forms (initiation and task)](https://github.com/SharePoint/PnP/tree/master/Samples/Workflow.CustomTasks)
66+
67+
### Windows Workflow Foundation 3.x of SharePoint 2010
68+
69+
_**Applies to:** Office 365 | SharePoint Online | SharePoint 2013 | SharePoint 2016_
70+
71+
Both in SharePoint Online and in SharePoint 2013/2016 on-premises you can define workflow processes using the legacy Windows Workflow Foundation 3.x engine. However, those are available just for backward compatibility, and you shouldn't create fresh new solutions based on this technology. Nevertheless, using Microsoft SharePoint Designer 2013, you can still create such kind of workflows.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: Custom configurations
3+
ms.date: 03/22/2018
4+
---
5+
# Custom configurations
6+
7+
## Summary
8+
9+
Allowing the different aspects of a SharePoint solution to be configurable makes them more versatile. Using its configuration, you can control how the solution is working, without having to change its code and redeploy it to your tenant. SharePoint offers you a number of different way to store and handle solution configuration properties. You can choose the location where to store your configuration settings, depending on who is supposed to manage them.
10+
11+
## High-level guideline/general rules
12+
13+
- Don't store secrets, such as credentials, in SharePoint as different users might be able to access them.
14+
- Don't assume the integrity of the configuration values as they could be modified by users and other applications.
15+
- Choose the storage for your configuration settings, based on the target audience who will be managing them.
16+
17+
## Available options
18+
19+
### General recommendations
20+
21+
### Tenant properties
22+
23+
_**Applies to:** Office 365_
24+
25+
Tenant properties allow tenant administrators to add properties in the App Catalog that can be read by various SharePoint Framework components. The tenant properties are managed by tenant administrators by using the Microsoft SharePoint Online Management Shell, which is a PowerShell module to manage your SharePoint Online subscription in Office 365 or using the [Office 365 CLI](https://aka.ms/o365cli).
26+
27+
#### Related resources
28+
29+
##### Articles
30+
31+
- [SharePoint Online tenant properties](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties)
32+
33+
##### Videos
34+
35+
- [PnP Webcast - Working with Tenant Properties in SharePoint Online](https://www.youtube.com/watch?v=SVIrtZ2nM6s)
36+
37+
### Property bags
38+
39+
_**Applies to:** Office 365 | SharePoint Server_
40+
41+
### SharePoint Framework
42+
43+
_**Applies to:** Office 365 | SharePoint Server_
44+
45+
#### Related resources
46+
47+
##### Articles
48+
49+
- [Make your SharePoint client-side web part configurable](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/basics/integrate-with-property-pane)
50+
- [Simplify adding web parts with preconfigured entries](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/simplify-adding-web-parts-with-preconfigured-entries)
51+
- [Validate web part property values](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/validate-web-part-property-values)
52+
- [Integrate web part properties with SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/integrate-web-part-properties-with-sharepoint)
53+
- [Build custom controls for the property pane](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/build-custom-property-pane-controls)
54+
55+
##### Videos
56+
57+
- [PnP Shorts - Optimizing validation of client-side web part configuration](https://www.youtube.com/watch?v=yIVpdBICMmM)
58+
- [PnP Webcast - Integrate Client-Side Web Part Properties with SharePoint](https://www.youtube.com/watch?v=iB8PBs8RH-E)
59+
- [PnP Webcast - Custom Property Pane Controls with SharePoint Framework](https://www.youtube.com/watch?v=d_9o3tQ90zo)
60+
- [PnP Webcast - Validating SharePoint Framework client-side web part property values](https://www.youtube.com/watch?v=6r6MqUDzKvI)
61+
- [PnP Shorts - Correctly handling numeric web part properties](https://www.youtube.com/watch?v=vrPnOw-XxNM)
62+
63+
##### Samples
64+
65+
- [Angular client-side web part (passing web part configuration to Angular and reacting to configuration changes)](https://github.com/SharePoint/sp-dev-fx-webparts/blob/master/samples/angular-todo/README.md)
66+
- [Weather SharePoint Framework field customizer](https://github.com/SharePoint/sp-dev-fx-extensions/blob/master/samples/js-field-weather/README.md)
67+
- [Announcements SharePoint Framework application customizer](https://github.com/SharePoint/sp-dev-fx-extensions/blob/master/samples/react-app-announcements/README.md)
68+
- [Conditional formatting SharePoint Framework field customizer](https://github.com/SharePoint/sp-dev-fx-extensions/blob/master/samples/js-field-conditionalformatting/README.md)
69+
- [Directions SharePoint Framework list view command set](https://github.com/SharePoint/sp-dev-fx-extensions/blob/master/samples/react-command-directions/README.md)
70+
71+
### SharePoint add-ins
72+
73+
_**Applies to:** Office 365 | SharePoint Server_
74+
75+
### Farm solutions
76+
77+
_**Applies to:** Office 365 | SharePoint Server_

0 commit comments

Comments
 (0)