Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Ausführen eines Profils

Availability-noteBeta

In diesem Szenario verwenden Sie Talend-APIs zum Ausführen eines Profils, um die Projektqualität zu verbessern.

Warum und wann dieser Vorgang ausgeführt wird

Im Folgenden finden Sie einige Informationen zum API-Aufruf:

Method: POST
endpoint: api/v1/projects/quality/profiles/{id}/executions
payload:
    {
  "repository": "string",
  "authentication": {
    "username": "string",
    "passcode": "string"
  },
  "branch": "string",
  "workspace": "string",
  "client": "UI"
    }

Der Endpunkt verwendet eine Profil-ID als Parameter, der eine Liste der Spezifikationen enthält, welche im Talend-Projekt ausgeführt werden sollen.

Prozedur

  1. Rufen Sie den Endpunkt GET api/v1/projects/quality/profiles auf, um die ID des auszuführenden Profils aufzurufen.
  2. Notieren Sie sich die ID des Profils, das Sie ausführen möchten.
  3. Rufen Sie den Endpunkt POST api/v1/projects/quality/profiles/{id}/executions auf, um ein Profil auszuführen. Notieren Sie sich die ID des Profils, das Sie als Parameter ausführen möchten.
  4. Geben Sie im Bereich Body folgende Informationen ein:
    Parametername Wert
    repository Geben Sie den Namen des Repositorys ein.
    username Geben Sie Ihren Benutzernamen ein.
    passcode Geben Sie Ihren Passcode ein.
    branch Geben Sie den Branch-Namen ein.
    workspace Geben Sie einen Namen für den Arbeitsbereich ein.
    client Geben Sie den Client-Namen ein.

    Beispiel:

     {
      "repository": "GIT",
      "authentication": {
        "username": "******",
        "passcode": "*************"
      },
      "branch": "master",
      "workspace": "PROJECT_73",
      "client": "UI"
    }
  5. Klicken Sie auf Execute (Ausführen), um den Aufruf auszugeben.

Ergebnisse

Es folgt ein Beispiel einer Antwort:
{
  "id": "67",
  "status": "FAILED",
  "startTimestamp": "2023-10-13 17:36",
  "duration": "2s",
  "specifications": [
    {
      "id": "69",
      "specification": {
        "id": "2",
        "name": "best-practice",
        "description": "This specification contains rules related to best practices",
        "operator": "is_Equal_to",
        "threshold": 100,
        "thresholdType": "PERCENTAGE",
        "createdBy": "system"
      },
      "status": "FAILED",
      "rules": [
        {
          "id": "77",
          "rule": {
            "id": "4",
            "name": "Active-tLogRow",
            "description": "Identify jobs with tLogRow components",
            "category": "COMPONENT",
            "severity": "MINOR",
            "operator": "is_less_than_or_Equal",
            "threshold": "5",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "30",
          "status": "FAILED"
        },
        {
          "id": "78",
          "rule": {
            "id": "5",
            "name": "JavaLogs",
            "description": "Identify jobs that contain java logs.",
            "category": "COMPONENT",
            "severity": "INFO",
            "operator": "is_less_than_or_Equal",
            "threshold": "50",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "4.56",
          "status": "PASSED"
        }
      ],
      "duration": "1s"
    }
  ],
  "sourceProvider": {
    "providerType": "LOCAL",
    "workspace": "D:\\Talend_Studio\\studio\\workspaces\\tcmp_test",
    "project": "PROJECT_73"
  },
  "info": {
    "version": "7.3.1",
    "label": "PROJECT_73",
    "description": "Project imported from TalendPS organization",
    "productVersion": "Talend Real-time Big Data Platform-7.3.1.20221115_1012-patch",
    "type": "DQ",
    "bigData": false,
    "local": false
  },
  "inventory": {
    "total_artifact_assets": 258,
    "context_group": 11,
    "standard_job": 210,
    "standard_job_versions": 211,
    "standard_joblet": 24,
    "standard_joblet_versions": 24,
    "resource": 2,
    "resource_versions": 24,
    "bd_batch": 1,
    "bd_batch_versions": 1,
    "bd_batch_joblet": 0,
    "bd_batch_joblet_versions": 0,
    "bd_streaming": 1,
    "bd_streaming_versions": 1,
    "bd_streaming_joblet": 0,
    "bd_streaming_joblet_versions": 0,
    "route": 46,
    "route_versions": 46,
    "routelet": 1,
    "routelet_versions": 1
  },
  "commits": [
    {
      "id": "24b228d45561e0a741a0409195ef492437bf3",
      "date": "Tue Feb 21 01:29:11 2023 +0000",
      "author": "talend <talend@3bed803c5b79>",
      "message": "\tCreate Project: PRJ_731\n"
    }
  ]
}
In diesem Beispiel sucht die Regel „Active-tLogRow“ nach Jobs mit den tLogRow-Komponenten. Wie in der Bedingung definiert, muss die Gesamtzahl der identifizierten Objekte unter dem maximalen Schwellenwert liegen, in diesem Fall 5.

Das Ergebnis in diesem Beispiel ist 30. Die Qualitätsprüfung der Regel ist fehlgeschlagen. Der Status der Regel ist Failed (Fehlgeschlagen). Der Status jeder Regel wird basierend auf dem Vergleich zwischen dem Ergebnis und dem Schwellenwert ausgewertet.

Die Gesamtqualität des Projekts wird durch den Status der Spezifikation bestimmt. Der Status der Spezifikation wird durch das kumulative Ergebnis oder den Status aller Regeln validiert. In diesem Beispiel wird der Schwellenwert auf 100% festgelegt. Wenn hier eine einzige Bedingung oder Regel fehlschlägt, schlägt die Spezifikation fehl, und der Status wird auf Failed (Fehlgeschlagen) gesetzt.

Der Schwellenwert, der Schwellenwerttyp und der Operator können basierend auf der Auswirkung der Regeln und Spezifikationen auf die Qualität Ihres Talend-Projekts aktualisiert werden.

Nachdem alle Spezifikationen ausgeführt wurden, wird der Status der Ausführung basierend auf der folgenden Bedingung festgelegt:
  • Passed (Bestanden): Status, wenn alle Spezifikationen bestanden haben.
  • Failed (Fehlgeschlagen): Status, wenn fehlgeschlagene Spezifikationen vorliegen.
  • Canceled (Abgebrochen): Status, wenn die Ausführung abgebrochen wurde.
  • Running (Wird ausgeführt): Status, wenn die Ausführung läuft.
Auf die Ausführungen kann durch Verwendung eines Endpunkts GET /api/v1/projects/quality/profiles/executions zugegriffen werden. Die Ausführungen können anhand verschiedener Kriterien gefiltert werden: dem Status der Ausführung ab einer bestimmten Startzeit oder dem Projektnamen.
Ausführungen können auch nach ihrer Ausführungs-ID oder nach ihrem Status, ihrer Startzeit oder dem Projektnamen gelöscht werden.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!