exportLibraryDocument

Exportiert in der Berichtsbibliothek verfügbare Dokumente in eine Datei.

Sie können die exportierte Datei mit dem Befehl downloadFile auf einen lokalen Computer herunterladen.

Gilt für

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning und Strategische Personalplanung.

Erforderliche Rollen

Serviceadministrator

Verwendung

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false], wobei Folgendes gilt:
  • ARTIFACT_PATH ist der Speicherort oder der Universally Unique Identifier (UUID) des Dokuments in der Berichtsbibliothek. Um mehrere Dokumente zu exportieren, geben Sie eine durch Komma getrennte Liste der UUIDs oder Speicherorte der Dokumente an.
  • jobName (optional) ist der Name des Bibliotheksdokument-Exportjobs, der für den Export des Dokuments verwendet wird. Der Standardjobname lautet Copy Artifact From Library.
  • EXPORT_FILE (optional) ist ein eindeutiger Name für die Exportdatei.

    Wenn Sie exportFormat=ZIP verwenden, nutzt die resultierende ZIP-Datei diesen Namen. Achten Sie darauf, die ZIP-Erweiterung in diesem Wert zu verwenden.

    Bei der Verwendung von exportFormat=file:

    • Ein Dokument exportieren: Die Exportdatei wird mit diesem Namen erstellt, wenn die von Ihnen angegebene Dateierweiterung mit der des Dokuments übereinstimmt.
    • Viele Dokumente exportieren: Der Befehl ignoriert diesen Wert und exportiert jedes Dokument mit seinem ursprünglichen Namen.
  • exportFormat (optional) entspricht einem der folgenden Formate:
    • File exportiert die Dokumente in dem ursprünglichen binären Format (PDF, DOCX, ZIP, JPEG usw.), in dem sie in der Bibliothek vorliegen. Jede exportierte Datei wird in der Outbox mit ihrem ursprünglichen Namen erstellt. Das ist der Standardwert.
    • zip erstellt eine ZIP-Datei, die alle exportierten Dokumente in ihrem ursprünglichen binären Format enthält. Wenn für den optionalen Parameter exportFile kein Wert angegeben wird, wird der Name der ZIP-Datei automatisch anhand des Benutzernamens des Benutzers, der den Befehl ausführt, und anhand des Zeitstempels generiert. Das Format für den Dateinamen ist Benutzername_exported_artifacts_jjjjMMttHHmm.zip, z.B. JDoe_exported_artifacts_202410201559.zip.
  • errorFile (optional) ist ein eindeutiger Name für die Datei, in der Exportfehler gespeichert werden. Wenn Sie diesen Wert nicht angeben, wird keine Fehlerdatei erstellt.
  • overwrite (optional) steuert, ob eine Datei mit demselben Namen, die sich derzeit im Standardspeicherort für Downloads befindet, überschrieben werden soll. Der Standardwert ist false, d.h., der Befehl ist nicht erfolgreich, wenn eine Datei mit demselben Namen in der Outbox vorhanden ist.

Beispiele

  • Ein Dokument exportieren:

    epmautomate exportLibraryDocument Library/folder1/WeeklySales.html jobName="Copy Weekly Sales" exportFile=WeeklySales.zip errorFile=WeeklySalesError.log overWrite=true exportFormat=zip

  • Mehrere Dokumente exportieren:

    epmautomate exportLibraryDocument Library/folder1/WeeklySales.html,Library/folder2/WeeklySalesReport.pdf jobName="Copy Weekly Sales" exportFile=WeeklySales.zip errorFile=WeeklySalesError.log overWrite=true exportFormat=zip