exportLibraryDocument

將報表文件庫中的文件匯出至檔案。

您可以使用 downloadFile 命令將所匯出的檔案下載至本機電腦。

適用於

Planning、Planning 模組、FreeForm、Financial Consolidation and Close、Tax Reporting、Enterprise Profitability and Cost Management、Sales Planning 及 Strategic Workforce Planning。

必要角色

服務管理員

用法

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false]，其中：
  • ARTIFACT_PATH 是報表文件庫中文件的位置或通用唯一識別碼 (UUID)。若要匯出多份文件，請指定以逗點分隔的 UUID 或文件位置清單。
  • jobName (選擇性) 是要用於匯出文件之文件庫文件匯出工作的名稱。預設的工作名稱為從文件庫複製物件。
  • EXPORT_FILE (選擇性) 是匯出檔案的唯一名稱。

    如果您使用 exportFormat=ZIP，則產生的結果 ZIP 檔案會使用此名稱。請務必在此值中使用 .zip 副檔名。

    如果您使用 exportFormat=file：

    • 匯出一份文件：如果您指定的副檔名符合文件的副檔名，則會使用此名稱建立匯出檔案。
    • 匯出多份文件：命令會忽略此值，並使用每份文件的原始名稱匯出每份文件。
  • exportFormat (選擇性) 是以下之一：
    • File 會根據檔案在文件庫中是否可用，按照原始二進位格式 (PDF、DOCX、Zip、JPEG 等) 匯出文件。會使用每個匯出檔案的原始名稱在寄件匣中建立每個匯出檔案。此為預設值。
    • zip 會建立一個 ZIP 檔案，其中包含原始二進位格式的所有已匯出文件。如果沒有為選擇性參數 exportFile 指定任何值，則會使用執行命令之使用者的使用者名稱與時間戳記自動產生 zip 檔案名稱。檔案名稱格式為 username_exported_artifacts_yyyyMMddHHmm.zip，例如 JDoe_exported_artifacts_202410201559.zip。
  • errorFile (選擇性) 是將用來儲存與匯出相關之錯誤之檔案的唯一名稱。如果未指定這個值，則不會建立錯誤檔案。
  • overwrite (選擇性) 會控制是否要覆寫預設下載位置中名稱相同的檔案。預設值為 false，表示如果寄件匣中有同名的檔案存在，則此命令將失敗。

範例

  • 匯出一份文件：

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

  • 匯出多份文件

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