Workflow Analytics API

Die Workflow Analytics API vereinfacht die Integration von Workflow-Daten, indem sie Daten bereitstellt, die direkt von Analyse-Tools wie Microsoft Power BI sowie DocuWare Integrationslösungen gelesen und verwendet werden können. Diese ermöglichen es Anwendern, wichtige Erkenntnisse aus ihren Geschäftsprozessen zu extrahieren, zu analysieren und zu visualisieren.

Die Workflow Analytics API ist noch nicht für DocuWare On-premises verfügbar.

Schlüsselfunktionen der Workflow Analytics API

• Unterstützung bei der Prozessoptimierung, Identifizierung von Engpässen und Verwaltung von Arbeitslast und Ressourcen.

• Stellen Sie Entwicklern Daten im JSON-Format bereit, um eine nahtlose Integration und eine einfachere Datenbearbeitung zu ermöglichen.

• Stellen Sie Daten im CSV-Format bereit, um eine sofortige Kompatibilität mit gängigen Analysetools zu gewährleisten.

• Reduzieren Sie den Bedarf an Middleware und profitieren Sie gleichzeitig von den Compliance- und Sicherheitsstandards der DocuWare Cloud.

• Gewährleistung der Datenpersistenz pro Workflow für 90 Tage.

• Automatische Aktualisierung der Daten alle 24 Stunden.

• Effiziente Verarbeitung großer Datensätze für optimale Leistung.

Authentifizierung & Autorisierung

Authentifizierung

Um die Workflow Analytics API nutzen zu können, müssen Sie sich bei DocuWare (Platform) anmelden und mit einem OAuth2 Träger-Token auf die API zugreifen.
Weitere Informationen zur Authentifizierung bei DocuWare

Autorisierung

Um auf Daten aus der Workflow Analytics API zuzugreifen, muss der authentifizierte Benutzer entweder die Rolle „Designer“ oder „Controller“ für den angegebenen Workflow haben, aus dem die Daten angefordert werden.

Aktivierung der Sammlung von Workflow-Analyse-Daten

Um Workflow Analytics nutzen zu können, muss die Datenerfassung zunächst für jeden spezifischen Workflow aktiviert werden. Sie müssen angeben, für welche Workflows Sie die Datenerfassung aktivieren wollen, und die Art der Daten (Datenprognosen) bestimmen, die für jeden Workflow erfasst werden sollen.

API-Dokumentation

• Analytics-Konfiguration: Eine Sammlung von Endpunkten zum Überprüfen, Aktivieren und Deaktivieren von Datenprognosen für bestimmte Workflows.

• Workflow-Analytics: Eine Sammlung von Endpunkten zum Abrufen von Daten aus den Datenprognosen bestimmter Workflows.

Die API-Dokumentation kann unter folgender URL aufgerufen werden:…/DocuWare/Workflow/Analytics/index.html

Datenprognosen

Um die Erfassung relevanter Daten zu erleichtern, werden so genannte Datenprognosen erstellt. Jeder Datenprognosetyp ist über einen spezifischen Endpunkt erreichbar.

Datenprognosen sind definierte Datensätze, die Daten für einen bestimmten Zweck liefern sollen

Datenprognosetypen

Derzeit sind folgende Datentypen verfügbar:

Datenpersistenz

Sobald eine Datenprognose aktiviert ist, beginnt die Datenerfassung sofort. Der Status jeder Datenprognose zeigt einen der folgenden Werte an:

• Läuft: Die Datenerfassung ist im Gange.

• Bereit: Daten wurden gesammelt und können verwendet werden.

Daten werden innerhalb von 24 Stunden nach der Prognose verfügbar sein. Jede Datenprognose bietet Zugriff auf die Daten aller aktiven Workflow-Instanzen sowie auf die Daten von Instanzen, die in den letzten 90 Tagen abgeschlossen wurden. Workflow-Instanzen, die vor mehr als 90 Tagen abgeschlossen wurden, werden nicht verfügbar sein.

Datenformate

Jede Datenprognose unterstützt zwei Arten von Datenformaten, die durch Angabe des Abfrageparameters format= (Standardwert: JSON) angefordert werden können

Indem wir sowohl JSON- als auch CSV-Formate anbieten, stellen wir sicher, dass unsere Datenprognosen den unterschiedlichen Anforderungen von Entwicklern und Endbenutzern gleichermaßen gerecht werden.

JSON

• Zweck: JSON ist so konzipiert, dass es den Anforderungen von Integratoren und Entwicklern gerecht wird.

• Verwendung: Erzeugt einen Standarddatensatz, den Entwickler leicht in ihre Anwendungen und Lösungen integrieren können.

CSV

• Zweck: CSV ist für Benutzer gedacht, die die Daten direkt in Analytics/BI oder Tabellenkalkulationsanwendungen verwenden möchten.

• Verwendung: Ähnlich wie ein CSV-Export einer Ergebnisliste, wir ein Datensatz erzeugt, der allgemein mit solchen Anwendungen kompatibel ist. Zusätzlich bietet es weitere Anpassungsmöglichkeiten, wie zum Beispiel Kodierung und Zeitzonenanpassungen.

Zusätzliche Abfrageparameter für CSV-Format

csvIsUtc=

• Zweck: Abrufen von Daten entweder in UTC und Standardformat oder in der Zeitzone und dem Datumsformat, die in den Organisationseinstellungen angegeben sind.

• Standardwert: false. Wenn auf truegesetzt, werden Daten im UTC und Standardformat angegeben

encodingName=

• Zweck: Angabe der Datenkodierung. Unterstützte Kodierungen: UTF8, UTF16, ANSI, ASCII, Big5, ShiftJIS, Cyrillic

• Standardwert: UTF8

Verwendung der API

{
  "FileCabinetId": "3938dcdd-d2c9-467a-b01a-5daf96c0ea0c",
  "WorkflowNamesList": [
    "Verbindlichkeiten"
  ],
  "ProjectionTypesList": [
    "WorkflowRuntime","GeneralTaskExecutionTimes"
  ]
}

{
  "HasChanges": true,
  "OperationSummaries": [
    {
      "WorkflowName": "Verbindlichkeiten",
      "WorkflowId": "bf8d21f9-4b0d-481e-95a2-e7f014adf3b7",
      "ProjectionType": "WorkflowRuntime",
      "Message": "Success"
    }
  ]
}

[
  {
    "WorkflowId": "bf8d21f9-4b0d-481e-95a2-e7f014adf3b7",
    "WorkflowName": "Verbindlichkeiten",
    "ProjectionType": "WorkflowRuntime",
    "LastEventTimestamp": "/Date(1726493274127+0000)/",
    "ProjectionProcessingState": "Bereit"
  }
]

[
  {
    "workflowVersion": 1,
    "docId": 18,
    "runtime": "00:00:34.6158214",
    "state": "Abgeschlossen",
    "startTime": "/Date(1726493198284)/",
    "timeOfCompletion": "/Date(1726493232900)/"
  }
]

Zusätzliche Workflow-bezogene API-Endpunkte

Die folgenden Endpunkte sind Teil der DocuWare Platform API, nicht der Workflow Analytics API. Während sich die Workflow Analytics API auf historische Daten konzentriert, liefern diese Endpunkte Echtzeitdaten. Sie bieten essenzielle Workflow-bezogene Informationen, die die Einblicke der Workflow Analytics API unterstützen und ergänzen.

• GET /DocuWare/Platform/Workflow/DesignerWorkflows

  • Gibt eine Liste aller veröffentlichten Workflows zurück, in denen der aktuelle Benutzer über Designer-Berechtigungen verfügt.

• GET /DocuWare/Platform/Workflow/Workflows

  • Gibt eine Liste aller Workflows zurück, in denen der aktuelle Benutzer offene Aufgaben zugewiesen hat.

• GET /DocuWare/Platform/Workflow/Workflows/{workflowId}/Tasks

  • Ruft alle Aufgaben ab, die derzeit im angegebenen Workflow zugewiesen sind, identifiziert durch workflowId aus der Perspektive des aktuellen Benutzers.

• GET DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Tasks

  • Gibt eine Liste aller Workflows zurück, in denen der aktuelle Benutzer Aufgaben zugewiesen hat, aus der Perspektive eines Workflow-Controllers.

• GET DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Tasks

  • Ruft alle Aufgaben ab, die Benutzern im angegebenen Workflow derzeit zugewiesen sind, identifiziert durch workflowId aus der Perspektive eines Workflow-Controllers, einschließlich der Instanz-ID, des Empfangsdatums und des Aufgabennamens.