Skip to content

Commit 15eca7f

Browse files
waldekmastykarzVesaJuvonen
authored andcommitted
Added custom configuration guidance (SharePoint#1355)
* Added custom configuration guidance * Added summary and high-level guidance
1 parent 68bcf12 commit 15eca7f

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed
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)