importLibraryDocument

Imports a document or many documents contained in a ZIP file into a specific location in the Planning, Financial Consolidation and Close, Enterprise Profitability and Cost Management, or Tax Reporting library.

Documents you can import using this command includes Microsoft Word documents (.DOC, .DOCX), Excel documents (.XLS, .XLSX), Power Point Presentations (.PPT, .PPTX), Comma Separated Value files (.CSV), PDF files (up to 100 MB in size), test file (.TXT), and file archives (.ZIP, up to 100 MB in size). Before running this command, use the Import Migration screen or an EPM Automatecommand such as uploadFile, copyFileFromInstance, and copyFromObjectStorage to load the source archive or file to the environment.

Applies to

Planning, FreeForm, Financial Consolidation and Close, Enterprise Profitability and Cost Management, Tax Reporting

Required Roles

Service Administrator

Usage

epmautomate importLibraryDocument SOURCE_FILE DESTINATION [jobName=JOB_NAME][description=DESCRIPTION][overwrite=true|false][deleteAfterImport=true|false][errorFile=FILE_NAME.log], where:
  • SOURCE_FILE is the name a document or of an archive that contains one or more documents to be imported into the library.
  • DESTINATION is the fully qualified path or the Universally Unique Identifier (UUID) of the destination folder into which the file or contents of the archive is to imported.
  • jobName, optionally, is the name of the import document library job to use to import the document. If a value is not specified, by default, the Import Document to Library job is used.
  • description, optionally, is a description of the document being imported.
  • overwrite, optionally, identifies whether to overwrite existing documents in the destination folder with names identical to the source documents. Default is false.
  • deleteAfterImport, optionally, specifies whether to delete the source file after the import process is complete. Default is false.
  • errorFile, optionally, is the name for a file that will capture information reported during the command execution process. This file will be created in the outbox and will have the .log extension.

    Use the downloadFile command to download this file to the local computer.

Example

epmautomate importLibraryDocument "FinancialReport2024.xlsx" "Library/Insights" jobName=ImportSingleDocument description="Annual Financial Report 2024" overwrite=true deleteAfterImport=true errorFile=FinancialReport2024ImportLog.log