exportLibraryDocument

Exporta os documentos disponíveis na biblioteca de Reports para um arquivo.

É possível fazer download do arquivo exportado para um computador local usando o comando downloadFile.

Aplica-se a

Planning, Módulos do Planning, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning e Strategic Workforce Planning.

Funções Necessárias

Administrador de Serviço

Uso

epmautomate exportLibraryDocument ARTIFACT_PATH [jobName=JOB_NAME] [exportFile=FILE_NAME] [exportFormat=file|zip] [errorFile=FILE_NAME.log] [overWrite=true|false] em que:
  • ARTIFACT_PATH é o local ou o Identificador Exclusivo Universal (UUID) do documento na biblioteca de Reports. Para exportar vários documentos, especifique uma lista separada por vírgulas de UUIDs ou locais dos documentos.
  • jobName é um parâmetro opcional que identifica o nome do job de exportação de documento da biblioteca a ser usado para exportar o documento. O nome do job padrão é Copy Artifact From Library.
  • EXPORT_FILE é um parâmetro opcional que identifica o nome exclusivo do arquivo de exportação.

    Se estiver usando exportFormat=ZIP, o arquivo ZIP resultante usará esse nome. Você deve usar a extensão .zip nesse valor.

    Se estiver usando exportFormat=file:

    • Exportar um documento: O arquivo de exportação será criado com esse nome se a extensão de arquivo especificada corresponder à extensão do documento.
    • Exportar vários documentos: O comando ignora esse valor e exporta cada documento usando os nomes originais.
  • exportFormat, opcionalmente, é um dos seguintes:
    • File exporta os documentos no formato binário original (PDF, DOCX, Zip, JPEG e assim por diante) nos quais eles estão disponíveis na biblioteca. Cada arquivo exportado é criado na caixa de saída usando seu nome original. Esse é o valor padrão.
    • zip cria um arquivo ZIP contendo todos os documentos exportados no formato binário original. Se nenhum valor for especificado no parâmetro opcional exportFile, o nome do arquivo zip será gerado automaticamente usando o nome de usuário da pessoa que executou o comando e o timestamp. O formato do nome do arquivo é username_exported_artifacts_yyyyMMddHHmm.zip, como JDoe_exported_artifacts_202410201559.zip.
  • errorFile, opcionalmente, é um nome exclusivo para o arquivo que armazenará os erros relacionados à exportação. Nenhum arquivo de erro será criado se você não especificar esse valor.
  • overwrite, opcionalmente, controla se um arquivo com um nome idêntico atualmente no local de download padrão deve ser substituído. O padrão é false, o que significa que o comando falhará se existir um arquivo com um nome idêntico na caixa de saída.

Exemplos

  • Exportar um documento:

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

  • Exportar vários 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