exportLibraryDocument

適用対象

Planning、Planningモジュール、フリーフォーム、Financial Consolidation and Close、Tax Reporting、Enterprise Profitability and Cost Management、Sales PlanningおよびStrategic Workforce Planning。

必要な役割

サービス管理者

使用方法

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

• ARTIFACT_PATHは、レポート・ライブラリ内のドキュメントの場所またはUniversally Unique Identifier (UUID)です。複数のドキュメントをエクスポートするには、UUIDまたはドキュメントの場所のカンマ区切りリストを指定します。
• jobNameは、オプションで、ドキュメントのエクスポートに使用されるライブラリ・ドキュメント・エクスポート・ジョブの名前です。デフォルトのジョブ名はCopy Artifact From Libraryです。
• EXPORT_FILEは、オプションで、エクスポート・ファイルの一意の名前です。

  exportFormat=ZIPを使用している場合、生成されるZIPファイルはこの名前を使用します。この値には、.zip拡張子を使用してください。

  exportFormat=fileを使用している場合:

  • 1つのドキュメントをエクスポートする場合: 指定したファイル拡張子がドキュメントの拡張子と一致する場合、エクスポート・ファイルはこの名前で作成されます。
  • 多数のドキュメントをエクスポートする場合: コマンドはこの値を無視し、元の名前を使用して各ドキュメントをエクスポートします。
• exportFormatはオプションで、次のいずれかを使用します:
  • Fileでは、ライブラリで使用できる元のバイナリ形式(PDF、DOCX、Zip、JPEGなど)でドキュメントをエクスポートします。エクスポートされたファイルは、それぞれ元の名前を使用して送信ボックスに作成されます。これがデフォルト値です。
  • zipでは、エクスポートされたすべてのドキュメントを元のバイナリ形式で格納したZIPファイルが作成されます。exportFileオプション・パラメータに値が指定されていない場合は、コマンドを実行しているユーザーのユーザー名およびタイムスタンプを使用して、zipファイル名が自動的に生成されます。ファイル名の形式は、username_exported_artifacts_yyyyMMddHHmm.zipで、たとえば、JDoe_exported_artifacts_202410201559.zipのようになります。
• errorFileはオプションで、エクスポート関連のエラーを格納するファイルの一意の名前です。この値を指定していない場合、エラー・ファイルは作成されません。
• overwriteはオプションで、デフォルトのダウンロード場所に現在ある同じ名前のファイルを上書きするかどうかを制御します。デフォルトはfalseです。これは、送信ボックスに同じ名前のファイルが存在する場合、コマンドが失敗となることを意味します。

例

• 1つのドキュメントをエクスポートする場合:

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

• 複数のドキュメントをエクスポートする場合

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