128 lines
7.0 KiB
Markdown
128 lines
7.0 KiB
Markdown
# SPUPS Photo Sync
|
|
|
|
## Summary
|
|
|
|
This web part will help the administrators to synchronize the **User Profile Photos** from **Azure AD** or from the **local filesystem** to **SharePoint User Profile Store**.
|
|
|
|
## Features
|
|
|
|
* **User selection** will help you to update only specific user based on the selection. It will also allow the users to fetch the photos from **Azure AD** before starting the synchronization.
|
|
|
|
* **Bulk Sync** will allow the admin to upload the photos from their file shares. The filename should be in the format '**UserID.jpg**'
|
|
|
|
* **Access control** based on **SharePoint Group**, not all the users can access the application.
|
|
|
|
* Separate section to check the **status** of the photo update.
|
|
|
|
* **Azure Function** to handle the photo update. **PnPPowershell** is used in Azure Function.
|
|
|
|
* The application supports **SPA**.
|
|
|
|
> **_Note_**: All the supporting lists were created when the web part is loaded for the first time. Whenever the web part is loaded, the supported lists were checked whether it exists or not.
|
|
|
|
## Properties
|
|
|
|
1. **Select a library to store the thumbnails**: A document library to store the thumbnail photos.
|
|
|
|
2. **Delete thumbnail stored**: This flag will decide whether you want to keep the thumbnails generated or to clean it after the sync completed.
|
|
|
|
3. **Azure Function URL**: Azure function URL to run the photo update.
|
|
|
|
4. **Use Certificate for Azure Function authentication**: The video mentioned below to setup Azure Function has different options. This setting will decide whether to use the certificate or stored credentials to communicate with SharePoint.
|
|
|
|
5. **Date format**: Date format to be used across the entire application. Used _**momentJS**_.
|
|
|
|
6. **SharePoint Groups**: Only the users from the configured SharePoint Groups and Site Administrator shall be allowed access.
|
|
|
|
7. **Use page full width**: This is used when the web part is added to a site page where it has to use full width.
|
|
|
|
## Preview
|
|
|
|
### User Selection sync
|
|
|
|
|
|
|
|
### Bulk sync
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
| :warning: Important |
|
|
|:---------------------------|
|
|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|
|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
|
|
|
|
|
|
|
|
|
|
|
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
|
|
|
|
|
|
|
|
|
|
|
## Applies to
|
|
|
|
* [SharePoint Framework](https:/dev.office.com/sharepoint)
|
|
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
|
|
|
|
## Prerequisites
|
|
|
|
None
|
|
|
|
## Contributors
|
|
|
|
* Sudharsan K.([@sudharsank](https://twitter.com/sudharsank), [SPKnowledge](https://spknowledge.com/))
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.0.0.0|Sep 13 2020|Initial release
|
|
|
|
## Minimal Path to Awesome
|
|
|
|
- Clone this repository
|
|
- in the command line run:
|
|
- `npm install`
|
|
- `gulp bundle --ship && gulp package-solution --ship`
|
|
- Add the `.sppkg` file to the app catalog and add the **SPUPS Photo Sync** web part to the page.
|
|
- **Azure Function** has to be setup for property update. **The actual powershell is uploaded in the assets folder**. Follow the steps explained in the video by [Paolo Pialorsi](https://www.youtube.com/watch?v=plS_1BsQAto&list=PL-KKED6SsFo8TxDgQmvMO308p51AO1zln&index=2&t=0s).
|
|
|
|
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
|
|
|
|
|
|
#### Local Mode
|
|
This solution doesn't work on local mode.
|
|
|
|
#### SharePoint Mode
|
|
If you want to try on a real environment, open:
|
|
[O365 Workbench](https://your-domain.sharepoint.com/_layouts/15/workbench.aspx)
|
|
|
|
## Video
|
|
|
|
[](https://www.youtube.com/watch?v=0z4QqIo67gQ "Sync photos from Azure AD to SharePoint using Microsoft Graph and Azure Function")
|
|
|
|
## Help
|
|
|
|
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
|
|
|
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-photo-sync") to see if anybody else is having the same issues.
|
|
|
|
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-photo-sync) and see what the community is saying.
|
|
|
|
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-photo-sync&template=bug-report.yml&sample=react-photo-sync&authors=@sudharsank&title=react-photo-sync%20-%20).
|
|
|
|
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-photo-sync&template=question.yml&sample=react-photo-sync&authors=@sudharsank&title=react-photo-sync%20-%20).
|
|
|
|
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-photo-sync&template=question.yml&sample=react-photo-sync&authors=@sudharsank&title=react-photo-sync%20-%20).
|
|
|
|
## Disclaimer
|
|
|
|
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
|
|
|
|
|
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-photo-sync" />
|