importLibraryArtifact

Imports library artifacts from an archive or file into Narrative Reporting library.

Before running this command, upload the source archive or file to the environment using the uploadFile command.

Applies to

Narrative Reporting

Required Roles

Service Administrator, Power User, User, Viewer

Users with Power User, User, and Viewer must be granted additional security through ACL

Usage

epmautomate importLibraryArtifact SOURCE_FILE [errorFile=ERROR_FILE.txt] [importFormat=Native|File] [importFolder=FOLDER_PATH] [ importPermission=true|false] [overwrite=true|false] where:
  • SOURCE_FILE is the name of the archive that contains the artifacts that are to be imported into the library. This file must be available in the inbox.
  • errorFile , optionally, is a unique name for the text file that will store import-related errors.
  • importFormat, optionally, is one of the following:
    • Native imports artifacts from a zip file created using the exportLibraryArtifactcommand with the exportFormat=Native option. This is the default value.
    • File imports a binary file.

    Note:

    You use the importSnapshot command to import library artifacts zip files (created using the exportLibraryArtifactcommand with the exportFormat=LCM option) into Financial Consolidation and Close, Planning, Planning Modules, or Tax Reporting environments.
  • importFolder, optionally, is the library location that will store the imported artifacts. Specify this path if this location is different than the Library (the default import location).
  • importPermission indicates whether to import access permissions set for the artifacts. Default is False.
  • overwrite identifies whether to overwrite identically named artifacts, if any, in the specified library location. Default is False, which means that the process will not import an artifact if an identically named artifact exists in the import location.

On completing the import, use the downloadFile command to download the error files to a local computer.

Examples

  • Import a file in its binary format:

    epmautomate importLibraryArtifact newReports.doc errorFile=report_imp_errors.txt importFormat=File importFolder="Library/My Reports" importPermission=true overwrite=true

  • Import artifacts from an exported zip file:

    epmautomate importLibraryArtifact newReports.zip errorFile=report_imp_errors.txt importFormat=Native importFolder="Library/My Reports" importPermission=true overwrite=true

  • Import reports into a Financial Consolidation and Close, Planning, Planning Modules, or Tax Reporting environment from an exported zip file:

    epmautomate importSnapshot newReports.zip