exportLibraryDocument

Se aplica a

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

Roles necesarios

Administrador del servicio

Sintaxis

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

• ARTIFACT_PATH es la ubicación o el identificador único universal (UUID) del documento en la biblioteca Informes. Para exportar varios documentos, especifique una lista separada por comas de UUID o ubicaciones del documento.
• De manera opcional, jobName es el nombre del trabajo de exportación de documentos de biblioteca que se utilizará para exportar el documento. El nombre predeterminado del trabajo es Copy Artifact From Library.
• Opcionalmente, EXPORT_FILE es un nombre único para el archivo de exportación.

  Si utiliza exportFormat=ZIP, el archivo ZIP resultante utiliza este nombre. Asegúrese de utilizar la extensión .zip en este valor.

  Si utiliza exportFormat=file:

  • Para exportar un documento: el archivo de exportación se crea con este nombre si la extensión de archivo especificada coincide con la del documento.
  • Para exportar varios documentos: el comando ignora este valor y exporta cada documento con el nombre original.
• exportFormat, opcionalmente, es uno de los siguientes:
  • File exporta los documentos en el formato binario original (PDF, DOCX, Zip, JPEG, etc.) en el que están disponibles en la biblioteca. Cada archivo exportado se crea en el buzón de salida con el nombre original. Este es el valor predeterminado.
  • zip crea un archivo ZIP que contiene todos los documentos exportados en su formato binario original. Si no se especifica ningún valor para el parámetro opcional exportFile, el nombre de archivo zip se genera automáticamente con el nombre de usuario del usuario que ejecuta el comando y el registro de hora. El formato de nombre de archivo es nombreusuario_exported_artifacts_aaaaMMddHHmm.zip, por ejemplo, JDoe_exported_artifacts_202410201559.zip.
• De manera opcional, errorFile es un nombre único para el archivo en el que se almacenarán los errores relacionados con la exportación. No se creará ningún archivo de error si no especifica este valor.
• De manera opcional, overwrite controla si se debe sobrescribir un archivo con el mismo nombre situado actualmente en la ubicación de descarga. El valor predeterminado es false, que significa que el comando fallará si existe un archivo con el mismo nombre en el buzón de salida.

Ejemplos

• Exportar un documento:

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

• Exportar varios documentos:

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