exportLibraryDocumentFolder

Exports the contents, including sub-folders, of a Reports library folder to a fZIP ile.

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, Sales Planning, and Strategic Workforce Planning.

Required Roles

Service Administrator

Usage

epmautomate
                exportLibraryDocumentFolder FOLDER_PATH [jobName=JOB_NAME]
                    [includeSubfolders=true|false] [exportFile=FILE_NAME.zip]
                    [errorFile=FILE_NAME.log] [overWrite=true|false]

where:

FOLDER_PATH is the Report library folder path from which contents are to be exported. Use a comma-separated list of folder paths to export contents from multiple 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.
includeSubfolders, optionally, indicates whether to recursively export the subfolders, if any, in the specified path.
exportFile, optionally, is a unique name for the export ZIP file.
errorFile, optionally, is a unique name for the log file that will store export-related errors. No error file is created if you do not specify this value.
overwrite, optionally, specifies whether identically named export ZIP file, if currently present in the default download location, should be overwritten. The default is false, which means that the command will fail if an identically named file exists.

Examples

Export the contents of one folder in the Reports library:
epmautomate exportLibraryDocumentFolder "Library/Weekly Sales" jobName="Copy Weekly Sales Folder" includeSubfolders=false exportFile=WeeklySales.zip errorFile=WeeklySalesError.log overWrite=true
Export contents of many foldesr in the Reports library:
epmautomate exportLibraryDocumentFolder "Library/Weekly Sales/East Region","Library/Weekly Sales/West Region","Library/Weekly Sales/All Others" jobName="Copy Weekly Sales Folder" includeSubfolders=false exportFile=WeeklySales_US.zip errorFile=WeeklySalesError.log overWrite=false