Notifiche di esecuzione del flusso

Ultimo aggiornamento: 2023-03-14
  • Argomenti:
  • Sources
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Developer
    User
    Admin
    Leader

Adobe Experience Platform consente di acquisire dati da origini esterne e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite Platform servizi. È possibile acquisire dati da diverse origini, ad esempio applicazioni Adobe, archiviazione basata su cloud, database e molte altre.

Flow Service API viene utilizzato per raccogliere e centralizzare i dati dei clienti da diverse origini in Platform. Il servizio fornisce un’interfaccia utente e un’API RESTful da cui tutte le sorgenti supportate sono collegabili.

Con Eventi di Adobe I/O, puoi abbonarti agli eventi e utilizzare i webhook per ricevere notifiche sullo stato delle esecuzioni del flusso. Queste notifiche contengono informazioni sul successo dell’esecuzione del flusso o sugli errori che hanno contribuito al suo errore.

Questo documento descrive come abbonarsi a eventi, registrare webhook e ricevere notifiche contenenti informazioni sullo stato delle esecuzioni del flusso.

Introduzione

Questa esercitazione presuppone che sia già stata creata almeno una connessione di origine di cui si desidera monitorare l'esecuzione del flusso. Se non hai ancora configurato una connessione sorgente, inizia visitando il panoramica sulle origini per configurare l'origine desiderata prima di tornare a questa guida.

Questo documento richiede anche una buona conoscenza dei webhook e di come collegarli da un’applicazione all’altra. Consulta la sezione I/O Events documentazione per un’introduzione ai webhook.

Registrare un webhook per le notifiche di esecuzione del flusso

Per ricevere le notifiche di esecuzione del flusso, è necessario utilizzare la console Adobe Developer per registrare un webhook nel Experience Platform integrazione.

Segui l’esercitazione su abbonamento a notifiche I/O Event per i passaggi dettagliati su come eseguire questa operazione.

IMPORTANTE

Durante il processo di abbonamento, assicurati di selezionare Notifiche della piattaforma come provider di eventi e selezionare le sottoscrizioni di eventi seguenti:

  • Esecuzione del flusso dell'origine Experience Platform completata
  • Esecuzione del flusso dell'origine Experience Platform non riuscita

Ricevi notifiche di esecuzione del flusso

Con il webhook connesso e l’abbonamento all’evento completato, puoi iniziare a ricevere le notifiche di esecuzione del flusso tramite il dashboard del webhook.

Una notifica restituisce informazioni quali il numero di processi di acquisizione eseguiti, la dimensione del file e gli errori. Una notifica restituisce anche un payload associato all’esecuzione del flusso in formato JSON. Il payload di risposta può essere classificato come sources_flow_run_success o sources_flow_run_failure.

IMPORTANTE

Se l’acquisizione parziale è abilitata durante il processo di creazione del flusso, un flusso che contiene sia acquisizioni riuscite che non riuscite verrà contrassegnato come sources_flow_run_success solo se il numero di errori è inferiore alla percentuale di soglia di errore impostata durante il processo di creazione del flusso. Se un’esecuzione di flusso corretta contiene errori, questi verranno comunque inclusi nel payload di ritorno.

Operazione riuscita

In caso di esito positivo, la risposta restituisce un set di metrics che definiscono le caratteristiche di un flusso specifico e activities che delineano la modalità di trasformazione dei dati.

{
  "event_id": "aec55616-1715-487f-8044-ba648cc8ffee",
  "event": {
    "createdAt": 1597213529158,
    "updatedAt": 1597213530760,
    "createdBy": "{CREATED_BY}",
    "updatedBy": "{UPDATED_BY}",
    "createdClient": "{CREATED_CLIENT}",
    "updatedClient": "{UPDATED_CLIENT}",
    "sandboxId": "7127a4f0-def8-11e9-83ce-e79494b1c2a5",
    "sandboxName": "prod",
    "imsOrgId": "{ORG_ID}",
    "id": "933cf9f4-cf01-4d75-bcf9-f4cf010d750a",
    "flowId": "1c6f1047-dcaf-48fe-af10-47dcaf08feaf",
    "providerRefId": "test1234",
    "etag": "\"5100ec97-0000-0200-0000-5f338b5b0000\"",
    "metrics": {
      "durationSummary": {
        "startedAtUTC": 1590512053,
        "completedAtUTC": 1590512053
      },
      "sizeSummary": {
        "inputBytes": 2048,
        "outputBytes": 1024
      },
      "recordSummary": {
        "inputRecordCount": 100,
        "outputRecordCount": 70
      },
      "fileSummary": {
        "inputFileCount": 10,
        "outputFileCount": 10
      },
      "statusSummary": {
        "status": "success"
      }
    },
    "activities": [
      {
        "id": "copyActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "startedAtUTC": 1590512053,
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 2048,
          "outputBytes": 1098
        },
        "recordSummary": {
          "inputRecordCount": 100,
          "outputRecordCount": 100
        },
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "adf/pipeline/id": "abcd",
            "adf/run/id": "1234"
          }
        },
        "sourceInfo": [
          {
            "id": "sourceConnectionId1",
            "type": "SourceConnection",
            "reference": {
              "type": "AdfRunId"
            }
          }
        ]
      },
      {
        "id": "promotionActivity",
        "updatedAtUTC": 87473822,
        "durationSummary": {
          "completedAtUTC": 1590512053
        },
        "sizeSummary": {
          "inputBytes": 1098,
          "outputBytes": 1024
        },
        "recordSummary": {},
        "fileSummary": {
          "inputFileCount": 10,
          "outputFileCount": 10,
          "extensions": {
            "manifest": {
              "fileInfo": "https://platform.adobe.io/data/foundation/export/batches/01E4TSJNM2H5M74J0XB8MFWDHK/meta?path=input_files"
            }
          }
        },
        "statusSummary": {
          "status": "success",
          "extensions": {
            "batchId": "b1",
            "acp_request_id": "1234"
          }
        },
        "targetInfo": [
          {
            "id": "targetConnectionId1",
            "type": "TargetConnection",
            "reference": {
              "type": "batch"
            }
          }
        ]
      }
    ],
    "slaCreatedAt": 1597213531124,
    "processStartTime": 1597213531213,
    "header": {
      "_adobeio": {
        "imsOrgId": "{ORG_ID}",
        "providerMetadata": "platform_notifications",
        "eventCode": "sources_flow_run_success"
      }
    },
    "transformedTime": 1597213531214
  }
}
Proprietà Descrizione
metrics Definisce le caratteristiche dei dati nell’esecuzione del flusso.
activities Definisce i diversi passaggi e le diverse attività eseguiti per trasformare i dati.
durationSummary Definisce l’ora di inizio e di fine dell’esecuzione del flusso.
sizeSummary Definisce il volume dei dati in byte.
recordSummary Definisce il conteggio dei record dei dati.
fileSummary Definisce il conteggio dei file dei dati.
fileInfo Un URL che porta a una panoramica dei file correttamente acquisiti.
statusSummary Definisce se l’esecuzione del flusso è riuscita o meno.

Errore

La seguente risposta è un esempio di esecuzione di un flusso non riuscita, con un errore che si verifica durante l’elaborazione dei dati copiati. Possono inoltre verificarsi errori durante la copia dei dati dall’origine. Un'esecuzione di flusso non riuscita include informazioni sugli errori che hanno contribuito all'errore, inclusi l'errore e la descrizione.

[
  {
    "messages": [
      {
        "msgType": "eventNotification",
        "version": "1.0",
        "timestamp": 1597434157622,
        "imsOrgId": "{ORG_ID}",
        "schema": {
          "name": "run-notification",
          "version": "1.0"
        },
        "provider": "FlowService",
        "_eventNotificationMeta": {
          "category": "Platform Notifications",
          "type": "sources_flow_run_failed"
        },
        "value": {
          "createdAt": 1597434147259,
          "updatedAt": 1597434157567,
          "createdBy": "{CREATED_BY}",
          "updatedBy": "{UPDATED_BY}",
          "createdClient": "{CREATED_CLIENT}",
          "updatedClient": "{UPDATED_CLIENT}",
          "sandboxId": "e49ebb00-d0fa-11e9-b164-ed6a398c8b35",
          "sandboxName": "prod",
          "imsOrgId": "{ORG_ID}",
          "id": "d9024c32-2174-4271-824c-322174627101",
          "flowId": "cf4fce79-8822-456d-8fce-798822556dc6",
          "etag": "\"0c003dbf-0000-0200-0000-5f36e92d0000\"",
          "metrics": {
            "durationSummary": {
              "startedAtUTC": 1597434147190
            },
            "sizeSummary": {
              "inputBytes": -1
            },
            "fileSummary": {
              "inputFileCount": -1
            },
            "statusSummary": {
              "status": "failed",
              "errors": [
                {
                  "code": "CONNECTOR-2001-500",
                  "message": "Error in processing (parsing, validation or transformation) the copied data."
                }
              ]
            }
          },
          "activities": [
            {
              "id": "promotionActivity",
              "updatedAtUTC": 1597434157529,
              "durationSummary": {
                "startedAtUTC": 1597434147190,
                "completedAtUTC": 1597434157212
              },
              "sizeSummary": {
                "inputBytes": -1
              },
              "recordSummary": {},
              "fileSummary": {
                "inputFileCount": -1,
                "extensions": {
                  "manifest": {
                    "fileInfo": "https://platform-stage.adobe.io/data/foundation/export/batches/6f6a900f-e40d-4f0e-9bb9-b614436c3465/meta?path=input_files"
                  }
                }
              },
              "statusSummary": {
                "status": "failed",
                "errors": [
                  {
                    "code": "CONNECTOR-2001-500",
                    "message": "Error in processing (parsing, validation or transformation) the copied data."
                  }
                ],
                "extensions": {
                  "errors": [
                    {
                      "code": "133",
                      "message": "We are unable to locate any files uploaded for this batch. Please upload files to ingest."
                    }
                  ]
                }
              },
              "targetInfo": [
                {
                  "id": "e88737aa-27b8-4795-8737-aa27b8f7959e",
                  "type": "TargetConnection",
                  "reference": {
                    "type": "Batch",
                    "ids": [
                      "6f6a900f-e40d-4f0e-9bb9-b614436c3465"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  }
]
Proprietà Descrizione
fileInfo URL che offre una panoramica dei file acquisiti correttamente e senza successo.
NOTA

Consulta la appendice per ulteriori informazioni sui messaggi di errore.

Passaggi successivi

Ora puoi abbonarti a eventi che ti consentono di ricevere notifiche in tempo reale sui tuoi stati di esecuzione del flusso. Per ulteriori informazioni sulle esecuzioni e sulle origini del flusso, vedere panoramica sulle origini.

Appendice

Le sezioni seguenti forniscono informazioni aggiuntive sull’utilizzo delle notifiche di esecuzione del flusso.

Informazioni sui messaggi di errore

Possono verificarsi errori di acquisizione quando i dati vengono copiati dall’origine o quando i dati copiati vengono elaborati in Platform. Per ulteriori informazioni su errori specifici, consulta la tabella seguente.

Errore Descrizione
CONNECTOR-1001-500 Si è verificato un errore durante la copia dei dati da un'origine.
CONNECTOR-2001-500 Si è verificato un errore durante l'elaborazione dei dati copiati in Platform. Questo errore può riguardare l’analisi, la convalida o la trasformazione.

In questa pagina