exportLibraryDocument

Exports any document 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 of the document in the Reports library.
• jobName, optionally, is the name of the library artifact export job that is to be used to export the document. The default job name is Copy Artifact From Library.
• EXPORT_FILE is a unique name for the file to which document is to be exported. If you do not specify this value, the export file will be created using the name of the document in the library.
• exportFormat, optionally, is one of the following:
  • File exports the document in the original binary format (PDF, DOCX, Zip, JPEG, and so on) in which it is available within the library. This is the default value.

    Note:

    In the 24.02 update, this option does not work.
  • zip exports a ZIP file containing the document in its original binary format. This is the only option that works in this update.
• 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.

Example

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