ProcessMiningIntegrationAPI : Bereichsbezogen

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 14 Minuten Lesedauer
  • Die ProcessMiningIntegrationAPI- Skripteinbindung bietet Methoden zum Verwalten von Process Mining-Projekten und zum Abrufen von Ergebnissen und Aufgliederungen.

    Diese Skripteinbindung erfordert das Plugin „Process Mining Core“ (com.sn_process_optimization). Weitere Informationen finden Sie unter Process Mining.

    Der anrufende Benutzer muss über die Rolle sn_process_optimization_analyst oder sn_process_optimization_power_user verfügen.

    Die folgenden Systemeigenschaften können zum Verwalten der API-Funktionalität verwendet werden.
    promin.limit.api.project_creation
    Begrenzt die Anzahl der Projekte, die täglich mithilfe von APIs erstellt werden können.

    Standard: 25.

    promin.limit.api.max_daily_minings
    Begrenzt die Anzahl der Minings, die täglich mithilfe von APIs geplant werden können.

    Standard: 25.

    promin.limit.api.max_daily_minings_per_project
    Begrenzt die Anzahl von Minings, die täglich pro Projekt mithilfe von APIs geplant werden können.

    Standard: 1.

    promin.api.allow_no_role_mining
    Ermöglicht Benutzern das Mining von Projekten ohne die Rolle „sn_process_optimization_analyst“.

    Standard: False.

    promin.api.auto_share_project_with_creator
    Gibt das Projekt automatisch für den Ersteller des Projekts frei.

    Standard: False.

    ProcessMiningIntegrationAPI – createProject(Zeichenfolgentabelle, Array-Aktivitäten, Array-Aufgliederungen, Zeichenfolgen-encodedQuery, Zeichenfolgen-templateType, Objektberechtigungen, boolesches AutoRetire)

    Erstellt ein Process Mining-Projekt.

    Ein Projekt fungiert als Blueprint für Process Mining-Vorgänge. Sie wählt den Prozess aus, für den das Mining erfolgt und welche Attribute des Prozesses beim Mining berücksichtigt werden.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    table Zeichenfolge Name der Tabelle, die die zu analysierenden Daten enthält.
    Aktivitäten Array Aktivitätsdefinitionen für das Projekt.

    Eine Aktivitätsdefinition ist ein Attribut des Prozesses, das beim Mining berücksichtigt werden soll, z. B. der Status oder die Zuweisungsgruppe. Es muss sich um eine Spalte aus der Tabelle handeln, die im Parameter table angegeben ist. Für das Mining eines Projekts ist mindestens eine Aktivitätsdefinition erforderlich. Weitere Informationen zu Aktivitätsdefinitionen finden Sie unter Set activity definitions.

    Hinweis:
    Aktivitätsdefinitionen sind auch in der im Parameter templateType angegebenen Projektvorlage enthalten. Verwenden Sie den Parameter activities, um zusätzliche Aktivitäten anzugeben, die nicht in der Vorlage enthalten sind.
    ["<column_name>"]
    Aufgliederungen Array Aufgliederungsdefinitionen für das Projekt.

    Mit einer Aufgliederungsdefinition können Sie Datensätze filtern und eine Prozesszuordnung nach Kategorien wie Priorität oder Geschäftskategorie analysieren. Es muss sich um eine Spalte aus der Tabelle handeln, die im Parameter table angegeben ist. Aufgliederungsdefinitionen sind für das Mining eines Projekts nicht erforderlich. Weitere Informationen zu Aufgliederungsdefinitionen finden Sie unter Set breakdown definitions.

    Hinweis:
    Aufgliederungsdefinitionen sind auch in der im Parameter templateType angegebenen Projektvorlage enthalten. Verwenden Sie den Parameter breakdowns, um zusätzliche Aufgliederungen anzugeben, die nicht in der Vorlage enthalten sind.
    ["<column_name>"]
    encodedQuery Zeichenfolge Codierte Abfrage zum Auswählen der zu analysierenden Daten. Auf diese Weise können Sie die zu analysierenden Daten begrenzen, z. B. indem Sie nur Daten aus einem bestimmten Zeitraum auswählen.

    Um alle Daten in die Tabelle aufzunehmen, können Sie eine leere Zeichenfolge übergeben.

    templateType Zeichenfolge Typ der Vorlage, die für das Projekt verwendet werden soll.
    Gültige Werte:
    • Standard
    • Digital-Portfoliomanagement
    • Lieferantenmanagement
    • WFO

    Wählen Sie für ein Projekt, das nicht Teil von WFO, Vendor Management oder Digital-Portfoliomanagement ist, Standard aus. Um beispielsweise ein Performance Analytics-Projekt zu erstellen, wählen Sie Standard aus.

    permissions Objekt Zuordnung von Gruppen, Rollen und Anwendern, für die das Projekt freigegeben werden soll, wobei der Schlüssel eine sys_id ist und der Wert den Typ (Gruppe, Rolle oder Anwender) angibt.

    Alle Benutzer, für die das Projekt freigegeben ist, können das analysierte Modell und Projektkonfigurationen anzeigen. Nur Benutzer mit der Rolle sn_process_optimization_analyst oder sn_process_optimization_power_user können das Mining für das Projekt durchführen.

    {
       "<user_sys_id>":"user",
       "<role_sys_id>":"role",
       "<group_sys_id>":"group"
    }
    autoRetire Boolean

    Optional. Kennzeichnung, die angibt, ob das Projekt automatisch stillgelegt werden soll.

    Gültige Werte:
    • wahr: Das Projekt wird sieben Tage nach der Erstellung automatisch stillgelegt.
    • „falsch“: Das Projekt wird nicht automatisch stillgelegt.

    Standardwert: False

    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Objekt Objekt mit Informationen zum Projekt.
    {
       "entity": {Object},
       "findingDefinitionKPIMap": {Object},
       "id": "String",
       "lastMined": String",
       "miningState": "String",
       "name": "String",
       "permissions": [Array],
       "retiredDate": "String"
    }
    <Object>.entity Objekt, das Informationen zu den im Projekt analysierten Daten enthält.

    Datentyp: Objekt

    {
       "activityDefinitions": [Array],
       "breakdownDefinitions": [Array],
       "condition": "String,"
       "table": "String"
    }
    <Object>.entity.activityDefinitions Aktivitätsdefinitionen für das Projekt.

    Datentyp: Array

    [
       {
          "activityOfInterest":Boolean,
          "field":"String",
          "type":"String"      
       }
    ]
    <Object>.entity.activityDefinitions.activityOfinterest

    Kennzeichnung, die angibt, ob Feldänderungen in der Workbench für Analysten angezeigt werden.

    Gültige Werte:
    • „wahr“: Feldänderungen werden in der Workbench für Analysten angezeigt.
    • false: Feldänderungen werden in der Workbench für Analysten nicht angezeigt, können jedoch in kontextbezogenen Bedingungen in Übergängen oder Ergebnissen verwendet werden.
    <Object>.entity.activityDefinitions.field Feld mit den zu analysierenden Daten. Das Feld muss aus der im Parameter table angegebenen Tabelle stammen.
    <Object>.entität.aktivitätsdefinitionen.typ Der Typ der zu migrierenden Werte.
    Gültige Werte:
    • Feldwerte (Standard): Dies ist die Standardauswahl. Diese Option ist verfügbar, wenn Sie eine Aktivitätsdefinition erstellen.
    • Datum/Uhrzeit: Verwendet den Datums-/Uhrzeitwert aus dem tatsächlichen Datensatz anstelle des Auditverlaufs und wird als gruppierter Knoten in der Prozesszuordnung angezeigt.
    • Verbindung: Ein Knoten- oder Prozessdiagramm, das die Änderung im Mehrfachfeldwert aus dem tatsächlichen Datensatz und nicht aus dem Auditverlauf darstellt.
    • Untergeordnetes Element angehängt: Diese Option ist verfügbar, wenn Sie zwei Tabellen für die Tabellenkonfiguration ausgewählt und eine Beziehung zwischen untergeordneten Elementen und übergeordneten Elementen festgelegt haben. Diese Option ist nur für die Konfiguration der übergeordneten Tabelle verfügbar. In der Visualisierung sehen Sie, wann das untergeordnete Element im Prozess angehängt wurde.
    • Übergeordnetes Element angehängt: Diese Option erstellt einen Knoten im untergeordneten Prozess, der darstellt, wann ein übergeordneter Datensatz an ein untergeordnetes Element angehängt wurde.
    <Object>.entity.breakdownDefinitionen Aufgliederungsdefinitionen für das Projekt.

    Datentyp: Array

    [
     {
       "field":"String",
       "fieldLabel":"String"
     }
    ]
    <Object>.entity.breakdownDefinitions.field Name des in der Aufgliederung verwendeten Felds.

    Datentyp: Zeichenfolge

    <Object>.entity.breakdownDefinitions.fieldLabel Bezeichnung des in der Aufgliederung verwendeten Felds.

    Datentyp: Zeichenfolge

    <Object>.Entität.Bedingung Codierte Abfrage zum Auswählen der zu analysierenden Daten.

    Datentyp: Zeichenfolge

    <Object>.entity.table Name der Tabelle, die die zu analysierenden Daten enthält.

    Datentyp: Zeichenfolge

    <Object>.Ergebnisdefinition KPI-Zuordnung Zuordnung von Ergebnisdefinitionen und Leistungskennzahlen (Key Performance Indicators, KPIs), wobei der Schlüssel eine sys_id der Ergebnisdefinition ist und der Wert ein Array von sys_ids der KPIs ist, die von der Ergebnisdefinition betroffen sind.

    Ergebnisdefinitionen befinden sich in den Tabellen „Ergebnisdefinition“ [promin_finding_def] und „Automatisierte Ergebnisdefinition“ [promin_automated_finding]. KPIs befinden sich in der Tabelle „Indikator“ [pa_indicators].

    Weitere Informationen zu Ergebnisdefinitionen und KPIs finden Sie unter Working with finding definitions und Viewing business insights.

    Datentyp: Objekt

    {
       "<finding_def_sys_id":[
          "<kpi_sys_id>"
       ]
    }
    <Object>.id Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Datentyp: Zeichenfolge

    <Object>.lastMined Datum, an dem für das Projekt das letzte Mining durchgeführt wurde.

    Datentyp: Zeichenfolge

    <Object>.miningStatus Mining-Status für das Projekt.

    Beschreibungen der Mining-Status finden Sie unter Mine states.

    Datentyp: Zeichenfolge

    <Object>.name Name des Projekts.

    Datentyp: Zeichenfolge

    <Object>.Berechtigungen Gruppen-, Rollen- und Benutzerberechtigungen für das Projekt.

    Datentyp: Objekt

    [
       {
          "type":"String",
          "value":"String"      
       }
    ]
    <Object>.Berechtigungen.Typ Typ der Berechtigung.
    Gültige Werte:
    • Gruppe
    • role
    • user

    Datentyp: Zeichenfolge

    <Object>.Berechtigungen.Wert Sys_id der Gruppe, Rolle oder des Anwenders zum Erteilen der Berechtigung.

    Datentyp: Zeichenfolge

    <Object>.retiredDate Datum, an dem das Projekt stillgelegt wird.

    Datentyp: Zeichenfolge

    In diesem Beispiel wird ein Projekt mit Daten aus Incidents erstellt, die im letzten Monat erstellt wurden.

    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
    );

    Ausgabe:

    {
       "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)

    Löscht ein Process Mining-Projekt.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 4. Ausgabe
    Typ Beschreibung
    Keine

    In diesem Beispiel wird ein Process Mining-Projekt gelöscht.

    SNC.ProcessMiningIntegrationAPI.deleteProject("a4286c4f4f831210c98b8a4a91ce0bf5");

    ProcessMiningIntegrationAPI – getBreakDownStats(String projectId)

    Ruft Aufgliederungsstatistiken für ein Process Mining-Projekt ab.

    Mit Aufgliederungen können Sie Datensätze filtern und einen Prozess nach Kategorien analysieren, z. B. nach Priorität oder Geschäftskategorie.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 6. Ausgabe
    Typ Beschreibung
    Array Array von Aufgliederungsobjekten. Jedes Objekt enthält Statistiken für die Aufgliederung.
    [
       {
          "caseCount": Number,
          "field": "String",
          "fieldValue": "String",
          "performanceStats": {Object},
          "tableName": "String",
          "variantCount": Number     
       }
    ]
    <Array>.caseCount Anzahl der Fälle aus der Tabelle „Falldatensatz“ [promin_case_record], die Teil dieser Aufgliederung sind.

    Datentyp: Zahl

    <Array>.Feld Für die Aufgliederung verwendetes Feld.

    Datentyp: Zeichenfolge

    <Array>.fieldValue Für die Aufgliederung verwendeter Feldwert.

    Datentyp: Zeichenfolge

    <Array>.leistungsstatistiken Leistungsstatistiken für die Aufgliederung.
    {
       "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
    }

    Datentyp: Objekt

    <Array>.leistungsstatistiken.max Längste Zeit, die ein Datensatz zum Abschließen einer Route benötigt hat.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.Mittelwert Durchschnittliche Zeit, die Datensätze zum Abschließen einer Route benötigt haben, vom Zeitpunkt des Öffnens bis zum Schließen der Datensätze.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.median Mittelwert für die Dauer oder Durchschnitt von zwei Mittelwerten.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.Min Kürzeste Zeit, die ein Datensatz zum Abschließen einer Route benötigt hat.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.n Anzahl der Datensätze, die Teil dieser Aufgliederung sind.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q1 Wert des ersten Quartals der Dauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q3 Wert des dritten Quartals der Dauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q4 Wert des vierten Quartals der Dauer (Maximum).

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.stdAbweichung Abweichung vom Durchschnittswert der Routendauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.summe Gesamtsumme der Dauern vom ersten bis zum letzten Ereignis für alle Datensätze, die einer Route folgen.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.gesamt Gesamtsumme der Dauern vom ersten bis zum letzten Ereignis für alle Datensätze, die einer Route folgen.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.getrimmterDurchschnitt Durchschnittliche Zeit, die Datensätze zum Abschließen einer Route benötigten, berechnet nach Entfernen eines Prozentsatzes der kleinsten und größten Werte.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.getrimmterProzentsatz Prozentsatz, der zur Berechnung des Werts trimmedAverage verwendet wird.

    Datentyp: Zahl

    <Array>.tabellenname Für die Aufgliederung verwendete Tabelle.

    Datentyp: Zeichenfolge

    <Array>.varianteAnzahl Anzahl der Varianten (eine eindeutige Abfolge von Aktivitäten, die in einem Prozess ausgeführt werden), die dieser Aufgliederung entsprechen.

    Datentyp: Zahl

    In diesem Beispiel werden Aufgliederungsstatistiken für ein Projekt abgerufen.

    SNC.ProcessMiningIntegrationAPI.getBreakDownStats("a4286c4f4f831210c98b8a4a91ce0bf5");

    Ausgabe:

    [
       {
          "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)

    Ruft Ergebnisse für ein Process Mining-Projekt ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 8. Ausgabe
    Typ Beschreibung
    Array Array von Ergebnisobjekten.
    [
       {
          "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 von IDs von Fällen, die dem Ergebnismuster entsprechen. Befindet sich in der Spalte „Fall-ID“ der Tabelle „Falldatensatz“ [promin_case_record].

    Datentyp: Array

    <Array>.Kategorie Kategorie des Ergebnisses.
    Mögliche Werte:
    • AUTOMATISIERUNG
    • COMPLIANCE
    • KONFORMANCE
    • KOSTEN
    • LEISTUNG
    • QUALITÄT
    • GESCHWINDIGKEIT

    Datentyp: Zeichenfolge

    <Array>.kategoriebeschreibung Beschreibung der Ergebniskategorie.

    Datentyp: Zeichenfolge

    <Array>.categoryLabel Bezeichnung für die Ergebniskategorie.

    Datentyp: Zeichenfolge

    <Array>.createdOn Erstellungsdatum des Ergebnisses.

    Datentyp: Zahl

    <Array>.ErgebnisDefId Sys_id der Ergebnisdefinition.

    Ergebnisdefinitionen befinden sich in den Tabellen „Ergebnisdefinition“ [promin_finding_def] und „Automatisierte Ergebnisdefinition“ [promin_automated_finding].

    Datentyp: Zeichenfolge

    <Array>.id Sys_id des Ergebnisses. Befindet sich in der Ergebnistabelle [promin_finding].

    Datentyp: Zeichenfolge

    <Array>.impactedKpis Liste der sys_ids der KPIs, die vom Ergebnis betroffen sind. Befindet sich in der Tabelle „Indikator“ [pa_indicators].

    Datentyp: Array

    <Array>.matchingRecords Anzahl der Fall-IDs aus der Falldatensatztabelle [promin_case_record], die dem Ergebnismuster entsprechen.

    Datentyp: Zahl

    <Array>.message Nachricht aus der Ergebnisdefinition.

    Datentyp: Zeichenfolge

    <Array>.leistungsstatistiken Leistungsstatistiken für das Ergebnis.
    {
       "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
    }

    Datentyp: Objekt

    <Array>.leistungsstatistiken.max Längste Zeit, die ein Datensatz zum Abschließen einer Route benötigt hat.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.Mittelwert Durchschnittliche Zeit, die Datensätze zum Abschließen einer Route benötigt haben, vom Zeitpunkt des Öffnens bis zum Schließen der Datensätze.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.median Mittelwert für die Dauer oder Durchschnitt von zwei Mittelwerten.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.Min Kürzeste Zeit, die ein Datensatz zum Abschließen einer Route benötigt hat.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.Leistungsstatistiken.n Anzahl der Datensätze, die Teil dieses Ergebnisses sind.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q1 Wert des ersten Quartals der Dauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q3 Wert des dritten Quartals der Dauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.q4 Wert des vierten Quartals der Dauer (Maximum).

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.stdAbweichung Abweichung vom Durchschnittswert der Routendauer.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.summe Gesamtsumme der Dauern vom ersten bis zum letzten Ereignis für alle Datensätze, die einer Route folgen.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.gesamt Gesamtsumme der Dauern vom ersten bis zum letzten Ereignis für alle Datensätze, die einer Route folgen.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.getrimmterDurchschnitt Durchschnittliche Zeit, die Datensätze zum Abschließen einer Route benötigten, berechnet nach Entfernen eines Prozentsatzes der kleinsten und größten Werte.

    Datentyp: Zahl

    Einheit: Millisekunden

    <Array>.leistungsstatistiken.getrimmterProzentsatz Prozentsatz, der zur Berechnung des Werts trimmedAverage verwendet wird.

    Datentyp: Zahl

    <Array>.shortMessage Kurznachricht der Ergebnisdefinition.

    Datentyp: Zeichenfolge

    <Array>.tabellenname Name der im Ergebnis verwendeten Tabelle.

    Datentyp: Zeichenfolge

    <Array>.totalDatensätze Gesamtzahl der im Mining analysierten Datensätze.

    Datentyp: Zahl

    <Array>.type Typ der Ergebnisdefinition.
    Mögliche Werte:
    • EXTRA_SCHRITT
    • EXTREME_DURATION
    • EXTREME_REPETITION
    • OTHER
    • MUSTER
    • LEISTUNG_AUSSERGEHEND
    • PINGPong
    • ÜBERARBEITEN

    Weitere Informationen finden Sie unter Automated improvement opportunities.

    <Array>.typeLabel Bezeichnung für den Ergebnisdefinitionstyp.

    Datentyp: Zeichenfolge

    <Array>.versionsID Sys_id der Projektversion. Befindet sich in der Tabelle „Projektdefinitionsversion“ [promin_model_def_version].

    Datentyp: Zeichenfolge

    In diesem Beispiel werden Ergebnisse für ein Projekt abgerufen.

    SNC.ProcessMiningIntegrationAPI.getFindings("a4286c4f4f831210c98b8a4a91ce0bf5");

    Ausgabe:

    [
       {
          "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)

    Ruft den Mining-Status eines Process Mining-Projekts ab.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 10. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des Projekts und einem Tracker.
    {
       "projectId":"String",
       "trackerId":"String"  
    }
    <Object>.ProjektId Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Datentyp: Zeichenfolge

    <Object>.trackerID Sys_id des Trackers, der den Mining-Fortschritt für das Projekt überwacht.

    Tabelle: Ausführungstracker [sys_execution_tracker]

    Datentyp: Zeichenfolge

    In diesem Beispiel wird der Mining-Status für ein Projekt abgerufen.

    SNC.ProcessMiningIntegrationAPI.getMiningStatus("c0b91f0cff01121047cae835f2cb14bc");

    Ausgabe:

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

    ProcessMiningIntegrationAPI – getProject(String projectId)

    Ruft ein Process Mining-Projekt ab.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Objekt Objekt mit Informationen zum Projekt.
    {
       "entity": {Object},
       "findingDefinitionKPIMap": {Object},
       "id": "String",
       "lastMined": String",
       "miningState": "String",
       "name": "String",
       "permissions": [Array],
       "retiredDate": "String"
    }
    <Object>.entity Objekt, das Informationen zu den im Projekt analysierten Daten enthält.

    Datentyp: Objekt

    {
       "activityDefinitions": [Array],
       "breakdownDefinitions": [Array],
       "condition": "String,"
       "table": "String"
    }
    <Object>.entity.activityDefinitions Aktivitätsdefinitionen für das Projekt.

    Datentyp: Array

    [
       {
          "activityOfInterest":Boolean,
          "field":"String",
          "type":"String"      
       }
    ]
    <Object>.entity.activityDefinitions.activityOfinterest

    Kennzeichnung, die angibt, ob Feldänderungen in der Workbench für Analysten angezeigt werden.

    Gültige Werte:
    • „wahr“: Feldänderungen werden in der Workbench für Analysten angezeigt.
    • false: Feldänderungen werden in der Workbench für Analysten nicht angezeigt, können jedoch in kontextbezogenen Bedingungen in Übergängen oder Ergebnissen verwendet werden.
    <Object>.entity.activityDefinitions.field Feld mit den zu analysierenden Daten. Das Feld muss aus der im Parameter table angegebenen Tabelle stammen.
    <Object>.entität.aktivitätsdefinitionen.typ Der Typ der zu migrierenden Werte.
    Gültige Werte:
    • Feldwerte (Standard): Dies ist die Standardauswahl. Diese Option ist verfügbar, wenn Sie eine Aktivitätsdefinition erstellen.
    • Datum/Uhrzeit: Verwendet den Datums-/Uhrzeitwert aus dem tatsächlichen Datensatz anstelle des Auditverlaufs und wird als gruppierter Knoten in der Prozesszuordnung angezeigt.
    • Verbindung: Ein Knoten- oder Prozessdiagramm, das die Änderung im Mehrfachfeldwert aus dem tatsächlichen Datensatz und nicht aus dem Auditverlauf darstellt.
    • Untergeordnetes Element angehängt: Diese Option ist verfügbar, wenn Sie zwei Tabellen für die Tabellenkonfiguration ausgewählt und eine Beziehung zwischen untergeordneten Elementen und übergeordneten Elementen festgelegt haben. Diese Option ist nur für die Konfiguration der übergeordneten Tabelle verfügbar. In der Visualisierung sehen Sie, wann das untergeordnete Element im Prozess angehängt wurde.
    • Übergeordnetes Element angehängt: Diese Option erstellt einen Knoten im untergeordneten Prozess, der darstellt, wann ein übergeordneter Datensatz an ein untergeordnetes Element angehängt wurde.
    <Object>.entity.breakdownDefinitionen Aufgliederungsdefinitionen für das Projekt.

    Datentyp: Array

    [
     {
       "field":"String",
       "fieldLabel":"String"
     }
    ]
    <Object>.entity.breakdownDefinitions.field Name des in der Aufgliederung verwendeten Felds.

    Datentyp: Zeichenfolge

    <Object>.entity.breakdownDefinitions.fieldLabel Bezeichnung des in der Aufgliederung verwendeten Felds.

    Datentyp: Zeichenfolge

    <Object>.Entität.Bedingung Codierte Abfrage zum Auswählen der zu analysierenden Daten.

    Datentyp: Zeichenfolge

    <Object>.entity.table Name der Tabelle, die die zu analysierenden Daten enthält.

    Datentyp: Zeichenfolge

    <Object>.Ergebnisdefinition KPI-Zuordnung Zuordnung von Ergebnisdefinitionen und Leistungskennzahlen (Key Performance Indicators, KPIs), wobei der Schlüssel eine sys_id der Ergebnisdefinition ist und der Wert ein Array von sys_ids der KPIs ist, die von der Ergebnisdefinition betroffen sind.

    Ergebnisdefinitionen befinden sich in den Tabellen „Ergebnisdefinition“ [promin_finding_def] und „Automatisierte Ergebnisdefinition“ [promin_automated_finding]. KPIs befinden sich in der Tabelle „Indikator“ [pa_indicators].

    Weitere Informationen zu Ergebnisdefinitionen und KPIs finden Sie unter Working with finding definitions und Viewing business insights.

    Datentyp: Objekt

    {
       "<finding_def_sys_id":[
          "<kpi_sys_id>"
       ]
    }
    <Object>.id Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Datentyp: Zeichenfolge

    <Object>.lastMined Datum, an dem für das Projekt das letzte Mining durchgeführt wurde.

    Datentyp: Zeichenfolge

    <Object>.miningStatus Mining-Status für das Projekt.

    Beschreibungen der Mining-Status finden Sie unter Mine states.

    Datentyp: Zeichenfolge

    <Object>.name Name des Projekts.

    Datentyp: Zeichenfolge

    <Object>.Berechtigungen Gruppen-, Rollen- und Benutzerberechtigungen für das Projekt.

    Datentyp: Objekt

    [
       {
          "type":"String",
          "value":"String"      
       }
    ]
    <Object>.Berechtigungen.Typ Typ der Berechtigung.
    Gültige Werte:
    • Gruppe
    • role
    • user

    Datentyp: Zeichenfolge

    <Object>.Berechtigungen.Wert Sys_id der Gruppe, Rolle oder des Anwenders zum Erteilen der Berechtigung.

    Datentyp: Zeichenfolge

    <Object>.retiredDate Datum, an dem das Projekt stillgelegt wird.

    Datentyp: Zeichenfolge

    In diesem Beispiel wird ein Process Mining-Projekt abgerufen.

    SNC.ProcessMiningIntegrationAPI.getProject("fa465748ff01121047cae835f2cb1473");

    Ausgabe:

    {
       "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)

    Sendet ein Process Mining-Projekt zum Mining.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    projectId Zeichenfolge Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Tabelle : 14. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des Projekts und einem Tracker.
    {
       "projectId":"String",
       "trackerId":"String"  
    }
    <Object>.ProjektId Sys_id des Projekts.

    Tabelle: Projektdefinition [promin_project]

    Datentyp: Zeichenfolge

    <Object>.trackerID Sys_id des Trackers, der den Mining-Fortschritt für das Projekt überwacht.

    Tabelle: Ausführungstracker [sys_execution_tracker]

    Datentyp: Zeichenfolge

    In diesem Beispiel wird ein -Projekt für das Mining übermittelt.

    SNC.ProcessMiningIntegrationAPI.scheduleMining("c0b91f0cff01121047cae835f2cb14bc");

    Ausgabe:

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