Quelldaten

Der Relay-Dienst enthält Funktionen zum Veröffentlichen von Quelldateien, die während des Datenextraktionsteils einer Umfrage verwendet werden. Beispielsweise wird eine Umfrage für ios_messages.messages die Datei sms.db aus einem iOS-Backup durchsuchen, um Nachrichtendaten abzurufen – bei Verwendung der Quelldateiveröffentlichung wird die Datei sms.db selbst zusammen mit den extrahierten Daten und allen relevanten Anhangsdateien zurückgegeben.

Veröffentlichung der Quelldatei aktivieren

Die Veröffentlichung von Quelldateien kann auf Abonnementbasis, über das Attribut poll_payload oder über eine unternehmensweite Konfiguration oder Konfiguration auf Schlüsselebene aktiviert werden. Alle verwenden denselben Konfigurationsschlüssel: publish_source_files

Erstellen eines Abonnements mit aktivierter Quelldateiveröffentlichung

curl https://ricloud-api.reincubate.com/subscriptions \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "source": "<child source ID>",
  "poll_payload": {
    "data_types": ["ios_messages.messages"],
    "publish_source_files": true
  }
}'

Konfigurieren der Quelldateiveröffentlichung auf Organisationsebene

curl https://ricloud-api.reincubate.com/organisation \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Für das Obige ist ein Organisations-Admin-Schlüssel erforderlich.

Konfigurieren der Quelldateiveröffentlichung auf Schlüsselebene

curl https://ricloud-api.reincubate.com/key \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Organisationsweite Konfigurationen können durch Konfigurationen auf Schlüsselebene außer Kraft gesetzt werden, was hilfreich sein kann, wenn Quelldateien nur für die Produktionsnutzung von Interesse sind. In ähnlicher Weise können beide durch den Abfrage-Payload-Parameter überschrieben werden, sodass Sie von Fall zu Fall angeben können, ob Quelldateien veröffentlicht werden sollen.

Beachten Sie, dass das Aktivieren von Funktionen über die Organisations- oder Schlüsselkonfiguration das geänderte Verhalten rückwirkend auf bestehende Abonnements anwendet.

Arbeiten mit Quelldateiergebnissen

Wenn die Veröffentlichung von Quelldateien aktiviert ist, verfolgt die API alle Dateien, die im Rahmen des Extraktionsprozesses berührt wurden, veröffentlicht sie in Ihrem Speicher-Bucket und erstellt ein Ergebnisobjekt, das der aktuellen Umfrage zugeordnet ist.

Ein Verweis auf die Quelldateien, die sich auf einen bestimmten Datensatz beziehen, ist im metadata des Datenergebnisses selbst enthalten. Zum Beispiel:

{
  "data": [{
    "id": "a1b2c3d4",
    "data_type": "message",
    "conversation_id": "w6x7y8z9",
    "handle": "Pal",
    "type": "SMS",
    "text": "Hi, how’s it going?",
    "attachments": [{
          "type": "image",
          "file_id": "a492be9a8dadabdc774286116232420224f14976",
          "file_path": "Library/SMS/Attachments/de/14/33A09D66-287E-4B64-A874-1A1234BD7E61/IMG_0006.PNG",
          "filename": "IMG_0006.PNG"
    }],
    "group_handles": [
      "Pal",
      "renate@reincubate.com"
    ],
    "from_me": false,
    "deleted": false,
    "date": "2020-01-01T00:00:00.000000Z"
  }],
  "metadata": {
    "count": 1,
    "filters": null,
    "source_files": [{
      "file_id": "3d0d7e5fb2ce288813306e4d4636395e047a3d28",
      "domain": "HomeDomain",
      "file_path": "Library/SMS/sms.db",
      "filename": "sms.db",
      "size": 123456,
      "date_last_modified": "2020-01-02T00:00:00.000000Z"
    }]
  }
}

Wie bei den Ergebnissen von Anhangsdateien entspricht die file_id eines Quelldateieintrags dem identifier des Ergebnisses, auf das es sich bezieht. Daher ist dies auch der Name der Datei, die in Ihren Speicher-Bucket geschrieben wird.