🧩 Plugin & Custom API guidelines

Richtlijnen voor server-side business logica binnen Dataverse

← Terug naar Develop

1. Introductie

Plugins & Custom API's worden gebruikt voor server-side business logica binnen Dataverse.

Ze draaien binnen de event pipeline en zorgen voor consistente, betrouwbare en transactionele verwerking.

👉 Gebruik Plugins en Custom API’s voor complexe server-side business logica, validaties en integraties.

2. Doel

Plugins en Custom API’s worden toegepast voor:

  • Server-side validaties
  • Event-driven logica
  • Complexe berekeningen
  • Integraties
  • Herbruikbare API endpoints

Verschil Plugin vs Custom API

Component Doel
Plugin Reageert op events (create, update, delete)
Custom API Expliciet aanroepbare API voor integraties of interne logica

3. Opbouw van Plugins / Custom API’s

  • Entrypoint → Plugin / Custom API
  • Services → business logica
  • Helpers → ondersteunende functies
  • Core → configuratie / infrastructuur

Architectuur

											
Entrypoint (Plugin / API)
↓
Services (Business logic)
↓
Helpers
↓
Core
  • Plugins en Custom API’s bevatten geen business logica
  • Services vormen de centrale implementatie van logica
  • Helpers ondersteunen met technische functies
  • Core bevat configuratie en constants
👉 Deze scheiding zorgt voor herbruikbaarheid en onderhoudbaarheid.

Ontwikkelproces

Ontwerp

  • Bepalen van juiste implementatie (plugin vs API)
  • Definiëren van input/output
  • Analyse van afhankelijkheden

Implementatie

  • Dunne plugin / API
  • Logica in services
  • Logging en foutafhandeling

Testing

  • Unit tests (services)
  • Plugin tests (FakeXrmEasy)
  • Valideren van business logica
  • Voorkomen van regressie

Documentatie

  • Documenteer services en logica
  • Leg uitzonderingen vast

4. Wanneer gebruik je Plugins / Custom API’s

✅ Wel gebruiken
  • Server-side validaties
  • Complexe logica over meerdere entiteiten
  • Integraties
  • Transactionele verwerking
⚠️ Beperkingen
  • Meer ontwikkel- en beheerkosten
  • Deployment vereist (ALM-proces)
  • Minder geschikt voor snelle configuratie
❌ Niet gebruiken voor
  • Eenvoudige validaties → gebruik Business Rules
  • UI logica → gebruik JavaScript
  • Custom UI → gebruik PCF Controls
  • Procesautomatisering → gebruik Power Automate (Cloud Flows)
👉 Plugins en Custom API’s vormen de backend logica laag binnen het platform en zorgen voor consistente en betrouwbare server-side verwerking.

5. Decision flow (vereenvoudigd)

  • Eenvoudige validatie → Business Rule
  • UI logica → JavaScript
  • Custom UI component → PCF Control
  • Proces → Cloud Flow
  • Complexe backend logica → ✅ Plugin / API
👉 Zie het besliskader: 🔀 Logic Implementation – techniek keuze

6. Testing

  • Unit tests (services)
  • Plugin tests (bijv. FakeXrmEasy)
  • Regressietests
  • Test verschillende pipeline stages
👉 Test altijd business logica los van de plugin entrypoint.

7. Performance

  • Minimaliseer database calls
  • Gebruik early exit patterns
  • Beperk plugin execution time
  • Vermijd onnodige plugin triggers

8. ALM & Deployment

  • Deploy via solutions
  • Gebruik CI/CD pipelines
  • Versiebeheer via Git
  • Plugin registratie via tooling
👉 Plugins zijn kritische componenten → deployment moet gecontroleerd verlopen.

9. Richtlijnen

Eenvoud

  • Houd plugins klein en specifiek
  • Splits logica in services

Naming

  • Gebruik consistente naamgeving
  • [publisher].[type].[primaire entiteit].[functie]

Voorbeelden:

  • Brenke.Plugin.Account.PreCreate
  • Brenke.API.Order.CalculateTotal

Structuur

  • Scheid entrypoint en business logica
  • Gebruik dependency injection waar mogelijk

Onderhoudbaarheid

  • Voorkom duplicatie
  • Documenteer API’s en services

10. Veelgemaakte fouten

✘ Business logica in plugin entrypoint

✘ Te complexe plugins

✘ Geen unit testing

✘ Onnodige triggers

11. Troubleshooting

  • Gebruik tracing / logging
  • Controleer plugin steps en registratie
  • Analyseer exceptions
  • Gebruik debugging tools (Plugin Profiler)

12. Voorbeeld

Scenario:

  • Bij opslaan van een order moet validatie en berekening plaatsvinden

Implementatie:

  • Plugin op Create / Update
  • Business logica in service layer
  • Validatie + berekening server-side

13. Samenvatting

  • Backend logica → Plugin / API
  • Transactioneel en betrouwbaar
  • Gebruik services voor logica
  • Altijd testen binnen ALM
✅ Zeer krachtig en robuust ❌ Complex en beheersintensief