exportLibraryDocument

Exports documents available in the Reports library to a file.

You can download the exported file to a local computer using the downloadFile command.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning, and Strategic Workforce Planning.

Required Roles

Service Administrator

Usage

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false] where:
  • ARTIFACT_PATH is the location or the Universally Unique Identifier (UUID) of the document in the Reports library. To export multiple documents, specify a comma separated list of UUIDs or document locations.
  • jobName, optionally, is the name of the library document export job that is to be used to export the document. The default job name is Copy Artifact From Library.
  • EXPORT_FILE, optionally, is a unique name for the export file.

    If you are using exportFormat=ZIP, the resulting ZIP file uses this name. Be sure to use the .zip extension in this value.

    If you are using exportFormat=file:

    • Exporting one document: The export file is created with this name if the file extension you specify matches that of the document.
    • Exporting many documents: The command ignores this value and exports each document using its original name.
  • exportFormat, optionally, is one of the following:
    • File exports the documents in the original binary format (PDF, DOCX, Zip, JPEG, and so on) in which they are available within the library. Each exported file is created in the outbox using its original name. This is the default value.
    • zip creates a ZIP file containing all the exported documents in their original binary format. If no value is specified for the exportFile optional parameter, the zip file name is automatically generated using the user name of the user running the command and the time stamp. File name format is username_exported_artifacts_yyyyMMddHHmm.zip, for example, JDoe_exported_artifacts_202410201559.zip.
  • errorFile, optionally, is a unique name for the file that will store export-related errors. No error file is created if you do not specify this value.
  • overwrite, optionally, controls whether an identically named file currently in the default download location should be overwritten. The default is false, which means that the command will fail if a file with an identical name exists in the outbox.

Examples

  • Export one document:

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

  • Export multiple documents

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