API de Workflow Analytics

L'API de Workflow Analytics simplifie l'intégration des données de processus de travail en fournissant des données qui peuvent être lues et utilisées directement par les outils d'analyse tels que Microsoft Power BI, ainsi que les solutions d'intégration de DocuWare. Celles-ci permettent aux utilisateurs d'extraire, d'analyser et de visualiser des informations clés sur leurs processus métier.

L'API de Workflow Analytics n'est pas encore disponible pour DocuWare sur site.

Fonctionnalités clés de l'API de Workflow Analytics

• Données analytiques de soutiien pour l'optimisation des processus, l'identification des goulets d'étranglement et la gestion de la charge de travail et des ressources.

• Fournir des données au format JSON pour les développeurs, en permettant une intégration transparente et une manipulation plus facile des données.

• Fournir des données au format CSV pour la compatibilité avec les outils d'analyse courants.

• Réduire le besoin de logiciels intermédiaires tout en profitant de la conformité et des normes de sécurité de DocuWare Cloud.

• Assurer la persistance des données par processus de travail pendant 90 jours.

• Mise à jour automatique des données toutes les 24 heures.

• Gestion efficace des grands ensembles de données pour des performances optimales.

Authentification et autorisation

Authentification

Pour utiliser l'API de Workflow Analytics, vous devez vous connecter à DocuWare (Plateforme) et accéder à l'API avec un jeton porteur OAuth2.
Plus d'informations sur la façon de s'authentifier à DocuWare

Autorisation

Pour accéder aux données de l'API de Workflow Analytics, l'utilisateur authentifié doit avoir le rôle « Designer » ou « Contrôleur » pour le processus de travail spécifié à partir duquel les données sont demandées.

Activation de la collection de données d'analyse du processus de travail

Pour utiliser Workflow Analytics, la collecte de données doit d'abord être activée pour chaque processus de travail spécifique. Vous devez spécifier pour quels processus de travail vous voulez activer la collecte de données et déterminer le type de données (projections de données) qui doivent être collectées pour chaque processus de travail.

Documentation de l'API

• Configuration de l'analyse : une collection de terminaux pour vérifier, activer et désactiver les projections de données pour des processus de travail spécifiques.

• Workflow Analytics : une collection de terminaux pour récupérer des données des projections de données de processus de travail spécifiques.

La documentation API est accessible à l'URL : …/DocuWare/Workflow/Analytics/index.html

Projections de données

Afin de faciliter la collecte de données pertinentes, des projections de données sont fournies. Chaque type de projection de données est accessible via un terminal dédié.

Les projections de données sont des ensembles de données définis destinés à fournir des données à des fins spécifiques

Types de projections de données

Les types de projection de données suivants sont actuellement disponibles :

Persistance des données

Une fois que la projection de données est activée, la collecte de données commence immédiatement. Le statut de chaque projection de données sera l'un des suivants :

• En cours : la collecte de données est en cours.

• Prêtes : les données ont été collectées et peuvent être utilisées.

Les données seront disponibles dans les 24 heures suivant l'activation d'une projection. Chaque projection de données donne accès à des données de toutes les instances de processus de travail actifs, ainsi qu'aux données d'instances complétées au cours des 90 derniers jours. Les instances de processus de travail complétées il y a plus de 90 jours ne seront pas disponibles.

Formats de données

Chaque projection de données prend en charge deux types de formats de données qui peuvent être demandés en fournissant le paramètre de requête format= (valeur par défaut : JSON)

En offrant à la fois des formats JSON et CSV, nous nous assurons que nos projections de données répondent aux divers besoins des développeurs et des utilisateurs finaux.

JSON

• Objectif : JSON est conçu pour répondre aux besoins des intégrateurs et des développeurs.

• Usage : il produit un ensemble de données standard que les développeurs peuvent facilement transformer et intégrer dans leurs applications et solutions.

CSV

• Objectif : CSV est destiné à satisfaire les utilisateurs qui veulent directement utiliser les données définies dans les applications Analytiques/BI ou tableur.

• Usage : Similaire à une exportation CSV d'une liste de résultats, elle produit un jeu de données généralement compatible avec de telles applications. De plus, il offre d'autres options de personnalisation, telles que l'encodage et les ajustements de fuseau horaire.

Paramètres de requête supplémentaires pour le format CSV

csvIsUtc=

• Objectif : obtenir les dates soit au format UTC et par défaut, soit dans le fuseau horaire et le format de date spécifié dans les paramètres de l'organisation.

• Valeur par défaut : false. Si défini sur true, les dates seront fournies au format UTC et par défaut

encodingName=

• Objectif : spécifier l'encodage des données. Encodages pris en charge: UTF8, UTF16, ANSI, ASCII, Big5, ShiftJIS, cyrillique

• Valeur par défaut : UTF8

Comment utiliser l'API

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

{
  "HasChanges": true,
  "OperationSummaries": [
    {
      "WorkflowName": "Comptes payants
      "WorkflowId": "bf8d21f9-4b0d-481e-95a2-e7f014adf3b7",
      "ProjectionType": "WorkflowRuntime",
      "Message": "Réussite"
    }
  ]
}

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

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

Points de terminaison API supplémentaires liés au processus de travail

Les points de terminaison suivants font partie de l'API DocuWare Platform et non de l'API Workflow Analytics. Alors que l'API de Workflow Analytics se concentre sur les données historiques, ces terminaux fournissent des données en temps réel. Ils offrent des informations essentielles liées au processus de travail qui assistent et complètent les connaissances de l'API de Workflow Analytics.

• GET /DocuWare/Platform/Workflow/DesignerWorkflows

  • Retourne une liste de tous les processus de travail publiés où l'utilisateur actuel a les permissions de concepteur.

• GET /DocuWare/Platform/Workflow/Workflows

  • Fournit une liste de tous les processus de travail où l'utilisateur actuel a des tâches ouvertes assignées.

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

  • Récupère toutes les tâches actuellement assignées dans le processus de travail spécifié, identifiées par workflowId dans la perspective de l'utilisateur actuel.

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

  • Retourne une liste de tous les processus de travail où l'utilisateur actuel a des tâches assignées, du point de vue d'un contrôleur de processus de travail.

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

  • Récupère toutes les tâches actuellement assignées aux utilisateurs dans le processus de travail spécifié, identifiées par workflowId dans la perspective d'un contrôleur de processus de travail, incluant l'ID d'instance, la date de réception et le nom de la tâche.