Web API

Übersicht

Über dieses API wird das Web Portal an daylight angebunden und es erlaubt Drittapplikationen den Zugriff auf daylight-Daten und -Funktionalitäten. Für die Haupt-Applikationsbereiche (Adressverwaltung, Eventmanagement etc.) bietet das API zwei verschiedene Zugriffskonzepte an:

  • Die daylight Simple Typed Services liegen in strukturierter Form vor (typed) und sind ein einfaches, leicht verständliches Set von Methoden für Standard-Anwendungsfälle.
  • Die Generic Business Object und Business Logic Provider bieten einen generischen Zugriff auf das daylight zugrunde liegende Metadatenmodell. Dieses Methoden kommen zum Einsatz bei komplexeren Anwendungsfällen und in Bereichen, welche nicht von den Simple Type Services abgedeckt werden.

Neben diesen Services für die einzelnen Applikationsbereiche beinhaltet das API zusätzliche typisierte Komponenten, welche unterstützende Funktionalitäten wie beispielsweise Workflow-Abwicklung, E-Mail-Versand, Zugriff auf das Dokumentenverwaltungssystem und Reportgenerierung beinhalten.

Komponenten

daylight Simple Typed Services

Einfach gehaltene, typsierte Webservice-Methoden pro Applikationsbereich für Standard-Anwendungsfälle.

  • Data Transfer Objects (Dtos) und Read/Write-Methoden pro daylight-Entität.
  • Execute-Methoden für spezfische Anwendungsfälle, z.B. Rechnung erstellen usw.
  • Einfaches Messaging für Feld-Validierungen und Fehlermeldungen.
  • Einfaches Row State Management.
  • Kundenspezifische Felder können generisch in die Dtos integriert und übermittelt werden.

Generic Business Object und Business Logic Provider

Methoden-Set für generisches Lesen und Schreiben von daylight Business Objects sowie generisches Ausführen von daylight Business Logic.

  • Integrierte Query-Language für das Formulieren von Abfragen.
  • Business Logic Matching: Liefert Business Methoden, welche in einem bestimmten Daten-Kontext ausgeführt werden können.
  • ...

Workflow

Zugriff auf die daylight Workflow Engine.

  • Abfragen der Workflow-Strukturen (Stati, Status-Übergänge etc.) für die einzelnen Objekttypen.
  • Objekte-Statuswechsel vornehmen und Auslösen der hinterlegten Statuswechsel-Aktionen (Reports generieren, Mailversand etc.)

User Security

Zugriff auf das daylight Security Model.

  • Abfrage von Benutzern, Rollen und Rechten

Document Management

Zugriff auf das daylight Document Management System.

  • Dokumente aus dem DMS auslesen
  • Neue Dokumente ins DMS einfügen
  • Verknüpfen von Dokumenten mit daylight Business Objekten.

Send Email

Komponente für den Mailversand (inkl. Attachments)

Report Generator

Zugriff auf die daylight Reporting Engine.

  • Auslesen der Report-Definitionen
  • Report Definition Matching: Welche Reports können in welchem Datenkontext ausgeführt werden
  • Generieren von Reports aller Typen (Banded-Report, Serienbrief, E-Mail)
  • Konvertieren von Reports in die gängigen Output-Formate (PDF, etc.)