文書情報取得処理

オペレーション名

文書情報取得

機能概要

Report Director Enterpriseにスプールされている文書情報を取得します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
取得区分 必須 使用不可 取得する文書の状態を選択します。
  • [すべて]:(デフォルト)
  • [未印刷]:
  • [印刷済み]:
  • [ごみ箱]:
 
対象設定(印刷可能)
項目名 必須/省略可 変数の使用 説明 備考
文書ステータス 必須 - 取得対象とする印刷可能状態の文書ステータスを指定します。  
文書ステータス/取得対象 省略可 - 各文書ステータスを取得対象に含めるかどうかを選択します。
  • [チェックあり]
    取得対象に含めます。
  • [チェックなし]
    取得対象に含めません。
  • ヘッダに表示されたチェックボックスを押下することで、一括操作を行うことができます。
文書ステータス/ステータス - - 文書ステータスを表示します。
  • [スプール完了]
  • [印刷完了]
  • [印刷中断]
  • [異常終了]
  • [印刷停止]
 
対象設定(印刷不可)
項目名 必須/省略可 変数の使用 説明 備考
文書ステータス 必須 - 取得対象とする印刷不可状態の文書ステータスを指定します。  
文書ステータス/取得対象 省略可 - 各文書ステータスを取得対象に含めるかどうかを選択します。
  • [チェックあり]
    取得対象に含めます。
  • [チェックなし]
    取得対象に含めません。
  • ヘッダに表示されたチェックボックスを押下することで、一括操作を行うことができます。
文書ステータス/ステータス - - 文書ステータスを表示します。
  • [スプール中]:
  • [スプール失敗]:(デフォルト)
  • [印刷待ち]:
  • [印刷中]:
  • [中断中]:
  • [印刷データ作成中]:
  • [印刷データ作成完了]:
  • [準備中]:
  • [テスト印刷中]:
  • [プリンター準備待ち]:
  • [用紙変更待ち]:
  • [状態不明]:(デフォルト)
 
絞り込み条件設定
項目名 必須/省略可 変数の使用 説明 備考
文書名 省略可 使用可 文書名を入力します。
  • ワイルドカード(「*」)が使用できます。
  • [その他条件設定][標準カラム]を使用して、同様の条件を指定することができます。
スプール開始時刻 From 省略可 使用可 文書がスプールされた日時の範囲(From)を入力します。
  • [その他条件設定][標準カラム]を使用して、同様の条件を指定することができます。
  • 使用できるフォーマットについては、「使用できる日付フォーマット」を参照してください。
スプール開始時刻 To 省略可 使用可 文書がスプールされた日時の範囲(To)を入力します。
  • [その他条件設定][標準カラム]を使用して、同様の条件を指定することができます。
  • 使用できるフォーマットについては、「使用できる日付フォーマット」を参照してください。
その他条件設定
項目名 必須/省略可 変数の使用 説明 備考
条件の組み合わせに使用する論理演算子 必須 使用不可 [標準カラム][ユーザー定義カラム]で作成した条件を結合する論理演算子を指定します。
  • [AND]:(デフォルト)
    取得条件を「AND」で結合します。
  • [OR]:
    取得条件を「OR」で結合します。
 
標準カラム 省略可 - 文書情報を標準カラムで絞り込む詳細条件を指定します。

各条件は以下のボタンで操作することができます。
  • [追加]:
    条件を追加します。
  • [上へ]:
    選択している条件の順序を一つ上に上げます。
  • [下へ]:
    選択している条件の順序を一つ下に下げます。
  • [削除]:
    条件を削除します。
 
標準カラム/カラム名 必須 使用不可 条件を設定する標準カラムの項目を選択します。
  • [文書管理番号]:(デフォルト)
  • [文書名]:
  • [コンピューター名]:
  • [ユーザー名]:
  • [印刷プリンター名]:
  • [印刷プリンターグループ名]:
  • [スプール開始時刻]:
  • [スプール終了時刻]:
  • [印刷開始時刻]:
  • [印刷終了時刻]:
  • [最終更新時刻]:
  • [ページ数]:
  • [未印刷ページ数]:
  • [ステータス]:
  • [様式ファイル名]:
  • [用紙サイズ]:
  • [用紙方向]:
  • [綴りページ数]:
  • [部数]:
  • [用紙コード]:
  • [出力ファイル名]:
 
標準カラム/比較演算子 必須 使用不可 [カラム名]で選択した項目と、[値]に入力した値を結合する比較演算子を選択します。
  • [=]:(デフォルト)
  • [like]:
  • [!=]:
  • [>]:
  • [<]:
  • [>=]:
  • [<=]:
  • [like]演算子については、[カラム名]に以下いずれかの項目を選択した場合に使用できます。
    • [文書名]
    • [コンピューター名]
    • [ユーザー名]
    • [印刷プリンター名]
    • [印刷プリンターグループ名]
    • [様式ファイル名]
    • [用紙コード]
    • [出力ファイル名]
標準カラム/値 省略可 使用可 [カラム名]で選択した項目の取得条件となる値を入力します。
  • [比較演算子][like]を選択した場合、「_」(アンダースコア:任意の一文字にマッチ)、「%」(パーセント記号:0文字以上の任意の文字にマッチ)を使用することができます。
    例:「_注%」(「発注書」、「受注伝票」などにマッチ)
  • [カラム名]に以下いずれかの項目を選択した場合に使用できるフォーマットについては、「使用できる日付フォーマット」を参照してください。
    • [スプール開始時刻]
    • [スプール終了時刻]
    • [印刷開始時刻]
    • [印刷終了時刻]
    • [最終更新時刻]
ユーザー定義カラム 省略可 - 文書情報をユーザー定義カラムで絞り込む詳細条件を指定します。

各条件は以下のボタンで操作することができます。
  • [追加]:
    条件を追加します。
  • [上へ]:
    選択している条件の順序を一つ上に上げます。
  • [下へ]:
    選択している条件の順序を一つ下に下げます。
  • [削除]:
    条件を削除します。
 
ユーザー定義カラム/カラム名 必須 使用可 条件を設定するユーザー定義カラムの項目を選択または入力します。  
ユーザー定義カラム/比較演算子 必須 使用不可 [カラム名]で選択または入力した項目と、[値]に入力した値を結合する比較演算子を選択します。
  • [=]:(デフォルト)
  • [like]:
  • [!=]:
  • [>]:
  • [<]:
  • [>=]:
  • [<=]:
 
ユーザー定義カラム/値 省略可 使用可 [カラム名]で選択した項目の取得条件となる値を入力します。
  • [比較演算子][like]を選択した場合、「_」(アンダースコア:任意の一文字にマッチ)、「%」(パーセント記号:0文字以上の任意の文字にマッチ)を使用することができます。
    例:「_注%」(「発注書」、「受注伝票」などにマッチ)
プロパティアクション
項目名 説明 備考
ユーザー定義カラム一覧の更新 [接続先]で指定したReport Director Enterpriseサーバに登録されているユーザー定義カラムを取得して、[ユーザー定義カラム/カラム名]で選択できるようにします。
  • [ソート設定]タブの[ユーザー定義カラム]に表示されるユーザー定義カラム一覧も同時に更新されます。
ソート設定
項目名 必須/省略可 変数の使用 説明 備考
カラム種別 必須 使用不可 ソートする項目の種類を選択します。
  • [標準カラムから選択]:(デフォルト)
    一覧から標準カラムの項目を選択します。
  • [ユーザー定義カラムから選択]:
    一覧からユーザー定義カラムの項目を選択します。
 
標準カラム 必須 使用不可 ソートする標準カラムの項目を選択します。
  • [文書管理番号]:(デフォルト)
  • [文書名]:
  • [コンピューター名]:
  • [ユーザー名]:
  • [印刷プリンター名]:
  • [印刷プリンターグループ名]:
  • [スプール開始時刻]:
  • [スプール終了時刻]:
  • [印刷開始時刻]:
  • [印刷終了時刻]:
  • [最終更新時刻]:
  • [ページ数]:
  • [未印刷ページ数]:
  • [ステータス]:
  • [様式ファイル名]:
  • [用紙サイズ]:
  • [用紙方向]:
  • [綴りページ数]:
  • [部数]:
  • [用紙コード]:
  • [出力ファイル名]:
[カラム種別][標準カラムから選択]を選択した場合、表示されます。
ユーザー定義カラム 必須 使用可 ソートするユーザー定義カラムの項目を選択または入力します。 [カラム種別][ユーザー定義カラムから選択]を選択した場合、表示されます。
ソート順序 必須 使用不可 ソート順序を選択します。
  • [昇順並べ替え]:(デフォルト)
    昇順でソートします。
  • [降順並べ替え]:
    降順でソートします。
プロパティアクション
項目名 説明 備考
ユーザー定義カラム一覧の更新 [接続先]で指定したReport Director Enterpriseサーバに登録されているユーザー定義カラムを取得して、[ユーザー定義カラム]で選択できるようにします。
  • [その他条件設定]タブの[ユーザー定義カラム/カラム名]に表示されるユーザー定義カラム一覧も同時に更新されます。
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<documents>
  <document>
    <canAbort>中断可能かどうか</canAbort>
    <canChangePrinter>印刷先変更可能かどうか</canChangePrinter>
    <canDelete>削除可能かどうか</canDelete>
    <canCopy>コピー可能かどうか</canCopy>
    <canFilePrint>ファイル印刷可能かどうか</canFilePrint>
    <canMoveToTrash>ごみ箱へ移動可能かどうか</canMoveToTrash>
    <canPrint>印刷可能かどうか</canPrint>
    <canRestart>再開可能かどうか</canRestart>
    <canRestore>元に戻せるかどうか</canRestore>
    <canStop>停止可能かどうか</canStop>
    <canView>ビュー可能かどうか</canView>
    <computerName>コンピューター名</computerName>
    <docName>文書名</docName>
    <docNum>文書管理番号</docNum>
    <formCopyCount>様式ファイルに指定されている部数</formCopyCount>
    <formFileName>様式ファイル名</formFileName>
    <formPaperCode>様式ファイルに指定されている用紙コード</formPaperCode>
    <formPaperOrientation>様式ファイルに指定されている用紙方向</formPaperOrientation>
    <formPaperOrientationName>様式ファイルに指定されている用紙方向名</formPaperOrientationName>
    <formPaperSize>様式ファイルに指定されている用紙サイズ</formPaperSize>
    <formPaperSizeName>様式ファイルに指定されている用紙サイズ名</formPaperSizeName>
    <formPrintCount>綴りページ数</formPrintCount>
    <outputFileName>PDFなどのファイル系出力のファイル名</outputFileName>
    <pageCount>ページ数</pageCount>
    <paperChangeMessage>用紙変更メッセージ</paperChangeMessage>
    <printed>印刷済み文書かどうか</printed>
    <printedPageCount>印刷済みページ数</printedPageCount>
    <printerName>印刷プリンター名</printerName>
    <spoolStartTime>スプール開始日時</spoolStartTime>
    <spoolEndTime>スプール終了日時</spoolEndTime>
    <printStartTime>印刷開始日時</printStartTime>
    <printEndTime>印刷終了日時</printEndTime>
    <enablePrinterKinds>
      <enablePrinterKind>印刷可能なPDL</enablePrinterKind>
         :
    </enablePrinterKinds>
    <spoolPageCount>スプールページ数</spoolPageCount>
    <status>ステータス</status>
    <statusString>ステータス名称</statusString>
    <stopping>停止中かどうか</stopping>
    <trash>ごみ箱文書かどうか</trash>
    <unprintedPageCount>未印刷ページ数</unprintedPageCount>
    <updateTime>最終更新時刻</updateTime>
    <userColumns>
      <userColumn>
        <name>ユーザー定義カラム名</name>
        <value>ユーザー定義カラム値</value>
      </userColumn>
         :
    </userColumns>
    <userName>ユーザー名</userName>
    <canSpecifyPageRange>印刷時ページ範囲指定の制限</canSpecifyPageRange>
    <srcDocNum>コピー元文書管理番号</srcDocNum>
    <printerGroupName>印刷プリンターグループ名</printerGroupName>
  </document>
</documents>
要素名 属性名 説明 備考
documents - 文書情報リストを表す要素です。  
document - 文書情報を表す要素です。  
canAbort - 中断可能かどうかを表す要素です。  
canChangePrinter - 印刷先変更可能かどうかを表す要素です。  
canDelete - 削除可能かどうかを表す要素です。  
canCopy - コピー可能かどうかを表す要素です。
canFilePrint - ファイル印刷可能かどうかを表す要素です。  
canMoveToTrash - ごみ箱へ移動可能かどうかを表す要素です。  
canPrint - 印刷可能かどうかを表す要素です。  
canRestart - 再開可能かどうかを表す要素です。  
canRestore - 元に戻せるかどうかを表す要素です。  
canStop - 停止可能かどうかを表す要素です。  
canView - ビュー可能かどうかを表す要素です。  
computerName - コンピューター名を表す要素です。  
docName - 文書名を表す要素です。  
docNum - 文書管理番号を表す要素です。  
formCopyCount - 様式ファイルに指定されている部数を表す要素です。  
formFileName - 様式ファイル名を表す要素です。  
formPaperCode - 様式ファイルに指定されている用紙コードを表す要素です。  
formPaperOrientation - 様式ファイルに指定されている用紙方向を表す要素です。  
formPaperOrientationName - 様式ファイルに指定されている用紙方向名を表す要素です。  
formPaperSize - 様式ファイルに指定されている用紙サイズを表す要素です。  
formPaperSizeName - 様式ファイルに指定されている用紙サイズ名を表す要素です。  
formPrintCount - 綴りページ数を表す要素です。  
outputFileName - PDFなどのファイル系出力のファイル名を表す要素です。  
pageCount - ページ数を表す要素です。  
paperChangeMessage - 用紙変更メッセージを表す要素です。  
printed - 印刷済み文書かどうかを表す要素です。  
printedPageCount - 印刷済みページ数を表す要素です。  
printerName - 印刷プリンター名を表す要素です。  
spoolStartTime - スプール開始日時を表す要素です。
  • DataSpiderに設定されている日付フォーマットに従って出力されます。日付フォーマットに関する詳細は「データ型」を参照してください。
spoolEndTime - スプール終了日時を表す要素です。
  • DataSpiderに設定されている日付フォーマットに従って出力されます。日付フォーマットに関する詳細は「データ型」を参照してください。
printStartTime - 印刷開始日時を表す要素です。
  • DataSpiderに設定されている日付フォーマットに従って出力されます。日付フォーマットに関する詳細は「データ型」を参照してください。
printEndTime - 印刷終了日時を表す要素です。
  • DataSpiderに設定されている日付フォーマットに従って出力されます。日付フォーマットに関する詳細は「データ型」を参照してください。
enablePrinterKinds - 印刷可能なPDLのリストを表す要素です。
enablePrinterKind - 印刷可能なPDLを表す要素です。
spoolPageCount - スプールページ数を表す要素です。  
status - ステータスを表す要素です。  
statusString - ステータス名称を表す要素です。  
stopping - 停止中かどうかを表す要素です。  
trash - ごみ箱文書かどうかを表す要素です。  
unprintedPageCount - 未印刷ページ数を表す要素です。  
updateTime - 最終更新時刻を表す要素です。
  • DataSpiderに設定されている日付フォーマットに従って出力されます。日付フォーマットに関する詳細は「データ型」を参照してください。
userColumns - ユーザー定義カラムリストを表す要素です。  
userColumn - ユーザー定義カラムを表す要素です。  
name - ユーザー定義カラム名を表す要素です。  
value - ユーザー定義カラム値を表す要素です。  
userName - ユーザー名を表す要素です。  
canSpecifyPageRange - 印刷時ページ範囲指定の制限を表す要素です。  
srcDocNum - コピー元文書管理番号を表す要素です。
  • コピーされた文書でない場合、-1が格納されます。
printerGroupName - 印刷プリンターグループ名を表す要素です。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
count 取得したデータの件数が格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • バージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • バージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • バージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

RDE UDKのログについて

Report Director Enterpriseアダプタで使用しているRDE UDKのログは、$DATASPIDER_HOME/server/logs下にrde.logというファイル名で出力されます。
RDE UDKのログは2048KBを超えた場合に新規ログファイルが生成され、古いファイルは5つ保持されます。

使用できる日付フォーマット

日付型のデータを入力する各項目の入力値は、以下いずれかの日付フォーマットに則る必要があります。

日付型のデータを入力する項目

日付フォーマット

日付フォーマット入力例備考
yyyy-MM-dd'T'HH:mm:ss.SSSZZ2015-01-23T12:34:56.789+0900 
yyyy/MM/dd HH:mm:ss.SSS2015/01/23 12:34:56.789 
yyyy/MM/dd HH:mm:ss2015/01/23 12:34:56ミリ秒を「.000」として扱います。
yyyy/MM/dd2015/01/23時分秒ミリ秒を「00:00:00.000」として扱います。
yyyy-MM-dd HH:mm:ss.SSS2015-01-23 12:34:56.789 
yyyy-MM-dd HH:mm:ss2015-01-23 12:34:56ミリ秒を「.000」として扱います。
yyyy-MM-dd2015-01-23時分秒ミリ秒を「00:00:00.000」として扱います。
MM/dd/yyyy HH:mm:ss.SSS01/23/2015 12:34:56.789 
MM/dd/yyyy HH:mm:ss01/23/2015 12:34:56ミリ秒を「.000」として扱います。
MM/dd/yyyy01/23/2015時分秒ミリ秒を「00:00:00.000」として扱います。
MM-dd-yyyy HH:mm:ss.SSS01-23-2015 12:34:56.789 
MM-dd-yyyy HH:mm:ss01-23-2015 12:34:56ミリ秒を「.000」として扱います。
MM-dd-yyyy01-23-2015時分秒ミリ秒を「00:00:00.000」として扱います。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
リソースの必須項目が設定されていません。:<プロパティ名>
[接続先]に選択されたリソースの必須項目が設定されていません。 リソースの必須項目を設定してください。
RdConnectException
データベースの接続に失敗しました。
Report Director Enterpriseで使用しているデータベースへの接続に失敗しました。 Report Director Enterpriseで使用しているデータベースの再起動や、最大接続数の変更を行うなど、データベースに接続可能な状態にしてください。