Skip to main content
Skip table of contents

Dropbox Connector

Dieser Adapter stellt eine Verbindung zum Dropbox-Cloud-Dienst her und bietet Funktionen zur Verwaltung von Cloud-Speicherdaten.

Für die Verwendung des Dropbox Connectors wird ein Dropbox-Konto (Standard oder Business) benötigt.


Vor der ersten Verwendung des Adapters:

Wenn der Adapter Dropbox Connector zum ersten Mal verwendet werden soll, dann müssen zuvor folgende Schritte ausgeführt werden:

  1. Die Website https://www.dropbox.com/developers aufrufen.
  2. Auf App Console klicken. Der Button befindet sich oben rechts.
  3. Auf Create app klicken.
    1. Für Choose an API Dropbox API auswählen.
    2. Für Choose the type of access you need Full Dropbox auswählen.
    3. Für Name your app einen beliebigen Namen eingeben.
    4. Auf Create app klicken
    5. Die App wird erzeugt und die App-Einstellungen öffnen sich.
  4. Unter Generated access token auf Generate klicken.
  5. Der Access Token wird erzeugt und angezeigt. Dieser Access Token wird für die Verwendung des Dropbox Connectors benötigt.


Über die API wird in der zugeordneten Dropbox ein Ordner Apps erstellt, dieser bildet den Anwendungsordner. Jeder, der im Besitz des generierten Access Token ist, hat Zugriff auf diesen Ordner! Achten Sie darauf, wer in den Besitz des Access Token gelangt!


Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

  • CopyFile: Kopiert eine Datei innerhalb der Dropbox.
  • CreateFile: Fügt der Dropbox eine Datei hinzu.
  • DeleteFile: Löscht eine Datei innerhalb der Dropbox.
  • ExtractFolder: Extrahiert eine .zip-Datei in den bei den Parametern angegebenen Ordner.
  • GetFileContent: Gibt den Inhalt einer Datei aus.
  • GetFileMetadata: Gibt die Metadaten einer Datei aus.
  • ListFolder: Listen den Inhalt eines Ordners auf.
  • UpdateFile: Aktualisiert eine Datei.

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte:  de.softproject.x4.adapter.dropbox.DropBoxConnector: Hauptklasse (Standard)

accessToken 

Erforderlich. Wird benötigt, um eine Verbindung mit dem Dropbox-Konto herzustellen.

Mögliche Werte: eindeutiger Access Token

Der Access Token muss in der Dropbox generiert werden.

folderPath 

Pfad zu einem Ordner in der Dropbox.

Mögliche Werte: Ordnerpfad (Standard: / (oberste Ordnerebene))

Der Ordnerpfad muss immer mit einem / beginnen und enden.

Wenn während der Operation CreateFile Ordner verwendet werden, die nicht existieren, dann werden diese automatisch erstellt.

fileName 

Dateiname der Datei, die verarbeitet werden soll.

Mögliche Werte: Dateiname inkl. Dateiendung

sourcePath 

Erforderlich für die Operation CopyFile . Gibt an, welche Datei kopiert werden soll.

Mögliche Werte: Dateipfad inkl. Dateiname und Dateiendung, z. B. folder/file.txt

destinationPath 

Erforderlich für die Operation CopyFile . Gibt an, welche Datei kopiert werden soll.

Mögliche Werte: Dateipfad

folderName

Erforderlich für die Operation ExtractFolder. Name des Ordners, in dem die extrahierten Dateien erstellt oder überschrieben werden.

Mögliche Werte: Beliebige Zeichenkette

overwrite 

Definiert, ob vorhandene Dateien beim Kopieren oder Erstellen überschrieben werden.

Mögliche Werte:

  • true: Wenn eine Datei mit dem gleichen Namen an diesem Speicherort bereits existiert, dann wird diese Datei überschrieben.
  • false: Wenn eine Datei mit dem gleichen Namen an diesem Speicherort bereits existiert, dann wird die neue Datei umbenannt,  z. B. von File.txt zu Copy_of_File.txt.

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt.

-1

Die Operation konnte nicht ausgeführt werden. Die Fehlermeldung wird als Textdokument und im Server-Log ausgegeben.


Input

Der Adapter erwartet für die Operationen CreateFile  und UpdateFile  eine Datei als Input.

Der Adapter erwartet für die Operation ExtractFolder eine .zip-Datei als Input.

Output

Der Adapter liefert abhängig von der ausgeführten Operation unterschiedliche Daten als Output.

  • Operationen CopyFileCreateFile und DeleteFile: Textdokument mit Information
  • Operationen ListFolderGetFileMetadata: XML-Dokument mit entsprechendem Inhalt

    Beispieloutput GetFileMetadata

    XML
    <Metadata isFolder="false">
    	<Name>new.txt</Name>
    	<Path>/new.txt</Path>
    	<Id>id:SLz0S6oc-FAAAAAAAAAALw</Id>
    	<LastModified>2019-06-26T11:55:33</LastModified>
    	<Size>4</Size>
    </Metadata>

    Beispieloutput ListFolder

    XML
    <Result>
    	<Entry isFolder="true">Folder</Entry>
    	<Entry isFolder="false">Image.png</Entry>
    	<Entry isFolder="false">file.txt</Entry>
    	<Entry isFolder="false">Document.docx</Entry>
    </Result>
  • Operation ExtractFolder: Liefert keinen Output.
  • Operation GetFileContent: Inhalt der ausgelesenen Datei

    Es werden nicht alle Dateiformate unterstützt!


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.