|
| 1 | +# SPFx ACE Service Health |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +SPFx ACE Service Health is a SharePoint Framework (SPFx) extension designed to monitor and display the health status of various services within your Microsoft 365 environment. It provides real-time visual feedback on service status, helping users and administrators quickly identify operational issues or interruptions. |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- **Service Health Dashboard:** Visualizes the current status of all monitored services. |
| 10 | +- **Status Indicators:** Uses color-coded icons (🟢, 🟡, 🔴) to represent operational, restricted, or interrupted services. |
| 11 | +- **Detailed Status Labels:** Friendly labels for each service state (e.g., Operational, Investigating, Degradation, Interruption). |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +## Technologies Used |
| 19 | + |
| 20 | +- **SharePoint Framework (SPFx) v1.21.1** |
| 21 | +- **React** |
| 22 | +- **TypeScript** |
| 23 | +- **@fluentui/react-components** for UI consistency |
| 24 | + |
| 25 | +## Prerequisites |
| 26 | + |
| 27 | +- Microsoft 365 tenant with SharePoint Online |
| 28 | +- Node.js and npm installed |
| 29 | +- SPFx development environment set up ([Get started](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)) |
| 30 | +- Azure FUnction deployed to provide service health data (optional, if using All usrs option selected on property pane, ) found here [SPFx-ace-service-health-azure-function](react-extension-service-health-azfn.zip) |
| 31 | +- Permissions to deploy SPFx solutions to the SharePoint site |
| 32 | + |
| 33 | +## Required Graph Permissions |
| 34 | + |
| 35 | +- `ServiceHealth.Read.All` - Read service health information for all services in the tenant. |
| 36 | + |
| 37 | +## Getting Started |
| 38 | + |
| 39 | +1. **Clone the repository:** |
| 40 | + |
| 41 | + ```bash |
| 42 | + git clone <your-repo-url> |
| 43 | + ``` |
| 44 | + |
| 45 | +2. **Navigate to the solution folder:** |
| 46 | + |
| 47 | + ```bash |
| 48 | + cd SPFx-ace-service-health |
| 49 | + ``` |
| 50 | + |
| 51 | +3. **Install dependencies:** |
| 52 | + |
| 53 | + ```bash |
| 54 | + npm install |
| 55 | + ``` |
| 56 | + |
| 57 | +4. **Run the solution locally:** |
| 58 | + |
| 59 | + ```bash |
| 60 | + gulp serve |
| 61 | + ``` |
| 62 | + |
| 63 | +## Usage |
| 64 | + |
| 65 | +- Deploy the extension to your SharePoint site. |
| 66 | +- The dashboard will automatically display the health status of configured services. |
| 67 | +- Statuses are updated in real-time and reflected with clear color-coded indicators and descriptive labels. |
| 68 | + |
| 69 | +## Version History |
| 70 | + |
| 71 | +| Version | Date | Comments | |
| 72 | +| ------- | ------------| ---------------- | |
| 73 | +| 1.0 | May 31, 2025| Initial release | |
| 74 | + |
| 75 | +## Author |
| 76 | + |
| 77 | +| Solution | Author(s) | |
| 78 | +|-------------------------|--------------------------| |
| 79 | +| ImageCard-HTML-React-Service-Health | João José Mendes | |
| 80 | + |
| 81 | +## Disclaimer |
| 82 | + |
| 83 | +**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.** |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## References |
| 88 | + |
| 89 | +- [SharePoint Framework Documentation](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/) |
| 90 | +- [@fluentui/react-components](https://react.fluentui.dev/) |
| 91 | +- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) |
0 commit comments