exportLibraryDocument

Champ d'application

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

Rôles requis

Administrateur de service

Syntaxe

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false], où :

• ARTIFACT_PATH est l'emplacement ou l'identifiant unique universel (UUID) du document dans la bibliothèque Reports. Pour exporter plusieurs documents, spécifiez une liste d'UUID ou d'emplacements de document, séparés par des virgules.
• jobName (facultatif) est le nom du job d'export de document de bibliothèque à utiliser pour exporter le document. Le nom de job par défaut est Copy Artifact From Library.
• EXPORT_FILE (facultatif) est le nom unique du fichier d'export.

  Si vous utilisez exportFormat=ZIP, le fichier ZIP résultant utilise ce nom. Veillez à utiliser l'extension .zip dans cette valeur.

  Si vous utilisez exportFormat=file :

  • Export d'un document : le fichier d'export est créé avec ce nom si l'extension de fichier spécifiée correspond à celle du document.
  • Export de plusieurs documents : la commande ignore cette valeur et exporte chaque document en utilisant son nom d'origine.
• exportFormat (facultatif) est l'un des formats suivants :
  • File exporte les documents au format binaire d'origine (PDF, DOCX, ZIP, JPEG, etc.) auquel ils sont disponibles dans la bibliothèque. Chaque fichier exporté est créé dans la boîte d'envoi à l'aide de son nom d'origine. Il s'agit de la valeur par défaut.
  • zip crée un fichier ZIP contenant tous les documents exportés au format binaire d'origine. Si aucune valeur n'est spécifiée pour le paramètre facultatif exportFile, le nom du fichier ZIP est automatiquement généré à l'aide du nom de l'utilisateur qui exécute la commande et de l'horodatage. Le format du nom de fichier est username_exported_artifacts_yyyyMMddHHmm.zip. Par exemple, JDoe_exported_artifacts_202410201559.zip.
• errorFile (facultatif) est le nom unique du fichier qui stockera les erreurs liées à l'export. Aucun fichier d'erreurs n'est créé si vous n'indiquez pas cette valeur.
• overwrite (facultatif) détermine si un fichier portant le même nom existant dans l'emplacement de téléchargement par défaut doit être remplacé. La valeur par défaut est false, ce qui signifie que la commande échouera si un fichier portant le même nom existe dans la boîte d'envoi.

Exemples

• Export d'un document :

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

• Export de plusieurs 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