AssemblerResult

Assembler サービスが提供する invokeDDX 操作 操作の結果が格納される複雑なデータ型です。成功ドキュメント、DDX ファイルに指定されたドキュメント（PDF ドキュメント添付が指定されている場合はその添付を含む）、プロセスの過程で発生したスロー可能な例外、および監査リストが格納されます。

監査リストは、 Job Log データ項目を使用してアクセスされる document 値として提供されます。

failOnError データ項目（ AssemblerOptionSpec データ型を使用して渡される入力オプション）の設定によって、Assembler サービス操作の実行時に例外が発生した場合の処理が決まります。

  • failOnError データ項目を True （デフォルト）に設定しているときに例外が発生した場合、その例外がスローされます。スローされた例外がキャッチされた場合、その情報をジョブログから抽出できます。

  • failOnError データ項目を False に設定しているときに例外が発生した場合、その例外はスローされません。代わりに、操作は正常に完了し、 throwables データ項目から例外にアクセスしたり、ジョブログで例外を確認したりすることができます。複数の結果ブロックが存在し、その一部が成功し、一部が失敗した場合、 throwables データ項目と documents データ項目の両方に値が表示され、ジョブログで例外を確認することもできます。

DDX エレメントについて詳しくは、『 DDX Reference 』を参照してください。

Xpath 式を使用してアクセスできるデータについて詳しくは、 データ項目 を参照してください。

データ項目

AssemblerResult 変数に格納されるデータ項目です。

文書

DDX ファイルの結果ブロックで指定された成功ドキュメントが格納される string 値の map です。キーはドキュメントの論理名であり、値はドキュメントのファイル名です。

論理名は結果に応じて変わります。

  • 結果が単一のドキュメントである場合、 result 属性の値が論理名になります。例えば、DDX ファイルに <PDF result="doc1.pdf"> と指定されていた場合、論理名は doc1.pdf になります。

  • 結果が複数のドキュメント（ <PackageFiles> または <FileAttachments> 結果要素に基づく）である場合、パスが指定されていれば、名前の最後の部分、つまり最後のスラッシュ（/）に続く部分が論理ドキュメント名になります。例えば、指定されたドキュメントパスが /dirABC/ABC.pdf である場合、XPath 式 [documents] [@id='ABC.pdf'] をキーとして指定し、ドキュメント value を取得します。ここで、 [documents] は map 変数の名前です。

  • 結果が <PDFsFromBookmarks> 要素によるディスアセンブリから生成された複数のドキュメントである場合、 prefix 属性が論理名になります。

注意： 添付の論理名は Assembler サービスによって作成されます。 successfulDocumentNames データ項目から名前のリストにアクセスできます。

failedBlockNames

失敗した結果ブロックの名前が格納される string 値の list です。

jobLog

DDX の実行中に生成されたジョブログが格納される 文書 値です。

lastBatesNumber

最終ページ内でベイツナンバリングの数値で識別された数値部分を表す numeric 値です。

multipleResultsBlocks

結果ブロック名が格納される string 値の map です。各名前は、その結果ブロックによって生成されるドキュメント名のリストにマップされます。

numRequestedBlocks

DDX 内の結果ブロックの数を表す int 値です。

successfulBlockNames

成功した結果ブロックの名前が格納される string 値の list です。

successfulDocumentNames

成功したドキュメントの名前が格納される string 値の list です。

注意： Assembler サービスは、添付に対して一意の名前を作成します。この際、命名スキームとして [filename of source document]_attach.[page of attachment].[index of attachment on a page] が使用されます。

[file name of source document] は、次のルールに基づいています。

  • ソースドキュメントのファイル名です。URL が指定されている場合、URL 内の最後のスラッシュに続く最終セグメントが使用されます。例えば、URL が http://www.adobe.com/go/ABC.pdf の場合、ファイル名 ABC.pdf が使用されます。

  • DDX ファイルの PDF source 属性の最後のパスセグメントからのドキュメント名です。

[page of attachment] は、ソースドキュメント内で添付が表示されるページの番号です。例えば、添付が 7 ページに表示される場合、値は 0007 です。

[index of attachment on page] は、添付のインデックス番号です。この値は、複数の添付ファイルが同じページに表示される場合に重要になります。例えば、1 つのページに 2 つの添付が表示される場合、1 つ目の添付の値は 0001 になり、2 つ目の添付の値は 0002 になります。

例えば、PDF123.pdf という名前のソースドキュメントの先頭ページに 2 つの添付が表示され、3 ページ目に 1 つの添付が表示される場合、それぞれの添付の名前は PDF123.pdf_attach.0001.0001 、 PDF123.pdf_attach.0001.0002 および PDF123.pdf_attach.0003.0001 になります。

throwables

DDX の実行中に生成された例外が格納される string 値の map です。map のキーは、 failedBlockNames 属性内の結果ブロック名です。このデータ項目は、 failOnError データ項目の値を False に設定している場合にのみ使用できます。 failOnError データ項目は、 AssemberOptionSpec を使用して渡される入力オプションです。