get storage service content (Integration-Funktion)

Prev Next

Die Funktion get storage service content (Integration-Funktion) gibt den Inhalt eines in Lobster Data Platform / Orchestration hochgeladenen Dokuments zurück, sofern dieses beim per Parameter a (storage service key) spezifizierten Storage-Service unter dem per Parameter b (document id) definierten Schlüsselwert registriert ist.

Parameter

Beschreibung

a

Storage Service Key: Kennung für einen Storage Service von Lobster Data Platform / Orchestration

b

Schlüsselwert (document id) unter dem das Dokument vom Service registriert wurde

c

Mit dem Wert true wird der Dokumentinhalt als Base64-String zurückgegeben,
sonst Binärdaten.

Siehe auch: get document content (Integration-Funktion)

Was ist ein Storage-Service?

Lobster Data Platform / Orchestration verwaltet hochgeladene Dateien ("Dokumente") abhängig vom Kontext über einen der folgenden "Storage-Services":

Storage Service Key

Kontext

Entität im Kontext

"Dokument" im Kontext

Schlüsselwert ("document id")

optionales Modul?

mailAttachments

E-Mails

vom System erstellte E-Mail
core:Mail

Dateianhänge
(attachementEntry.content)

interne ID des Mail-Anhangs
(attachementEntry.id)

nein (immer installiert)

documents

Dokumente

Dokument
doc:Document

Dokumentinhalt
(documentContent)

interne ID des Dokuments
(id)

Dokumente (DOC)

signedByImages

Trackingstatus

Trackingstatus-Eintrag
baseTS:TrackingStatusEntry

erfasste Signatur (Grafikdatei)
(signedByImage)

interne ID des Trackingstatus-Eintrags
(id)

Trackingstatus (TS)

HINWEIS◄ Der Begriff "Dokument" wird in diesem Zusammenhang als Oberbegriff verwendet, der sich unter anderem auf die im Dokumentenmodul von Lobster Data Platform / Orchestration verwalteten Dokumente beziehen kann. Für den Zugriff auf solche Dokumente kann alternativ die Funktion get document content (Integration-Funktion) genutzt werden, für die der Storage Service Key documents quasi "voreingestellt" ist.

Abhängig vom Parameter c wird der Dokumentinhalt entweder binär (false/Standard) oder als Base64 codierte Zeichenfolge zurückgegeben.

images/download/attachments/201674024/image2020-10-28_12-30-21-version-1-modificationdate-1747044194226-api-v2.png

HINWEISE

  • Der Dokumentinhalt wird ohne Berücksichtigung von für Lobster Data Platform / Orchestration relevanten Rollenrechten, Besitzverhältnissen und Freigaben bereitgestellt, wenn der Zugriff über die get storage service content (Integration-Funktion)-Funktion erfolgt.

  • Falls zum Zeitpunkt des Funktionsaufrufs kein Dokument mit der im Parameter c adressierten document id existiert, bricht das Profil mit einem Fehler ab.

Parameter

Parameter

Beschreibung

Beispiel

Hinweis

a

Storage Service Key: Kennung für einen Storage Service von Lobster Data Platform / Orchestration

mailAttachments

Die Info-Box (oben) listet die gültigen Storage Service Keys auf.

b

Schlüsselwert (document id) unter dem das Dokument vom Service registriert wurde

4711

Die Info-Box (oben) gibt an, wie der Schlüsselwert je Storage Service definiert ist.

c

Mit dem Wert true wird der Dokumentinhalt als Base64-String zurückgegeben
,sonst Binärdaten.

true
false

Base64-Inhalte können z. B. in XML-Dokumenten verwendet werden, um binäre Dateien als Strings einzubetten.
Die Rückgabe von Binärdaten liefert den Dateiinhalt direkt (wie bei einem Download).

Beispiel

Ein Profil soll einen bestimmten Dateianhang aus von Lobster Data Platform / Orchestration generierten E-Mail über einen geeigneten Antwortweg an ein anderes System weitergeben.

images/download/attachments/201674024/image2020-10-28_15-39-40-version-1-modificationdate-1747044194224-api-v2.png

Das Berechnungsfeld attachedEntryId ermittelt zunächst die interne ID des abzurufenden Dateianhangs, etwa über eine mit der SearchTask (Integration-Funktion)-Funktion definierte Suche oder Tupel-Suche für das core:Mail-Objekt.

ANMERKUNG◄ Wie das Symbol für das Feld signalisiert, wurde hier ein Fixwert hinterlegt, da Details zur Ermittlung der ID für das Beispiel unerheblich sind.

Im Feld content, das für die Ausgabe im Antwortweg ausschlaggebend ist, ruft die Funktion get storage service content (Integration-Funktion) den Inhalt zu der ermittelten internen ID ab:

  • Der relevante Storage Service für E-Mail-Dateianhänge wird im Parameter a durch den Storage Service Key mailAttachments spezifiziert.

  • Dem Parameter b wird der Wert aus dem Zielfeld attachedEntryId als document id übergeben, also die zuvor ermittelte interne ID des auszugebenden E-Mail-Anhangs.

  • Der Parameter c erhält keine Zuweisung, da der Dateiinhalt direkt ("binär" und nicht als Base64-Code) zurückgegeben werden soll.