ProcessMiningIntegrationAPI : inclus dans le périmètre

Référence de l’API Yokohama

Release

yokohama

ft:locale

fr-FR

ft:publication_title

Référence de l’API Yokohama

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ProcessMiningIntegrationAPI : inclus dans le périmètre

Rversion finale: Yokohama

Mis à jour 30 janv. 2025

16 minutes de lecture

L’include de script ProcessMiningIntegrationAPI fournit des méthodes pour gérer les projets d’exploration de processus et récupérer les résultats et les répartitions.

Cet include de script nécessite le module d’extension Exploration de processus Core (com.sn_process_optimization). Pour plus d'informations, consultez Process Mining.

L’utilisateur appelant doit avoir le rôle sn_process_optimization_analyst ou sn_process_optimization_power_user.

Les propriétés système suivantes peuvent être utilisées pour gérer les fonctionnalités de l’API.

promin.limit.api.project_creation: Limite le nombre de projets pouvant être créés quotidiennement à l’aide des API.
Par défaut : 25.
promin.limit.api.max_daily_minings: Limite le nombre d’explorations qui peuvent être planifiées quotidiennement à l’aide d’API.
Par défaut : 25.
promin.limit.api.max_daily_minings_per_project: Limite le nombre d’explorations qui peuvent être planifiées quotidiennement par projet à l’aide d’API.
Par défaut : 1.
promin.api.allow_no_role_mining: Permet aux projets d’être explorés par des utilisateurs sans le rôle sn_process_optimization_analyst.
Valeur par défaut : faux.
promin.api.auto_share_project_with_creator: Partage automatiquement le projet avec son créateur.
Valeur par défaut : faux.

ProcessMiningIntegrationAPI : createProject(Table de chaînes, Activités de tableau, Répartitions de tableau, Chaîne encodedQuery, Chaîne templateType, Autorisations d’objet, Booléen mise hors service automatique)

Crée un projet d’exploration de processus.

Un projet sert de plan pour les opérations d’exploration de processus. Il sélectionne le processus sur lequel l’exploration est effectuée et les attributs du processus qui sont pris en compte lors de l’exploration.

Tableau 1. Paramètres
Nom	Type	Description
table	Chaîne	Nom de la table contenant les données à analyser.
activités	Tableau	Définitions d’activités pour le projet. Une définition d’activité est un attribut du processus à prendre en compte lors de l’exploration, comme l’état ou le groupe d’affectation. Il doit s’agir d’une colonne de la table spécifiée dans le table paramètre. Au moins une définition d’activité est requise pour explorer un projet. Pour plus d’informations sur les définitions d’activité, reportez-vous à la section Set activity definitions. Remarque : Les définitions d’activité sont également incluses dans le modèle de projet spécifié dans le templateType paramètre. Utilisez le paramètre pour spécifier toutes les activities activités supplémentaires non incluses dans le modèle. `["<column_name>"]`
Répartitions	Tableau	Définitions de répartition pour le projet. Une définition de répartition vous permet de filtrer les enregistrements et d’analyser une carte de processus par catégories, telles que la priorité ou la catégorie d’entreprise. Il doit s’agir d’une colonne de la table spécifiée dans le table paramètre. Les définitions de répartition ne sont pas requises pour explorer un projet. Pour plus d’informations sur les définitions de répartition, reportez-vous à la section Set breakdown definitions. Remarque : Les définitions de répartition sont également incluses dans le modèle de projet spécifié dans le templateType paramètre. Utilisez le breakdowns paramètre pour spécifier toutes les répartitions supplémentaires non incluses dans le modèle. `["<column_name>"]`
encodedQuery	Chaîne	Requête codée pour sélectionner les données à analyser. Cela vous permet de limiter les données analysées, par exemple en sélectionnant uniquement des données d’une période spécifiée. Pour inclure toutes les données de la table, vous pouvez transmettre une chaîne vide.
templateType	Chaîne	Type de modèle à utiliser pour le projet. Valeurs valides : Par défaut Gestion de portefeuille digital Gestion des fournisseurs WFO Pour un projet qui ne fait pas partie de WFO, Vendor Management ou Digital Portfolio Management, choisissez Par défaut. Par exemple, pour créer un projet Performance Analytics, sélectionnez Par défaut.
permissions	Objet	Carte de groupes, de rôles et d’utilisateurs avec lesquels partager le projet, où la clé est un sys_id et la valeur spécifie le type (groupe, rôle ou utilisateur). Tous les utilisateurs avec lesquels le projet est partagé peuvent afficher le modèle analysé et afficher les configurations du projet. Seuls les utilisateurs disposant de la sn_process_optimization_analyst ou du sn_process_optimization_power_user peuvent explorer le projet. `{ "<user_sys_id>":"user", "<role_sys_id>":"role", "<group_sys_id>":"group" }`
Mise hors service automatique	Booléen	Facultatif. Marqueur indiquant si le projet doit être automatiquement mis hors service. Valeurs valides : true : le projet est automatiquement mis hors service sept jours après sa création. faux : le projet n’est pas automatiquement mis hors service. Valeur par défaut : false

Tableau 2. Renvoie
Type	Description
Objet	Objet contenant des informations sur le projet. `{ "entity": {Object}, "findingDefinitionKPIMap": {Object}, "id": "String", "lastMined": String", "miningState": "String", "name": "String", "permissions": [Array], "retiredDate": "String" }`
<Object>.entité	Objet contenant des informations sur les données analysées dans le projet. Type de données : objet `{ "activityDefinitions": [Array], "breakdownDefinitions": [Array], "condition": "String," "table": "String" }`
<Object>.entity.activityDefinitions	Définitions d’activités pour le projet. Type de données : tableau `[ { "activityOfInterest":Boolean, "field":"String", "type":"String" } ]`
<Object>.entité.activitésdéfinitions.activitéd’intérêt	Marqueur indiquant si des changements de champ apparaissent dans la console d’analyste. Valeurs valides : vrai : les changements de champ apparaissent dans la console d’analyste. faux : les changements de champ n’apparaissent pas dans la console d’analyste, mais peuvent toujours être utilisés dans des conditions contextuelles dans les transitions ou les résultats.
<Object>.entité.activitydefinitions.champ	Champ contenant les données à analyser. Le champ doit provenir de la table spécifiée dans le table paramètre.
<Object>.entité.définitionsd’activité.type	Type de valeurs à explorer. Valeurs valides : Valeurs de champ (par défaut) : il s’agit de la sélection par défaut. Cette option est disponible chaque fois que vous créez une définition d’activité. Date/heure : utilise la valeur date/heure de l’enregistrement réel plutôt que l’historique de l’audit et s’affiche sous la forme d’un nœud groupé sur la carte de processus. Composé : un nœud ou graphique de processus représentant le changement de la valeur du champ multiple de l’enregistrement réel plutôt que l’historique de l’audit. Enfant joint : cette option est disponible lorsque vous avez sélectionné deux tables pour la configuration des tables et que vous avez défini une relation enfant-parent. Cette option n’est disponible que pour la configuration de table parente. Dans la visualisation, vous verrez quand l’enfant a été joint dans le processus. Parent joint : cette option crée un nœud sur le processus enfant représentant quand un enregistrement parent a été joint à un enfant.
<Object>.entity.breakdownDefinitions	Définitions de répartition pour le projet. Type de données : tableau `[ { "field":"String", "fieldLabel":"String" } ]`
<Object>.entité.définitions_breakdown.champ	Nom du champ utilisé dans la répartition. Type de données : chaîne
<Object>.entity.breakdownDefinitions.fieldLabel	Étiquette du champ utilisé dans la répartition. Type de données : chaîne
<Object>.entité.condition	Requête codée pour sélectionner les données à analyser. Type de données : chaîne
<Object>.table.entité	Nom de la table contenant les données à analyser. Type de données : chaîne
<Object>.findingDefinitionKPIMap	Carte des définitions de résultats et des indicateurs clés de performance (KPI), où la clé est une définition de résultat sys_id et la valeur est un tableau de sys_ids des KPI impactés par la définition du résultat. Les définitions des résultats se trouvent dans les tables de définition des résultats [promin_finding_def] et de définition des résultats automatisés [promin_automated_finding]. Les KPI figurent dans la table Indicateur [pa_indicators]. Pour en savoir plus sur les définitions des résultats et les KPI, consultez Working with finding definitions et Viewing business insights. Type de données : objet `{ "<finding_def_sys_id":[ "<kpi_sys_id>" ] }`
<Object>.id	Sys_id du projet. Table : Définition du projet [promin_project] Type de données : chaîne
<Object>.lastMined	Date de la dernière exploration du projet. Type de données : chaîne
<Object>.miningState	État d’exploration du projet. Pour obtenir une description des états d’exploration, reportez-vous à la section Mine states. Type de données : chaîne
<Object>.nom	Le nom du projet. Type de données : chaîne
<Object>.Autorisations	Autorisations de groupe, de rôle et d’utilisateur pour le projet. Type de données : objet `[ { "type":"String", "value":"String" } ]`
<Object>.permissions.type	Type d’autorisation. Valeurs valides : groupe rôle utilisateur Type de données : chaîne
<Object>.permissions.valeur	Sys_id du groupe, du rôle ou de l’utilisateur auquel accorder l’autorisation. Type de données : chaîne
<Object>.retiredDate	Date à laquelle le projet sera mis hors service. Type de données : chaîne

Cet exemple crée un projet à l’aide des données des incidents créés le mois dernier.

SNC.ProcessMiningIntegrationAPI
.createProject(
"incident", // table name
["state"], // activity definitions
["priority"], // breakdown definitions
"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()", // incident created on last month
"DEFAULT", // template type
{"02acf036b3120010ed7fc9c316a8dc0c":"user"}, // map of permissions "sys_id":"type"
true // auto retire project
);

Sortie :

{
   "entity":{
      "table":"incident",
      "condition":"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"62826bf03710200044e0bfc8bcbe5df1",
         "type":"user"
      },
      {
         "value":"02acf036b3120010ed7fc9c316a8dc0c",
         "type":"user"
      }
   ],
   "id":"a4286c4f4f831210c98b8a4a91ce0bf5",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{
      "f23c20c34fc31210c98b8a4a91ce0bac":[
         "002d65c3d7131100b96d45a3ce6103e2"
      ]
   },
   "retiredDate":null,
   "lastMined":null
}

ProcessMiningIntegrationAPI : deleteProject(String projectId)

Supprime un projet d’exploration de processus.

Tableau 3. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 4. Renvoie
Type	Description
Néant

Cet exemple supprime un projet d’exploration de processus.

SNC.ProcessMiningIntegrationAPI.deleteProject("a4286c4f4f831210c98b8a4a91ce0bf5");

ProcessMiningIntegrationAPI : getBreakDownStats(String projectId)

Obtient les statistiques de répartition pour un projet d’exploration de processus.

Les répartitions vous permettent de filtrer les enregistrements et d’analyser un processus par catégories, telles que la priorité ou la catégorie d’entreprise.

Tableau 5. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 6. Renvoie
Type	Description
Tableau	Tableau d’objets de répartition. Chaque objet contient des statistiques de répartition. `[ { "caseCount": Number, "field": "String", "fieldValue": "String", "performanceStats": {Object}, "tableName": "String", "variantCount": Number } ]`
<Array>.caseCount	Nombre de tickets de la table Enregistrement de ticket [promin_case_record] qui font partie de cette répartition. Type de données : nombre
<Tableau>.champ	Champ utilisé pour la répartition. Type de données : chaîne
<Array>.fieldValue	Valeur de champ utilisée pour la répartition. Type de données : chaîne
<Array>.performanceStats	Statistiques de performances pour la répartition. `{ "max": Number, "mean": Number, "median": Number, "min": Number, "n": Number, "q1": Number, "q3": Number, "q4": Number, "stdDeviation": Number, "sum": Number, "total": Number, "trimmedAverage": Number, "trimmedPercentage": Number }` Type de données : objet
<Tableau>.performanceStats.max	Temps le plus long qu’un enregistrement a pris pour terminer un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.mean	Temps moyen nécessaire aux enregistrements pour terminer un itinéraire, à partir du moment où les enregistrements ont été ouverts et fermés. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.median	Valeur moyenne de durée, ou moyenne de deux valeurs intermédiaires. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.min	Temps le plus court nécessaire à un enregistrement pour terminer un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.n	Nombre d’enregistrements faisant partie de cette répartition. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q1	Valeur du premier quartile de durée. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q3	Valeur du troisième quartile de durée. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q4	Valeur du quatrième quartile de durée (maximum). Type de données : nombre Unité : millisecondes
<Array>.performanceStats.stdDeviation	Écart par rapport à la valeur moyenne de durée de l’itinéraire. Type de données : nombre Unité : millisecondes
<Tableau>.performanceStats.sum	Somme totale de toutes les durées, du premier au dernier événement, pour tous les enregistrements qui suivent un itinéraire. Type de données : nombre Unité : millisecondes
<Tableau>.performanceStats.total	Somme totale de toutes les durées, du premier au dernier événement, pour tous les enregistrements qui suivent un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.trimmedAverage	Temps moyen nécessaire aux enregistrements pour terminer un itinéraire, calculé après suppression d’un pourcentage des valeurs les plus petites et les plus grandes. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.trimmedPercentage	Pourcentage utilisé pour calculer la trimmedAverage valeur. Type de données : nombre
<Array>.tableName	Table utilisée pour la répartition. Type de données : chaîne
<Array>.variantCount	Nombre de variantes (une séquence unique d’activités effectuées dans un processus) correspondant à cette répartition. Type de données : nombre

Cet exemple obtient les statistiques de répartition pour un projet.

SNC.ProcessMiningIntegrationAPI.getBreakDownStats("a4286c4f4f831210c98b8a4a91ce0bf5");

Sortie :

[
   {
      "fieldValue":"1",
      "field":"priority",
      "tableName":"incident",
      "variantCount":21,
      "caseCount":33,
      "performanceStats":{
         "sum":6.4945381E7,
         "min":0.0,
         "max":5.2334704E7,
         "n":33,
         "median":0.0,
         "mean":0.0,
         "total":64945381,
         "stdDeviation":9144841.0,
         "trimmedAverage":165594.0,
         "trimmedPercentage":-1.0,
         "q1":0.0,
         "q3":313333.0,
         "q4":5.2334704E7
      }
   }
]

ProcessMiningIntegrationAPI : getFindings(String projectId)

Obtient les résultats pour un projet d’exploration de processus.

Tableau 7. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 8. Renvoie
Type	Description
Tableau	Tableau d’objets de résultats. `[ { "caseIds":[], "category": "String", "categoryDescription": "String", "categoryLabel": "String", "createdOn": Number, "findingDefId": "String", "id": "String", "impactedKpis": [], "matchingRecords": Number, "message": "String", "performanceStats": {}, "shortMessage": "String", "tableName": "String", "totalRecords": Number, "type": "String", "typeLabel": "String", "versionId": "String" } ]`
<Array>.caseIds	Liste des ID de tickets qui correspondent au modèle de résultat. Situé dans la colonne ID de ticket de la table Enregistrement de ticket [promin_case_record]. Type de données : tableau
<Tableau>.catégorie	Catégorie du résultat. Valeurs possibles : AUTOMATISATION CONFORMITÉ CONFORMITÉ COÛT PERFORMANCE QUALITÉ VITESSE Type de données : chaîne
<Array>.categoryDescription	Description de la catégorie de résultat. Type de données : chaîne
<Tableau>.catégorieÉtiquette	Étiquette de la catégorie de résultat. Type de données : chaîne
<Array>.createdOn	Date de création du résultat. Type de données : nombre
<Array>.findingDefId	Sys_id de la définition du résultat. Les définitions des résultats se trouvent dans les tables de définition des résultats [promin_finding_def] et de définition des résultats automatisés [promin_automated_finding]. Type de données : chaîne
<Tableau>.id	Sys_id du résultat. Situé dans la table Recherche [promin_finding]. Type de données : chaîne
<Array>.impactedKpis	Liste des sys_ids de KPI impactés par le résultat. Situé dans la table Indicateur [pa_indicators]. Type de données : tableau
<Array>.matchingRecords	Nombre d’ID de tickets de la table Enregistrement de ticket [promin_case_record] qui correspondent au modèle de résultat. Type de données : nombre
<tableau>.message	Message de la définition du résultat. Type de données : chaîne
<Array>.performanceStats	Statistiques de performances pour le résultat. `{ "max": Number, "mean": Number, "median": Number, "min": Number, "n": Number, "q1": Number, "q3": Number, "q4": Number, "stdDeviation": Number, "sum": Number, "total": Number, "trimmedAverage": Number, "trimmedPercentage": Number }` Type de données : objet
<Tableau>.performanceStats.max	Temps le plus long qu’un enregistrement a pris pour terminer un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.mean	Temps moyen nécessaire aux enregistrements pour terminer un itinéraire, à partir du moment où les enregistrements ont été ouverts et fermés. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.median	Valeur moyenne de durée, ou moyenne de deux valeurs intermédiaires. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.min	Temps le plus court nécessaire à un enregistrement pour terminer un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.n	Nombre d’enregistrements faisant partie de ce résultat. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q1	Valeur du premier quartile de durée. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q3	Valeur du troisième quartile de durée. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.q4	Valeur du quatrième quartile de durée (maximum). Type de données : nombre Unité : millisecondes
<Array>.performanceStats.stdDeviation	Écart par rapport à la valeur moyenne de durée de l’itinéraire. Type de données : nombre Unité : millisecondes
<Tableau>.performanceStats.sum	Somme totale de toutes les durées, du premier au dernier événement, pour tous les enregistrements qui suivent un itinéraire. Type de données : nombre Unité : millisecondes
<Tableau>.performanceStats.total	Somme totale de toutes les durées, du premier au dernier événement, pour tous les enregistrements qui suivent un itinéraire. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.trimmedAverage	Temps moyen nécessaire aux enregistrements pour terminer un itinéraire, calculé après suppression d’un pourcentage des valeurs les plus petites et les plus grandes. Type de données : nombre Unité : millisecondes
<Array>.performanceStats.trimmedPercentage	Pourcentage utilisé pour calculer la trimmedAverage valeur. Type de données : nombre
<Array>.shortMessage	Message court de la définition du résultat. Type de données : chaîne
<Array>.tableName	Nom de la table utilisée dans le résultat. Type de données : chaîne
<Array>.totalRecords	Nombre total d’enregistrements analysés dans l’exploration. Type de données : nombre
<Tableau>.type	Type de définition du résultat. Valeurs possibles : EXTRA_STEP EXTREME_DURATION EXTREME_REPETITION AUTRE MODÈLE PERFORMANCE_OUTLIER PING-PONG RETRAVAILLER Pour plus d'informations, consultez Automated improvement opportunities.
<Array>.typeLabel	Étiquette du type de définition de résultat. Type de données : chaîne
<Array>.versionId	Sys_id de la version du projet. Situé dans la table Version de définition de projet [promin_model_def_version]. Type de données : chaîne

Cet exemple obtient les résultats pour un projet.

SNC.ProcessMiningIntegrationAPI.getFindings("a4286c4f4f831210c98b8a4a91ce0bf5");

Sortie :

[
   {
      "message":"Rework on Closed",
      "id":"0ef09b2e1c6cf0d98045e6ba1c3c9edb",
      "type":"REWORK",
      "createdOn":1727036052.000000000,
      "category":"AUTOMATION",
      "tableName":"incident",
      "categoryLabel":"Automation",
      "matchingRecords":111,
      "versionId":"9a2f187177b412102f7a1b56ba5a99e2",
      "totalRecords":19758,
      "findingDefId":"791f587177b412102f7a1b56ba5a99eb",
      "categoryDescription":"Category that groups all opportunities that are subject to automation.",
      "impactedKpis":[
         
      ],
      "performanceStats":{
         "sum":2.09532828E8,
         "min":1.0,
         "max":6563078.0,
         "n":111,
         "median":1036715.0,
         "mean":1.0,
         "total":209532828,
         "stdDeviation":1855944.0,
         "trimmedAverage":1716904.0,
         "trimmedPercentage":-1.0,
         "q1":776859.0,
         "q3":2246368.0,
         "q4":6563078.0
      },
      "typeLabel":"Automation",
      "shortMessage":"Closed",
      "caseIds":[
         "119e4a569397fd14849bbcd74dba1018",
         "b16b355f47197190498cc044846d43b0",
         "cf9bca7597fe7d90ef889504a253af9e",
      ]
   }
]

ProcessMiningIntegrationAPI : getMiningStatus(String projectId)

Obtient l’état d’exploration d’un projet d’exploration de processus.

Tableau 9. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 10. Renvoie
Type	Description
Objet	Objet contenant l’sys_id du projet et un suivi. `{ "projectId":"String", "trackerId":"String" }`
<Object>.projectId	Sys_id du projet. Table : Définition du projet [promin_project] Type de données : chaîne
<Object>.trackerId	Sys_id du suivi qui surveille la progression de l’exploration pour le projet. Table : Suivi des exécutions [sys_execution_tracker] Type de données : chaîne

Cet exemple permet d’obtenir l’état d’exploration d’un projet.

SNC.ProcessMiningIntegrationAPI.getMiningStatus("c0b91f0cff01121047cae835f2cb14bc");

Sortie :

{
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}

ProcessMiningIntegrationAPI : getProject(String projectId)

Récupère un projet d’exploration de processus.

Tableau 11. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 12. Renvoie
Type	Description
Objet	Objet contenant des informations sur le projet. `{ "entity": {Object}, "findingDefinitionKPIMap": {Object}, "id": "String", "lastMined": String", "miningState": "String", "name": "String", "permissions": [Array], "retiredDate": "String" }`
<Object>.entité	Objet contenant des informations sur les données analysées dans le projet. Type de données : objet `{ "activityDefinitions": [Array], "breakdownDefinitions": [Array], "condition": "String," "table": "String" }`
<Object>.entity.activityDefinitions	Définitions d’activités pour le projet. Type de données : tableau `[ { "activityOfInterest":Boolean, "field":"String", "type":"String" } ]`
<Object>.entité.activitésdéfinitions.activitéd’intérêt	Marqueur indiquant si des changements de champ apparaissent dans la console d’analyste. Valeurs valides : vrai : les changements de champ apparaissent dans la console d’analyste. faux : les changements de champ n’apparaissent pas dans la console d’analyste, mais peuvent toujours être utilisés dans des conditions contextuelles dans les transitions ou les résultats.
<Object>.entité.activitydefinitions.champ	Champ contenant les données à analyser. Le champ doit provenir de la table spécifiée dans le table paramètre.
<Object>.entité.définitionsd’activité.type	Type de valeurs à explorer. Valeurs valides : Valeurs de champ (par défaut) : il s’agit de la sélection par défaut. Cette option est disponible chaque fois que vous créez une définition d’activité. Date/heure : utilise la valeur date/heure de l’enregistrement réel plutôt que l’historique de l’audit et s’affiche sous la forme d’un nœud groupé sur la carte de processus. Composé : un nœud ou graphique de processus représentant le changement de la valeur du champ multiple de l’enregistrement réel plutôt que l’historique de l’audit. Enfant joint : cette option est disponible lorsque vous avez sélectionné deux tables pour la configuration des tables et que vous avez défini une relation enfant-parent. Cette option n’est disponible que pour la configuration de table parente. Dans la visualisation, vous verrez quand l’enfant a été joint dans le processus. Parent joint : cette option crée un nœud sur le processus enfant représentant quand un enregistrement parent a été joint à un enfant.
<Object>.entity.breakdownDefinitions	Définitions de répartition pour le projet. Type de données : tableau `[ { "field":"String", "fieldLabel":"String" } ]`
<Object>.entité.définitions_breakdown.champ	Nom du champ utilisé dans la répartition. Type de données : chaîne
<Object>.entity.breakdownDefinitions.fieldLabel	Étiquette du champ utilisé dans la répartition. Type de données : chaîne
<Object>.entité.condition	Requête codée pour sélectionner les données à analyser. Type de données : chaîne
<Object>.table.entité	Nom de la table contenant les données à analyser. Type de données : chaîne
<Object>.findingDefinitionKPIMap	Carte des définitions de résultats et des indicateurs clés de performance (KPI), où la clé est une définition de résultat sys_id et la valeur est un tableau de sys_ids des KPI impactés par la définition du résultat. Les définitions des résultats se trouvent dans les tables de définition des résultats [promin_finding_def] et de définition des résultats automatisés [promin_automated_finding]. Les KPI figurent dans la table Indicateur [pa_indicators]. Pour en savoir plus sur les définitions des résultats et les KPI, consultez Working with finding definitions et Viewing business insights. Type de données : objet `{ "<finding_def_sys_id":[ "<kpi_sys_id>" ] }`
<Object>.id	Sys_id du projet. Table : Définition du projet [promin_project] Type de données : chaîne
<Object>.lastMined	Date de la dernière exploration du projet. Type de données : chaîne
<Object>.miningState	État d’exploration du projet. Pour obtenir une description des états d’exploration, reportez-vous à la section Mine states. Type de données : chaîne
<Object>.nom	Le nom du projet. Type de données : chaîne
<Object>.Autorisations	Autorisations de groupe, de rôle et d’utilisateur pour le projet. Type de données : objet `[ { "type":"String", "value":"String" } ]`
<Object>.permissions.type	Type d’autorisation. Valeurs valides : groupe rôle utilisateur Type de données : chaîne
<Object>.permissions.valeur	Sys_id du groupe, du rôle ou de l’utilisateur auquel accorder l’autorisation. Type de données : chaîne
<Object>.retiredDate	Date à laquelle le projet sera mis hors service. Type de données : chaîne

Cet exemple récupère un projet d’exploration de processus.

SNC.ProcessMiningIntegrationAPI.getProject("fa465748ff01121047cae835f2cb1473");

Sortie :

{
   "entity":{
      "table":"incident",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "condition":"",
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"close_code",
            "fieldLabel":"Resolution code"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"some_group_sys_id",
         "type":"group"
      },
      {
         "value":"some_role_sys_id",
         "type":"role"
      },
      {
         "value":"some_user_sys_id",
         "type":"user"
      }
   ],
   "id":"fa465748ff01121047cae835f2cb1473",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{
      
   },
   "retiredDate":1728292672.622894000,
   "lastMined":null
}

ProcessMiningIntegrationAPI : scheduleMining(String projectId)

Soumettez un projet d’exploration de processus pour l’exploration de données.

Tableau 13. Paramètres
Nom	Type	Description
projectId	Chaîne	Sys_id du projet. Table : Définition du projet [promin_project]

Tableau 14. Renvoie
Type	Description
Objet	Objet contenant l’sys_id du projet et un suivi. `{ "projectId":"String", "trackerId":"String" }`
<Object>.projectId	Sys_id du projet. Table : Définition du projet [promin_project] Type de données : chaîne
<Object>.trackerId	Sys_id du suivi qui surveille la progression de l’exploration pour le projet. Table : Suivi des exécutions [sys_execution_tracker] Type de données : chaîne

Cet exemple soumet un projet pour l’exploration.

SNC.ProcessMiningIntegrationAPI.scheduleMining("c0b91f0cff01121047cae835f2cb14bc");

Sortie :

{
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}