exportLibraryDocument

Esegue l'esportazione in un file dei documento disponibile nella libreria dei report.

È possibile scaricare il file esportato in un computer locale utilizzando il comando downloadFile.

Si applica a

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

Ruoli necessari

Amministratore servizi

Utilizzo

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false] dove:
  • ARTIFACT_PATH è la posizione o l'Identificativo univoco universale (UUID) del documento nella libreria dei report. Per esportare più documenti, specificare in un elenco separato da virgole gli UUID o le posizioni dei documenti.
  • jobName (facoltativo) è il nome del job di esportazione del documento della libreria da usare per esportare il documento. Il nome predefinito del job è Copy Artifact From Library.
  • EXPORT_FILE (facoltativo) è un nome univoco del file di esportazione.

    Se si utilizza exportFormat=ZIP, il file ZIP risultante utilizza questo nome. In questo valore, è necessario utilizzare l'estensione .zip.

    Se si utilizza exportFormat=file:

    • Esportazione di un documento: il file di esportazione viene creato con questo nome, se l'estensione del file specificata corrisponde a quella del documento.
    • Esportazione di più documenti: il comando ignora questo valore ed esegue l'esportazione di ogni documento utilizzando il suo nome originale.
  • exportFormat (facoltativo) può essere impostato su uno dei valori elencati di seguito.
    • File esegue l'esportazione dei documenti nel formato binario originale (PDF, DOCX, Zip, JPEG e così via) in cui sono disponibili all'interno della libreria. Ogni file esportato viene creato nella cartella outbox utilizzando il suo nome originale. Questo è il valore predefinito.
    • zip crea un file ZIP contenente tutti i documenti esportati nel formato binario originale. Se non viene specificato alcun valore per il parametro facoltativo exportFile, il nome del file zip viene generato automaticamente utilizzando il nome utente dell'utente che esegue il comando e l'indicatore di data/ora. Il formato del nome file è username_exported_artifacts_yyyyMMddHHmm.zip, ad esempio, JDoe_exported_artifacts_202410201559.zip.
  • errorFile (facoltativo) è un nome univoco del file in cui verranno memorizzati gli errori relativi all'esportazione. Se non si specifica questo valore, non verranno creati file di errore.
  • overwrite, facoltativo, controlla se nella posizione di download predefinita è presente un file con lo stesso nome da sovrascrivere. Il valore predefinito è false, che impedisce il completamento del comando se nella cartella outbox è presente un file con lo stesso nome.

Esempi

  • Esportazione di un documento:

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

  • Esportazione di più documenti

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