exportLibraryDocument

将报表库中可用的文档导出到文件。

可以使用 downloadFile 命令将导出的文件下载到本地计算机。

适用于

PlanningPlanning 模块自由形式Financial Consolidation and CloseTax ReportingEnterprise Profitability and Cost Management销售规划战略性人员规划

所需角色

服务管理员

用法

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(可选)是要用于导出文档的库文档导出作业的名称。默认作业名称为 Copy Artifact From Library(从库复制对象)。
  • 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