Skip to main content

7-6　Report Director Enterpriseに関する関数

Universal Connect/Xで指定可能な、RDEに関する関数およびその指定方法について説明します。これらの関数はRDEと連携する場合に使用でき、一部の関数を除き1スプール文書あたり一度実行します。

各引数の詳細は『SVF Java PRODUCTS API関数 リファレンスマニュアル』の「3-9　Report Director Enterprise使用時の関数」を参照してください。

注意

SVF Cloudで出力する場合は、Report Director Enterpriseと連携できません。

関数名

機能

SVF Cloud連携時の使用可否

VrSetComputer

コンピューター名の指定

12517642_12518003.png

VrSetOutputPrinter

出力プリンター名の指定

12517642_12518003.png

VrSetUserColumn

ユーザー定義カラムへのデータ登録

12517642_12518003.png

VrSetDocAttribute=Stop=?

スプール文書の印刷停止（*1）

12517642_12518003.png

VrSetDocAttribute=CopiesCollate=?

部単位印刷指定（*1）

12517642_12518003.png

VrSetDocAttribute=AutoPrintMode=?

データの受け渡し方法（*1）

12517642_12518003.png

VrSetDocAttribute=ValidDays=?

有効日数の指定（*1）

12517642_12518003.png

VrSetDocAttribute=ReprintForm=?

再印刷様式名の指定（*1）

12517642_12518003.png

VrSetDocAttribute=EnablePrinterKind=xxx

印刷可能なプリンター機種を指定（*1）

12517642_12518003.png

VrSetDocAttribute=EnablePrintPageRange=n

印刷実行時、印刷ページ範囲指定により部分ページ指定が可能かどうかを設定（*1）

12517642_12518003.png

VrSetDocAttribute=EnableView=n

スプールされた文書がビュー可能かどうかを指定（*1）

12517642_12518003.png

VrSetPrintPriority

優先順位の指定

12517642_12518003.png

VrSetOutputVPrinter

文書のスプール後、即時印刷するプリンターグループ名を指定します。

12517642_12518003.png

VrSetOutputVPrinter2

印刷先のプリンターグループ名を指定してスプールします。スプールは行いますが印刷せずに停止します。

12517642_12518003.png

*1 複数のVrSetDocAttribute関数を併用して指定する場合は、カンマ区切りで指定します。

例 1. 例
VrSetDocAttribute=ReprintForm=ReprintForm1,ValidDays=1


VrSetComputer

機能

コンピューター名の指定

関数

  • CSV

    VrSetComputer=con

  • XML

    <document computername="con">

引数

  • con

    コンピューター名

説明

スプール元のコンピューター名を指定します。

使用例

  • CSV

    VrSetComputer=Demo-server

  • XML

    <document computername="Demo-server">

VrSetOutputPrinter

機能

出力プリンター名の指定

関数

  • CSV

    VrSetOutputPrinter=printer

  • XML

    <document outputprinter="printer">

引数

  • printer

    出力プリンター名

説明

自動印刷先のプリンター名を指定します。RDE環境設定画面の［プリンター］タブで登録されているプリンター名を指定します。出力プリンター名は複数指定できます。

使用例

  • CSV

    VrSetOutputPrinter=PRINTER1

  • XML

    <document outputprinter="PRINTER1">

VrSetUserColumn

機能

ユーザー定義カラムへのデータ登録

関数

  • CSV

    VrSetUserColumn=key,val

  • XML

    <document usercolumn="key,val">

引数

  • key

    項目名

  • val

    値

説明

動作設定の［文書カラム］で設定した［項目名］と［値］を変更する場合に使用し、RDE環境設定［カラム設定］のユーザー定義カラムにデータを登録します。複数回の指定が可能で、データファイル内で指定された［項目名］と［値］を蓄積しデータを登録します。1つの［項目名］に対して複数の［値］を指定しないでください。

XMLで複数回コマンドを指定する場合は、usercolumn=の後に、コマンド引数を制御文字「|」で区切って指定します。

例 2. 例
<document usercolumn="DEFINITION1,配布先1|DEFINITION2,配布先2|DEFINITION3,配布先3">


使用例

  • CSV

    VrSetUserColumn=DEFINITION1,配布先1

  • XML

    <document usercolumn="DEFINITION1,配布先1">

VrSetDocAttribute=Stop=?

機能

スプール文書の印刷停止

関数

  • CSV

    VrSetDocAttribute=Stop=n

  • XML

    <document docattribute="stop=n">

引数

  • 0

    停止しません（デフォルト）

  • 1

    停止します

説明

スプール文書の印刷処理を停止します。自動印刷と併用時にのみ有効です。

使用例

  • CSV

    VrSetDocAttribute=Stop=1

  • XML

    <document docattribute="stop=1">

VrSetDocAttribute=CopiesCollate=?

機能

部単位印刷指定

関数

  • CSV

    VrSetDocAttribute=CopiesCollate=n

  • XML

    <document docattribute="CopiesCollate=n">

引数

  • 0

    部単位で印刷しません（デフォルト）

  • 1

    部単位で印刷します

説明

部単位での印刷を指定します。自動印刷と併用時にのみ有効です。

使用例

  • CSV

    VrSetDocAttribute=CopiesCollate=1

  • XML

    <document docattribute="CopiesCollate=1">

VrSetDocAttribute=AutoPrintMode=?

機能

データの受け渡し方法

関数

  • CSV

    VrSetDocAttribute=AutoPrintMode=n

  • XML

    <document docattribute="AutoPrintMode=n">

引数

  • 0

    スプールデータを受け取りながらSVF実行部を実行します

  • 1

    スプールデータを受け取り終えてからSVF実行部を実行します（デフォルト）

説明

スプールデータを受け取りながらSVF実行部を実行してデータ生成をするか、スプールデータをすべて受け取り終えてから、SVF実行部を実行してデータ生成するかを指定します。スプールデータを受け取り終えてからSVF実行部を実行すると、総ページ数のカウントができます。これにより 総ページ数の出力、部単位での印刷ができます。自動印刷と併用する際にのみ設定が有効です。

VrSetDocAttribute=AutoPrintMode=0を指定している文書でも、RDEユーティリティから手動で印刷（再印刷）すると「総ページ数」が出力されます。

使用例

  • CSV

    VrSetDocAttribute=AutoPrintMode=1

  • XML

    <document docattribute="AutoPrintMode=1">

VrSetDocAttribute=ValidDays=?

機能

有効日数の指定

関数

  • CSV

    VrSetDocAttribute=ValidDays=n

  • XML

    <document docattribute="ValidDays=n">

引数

  • n

    文書の有効日数

説明

スプール時に文書の有効日数を指定します。指定された日数を過ぎたスプール文書は自動的に削除されます。

スプール時に有効日数を指定した文書は、定期処理またはコマンドでは削除されません。

  • スプール時に指定した有効日数を超えたかどうかの判定は、定期処理またはコマンド実行時に行われます。

  • 削除の対象となる日付とステータスは、定期処理の自動削除と同様です。

    • 未印刷文書の場合

      対象となる日付: スプール終了日時

      対象となるステータス: スプール中、印刷中、印刷待ち以外

    • 印刷済み文書の場合

      対象となる日付: 印刷終了日時

      対象となるステータス: スプール中、印刷中、印刷待ち以外

    • ごみ箱内文書の場合

      対象となる日付: 最終更新日付（ごみ箱に移動した日時）

      対象となるステータス: すべて

使用例

スプール後、1日を過ぎた文書を自動的に削除する場合は、次のように設定します。

  • CSV

    VrSetDocAttribute=ValidDays=1

  • XML

    <document docattribute="ValidDays=1">

VrSetDocAttribute=ReprintForm=?

機能

再印刷様式名の指定

関数

  • CSV

    VrSetDocAttribute=ReprintForm=xmlname

  • XML

    <document docattribute="form=xmlname">

引数

  • xmlname

    再印刷様式名

説明

スプール時に文書ごとの再印刷様式を指定します。

再印刷用のXML様式ファイルは、XML様式ファイル（ビットマップを含む）の実体ファイルを指定のディレクトリに、指定の拡張子で置いておく必要があります。

%FIT_PRODUCTS_BASE%¥rdjava¥rdinfo¥reportdirector.properties内の値で、指定ディレクトリおよび拡張子を変更します。

BannerFile.Dir=C:\SVFJP\rdjava\rdinfo\reprint
ReprintFormFile.FileName=*.xml
ReprintFormFile.Encoding=MS932

文書に指定された再印刷様式ファイルが存在しない場合は、再印刷でなくても「異常終了」と処理されます。大文字小文字も区別します。

使用例

再印刷時に、XML様式ファイル「reprintform1」を文書にマージして出力する場合は、次のように設定します。

  • CSV

    VrSetDocAttribute=ReprintForm=reprintform1

  • XML

    <document docattribute="form=reprintform1">

VrSetDocAttribute=EnablePrinterKind=xxx

機能

印刷可能なプリンター機種を指定

関数

  • CSV

    VrSetDocAttribute=EnablePrinterKind=xxx

  • XML

    <document docattribute="EnablePrinterKind=xxx">

引数

  • xxx　プリンター機種名

    複数指定する場合は「|」（縦線）で区切ります。

説明

Report Director Enterpriseにスプールする文書の印刷が可能なプリンター機種を指定します。

指定可能なプリンター機種の詳細は、『Report Director Enterpriseユーザーズマニュアル』の「6-1-5　プリンター管理コマンド」を参照してください。

使用例

  • CSV

    VrSetDocAttribute=EnablePrinterKind=LIPS4SECURITY|RPCSSECURITY

  • XML

    <document docattribute="EnablePrinterKind=LIPS4SECURITY|RPCSSECURITY">

VrSetDocAttribute=EnablePrintPageRange=n

機能

印刷実行時、印刷ページ範囲指定により部分ページ指定が可能かどうかを設定

関数

  • CSV

    VrSetDocAttribute=EnablePrintPageRange=n

  • XML

    <document docattribute="EnablePrintPageRange=n">

引数

  • n

    • 0: 部分ページ指定可能（デフォルト）

    • 1: 部分ページ指定不可

説明

Report Director Enterpriseユーティリティから印刷実行時、印刷ページ範囲指定により部分ページ指定可能かどうかを設定します。

使用例

  • CSV

    VrSetDocAttribute=EnablePrintPageRange=1

  • XML

    <document docattribute="EnablePrintPageRange=1">

VrSetDocAttribute=EnableView=n

機能

スプールされた文書がビュー可能かどうかを指定

関数

  • CSV

    VrSetDocAttribute=EnableView=n

  • XML

    <document docattribute="EnableView=n">

引数

  • n

    • 0: ビュー可能（デフォルト）

    • 1: ビュー不可

説明

Report Director Enterpriseユーティリティでスプール文書をビュー可能とするかどうかを設定します。

使用例

  • CSV

    VrSetDocAttribute=EnableView=1

  • XML

    <document docattribute="EnableView=1">

VrSetPrintPriority

機能

優先順位の指定

関数

  • CSV

    VrSetPrintPriority=priority

  • XML

    <document printpriority="priority">

引数

  • priority

    • High: 高

    • Medium: 中（デフォルト）

    • Low: 低

説明

印刷文書ごとに優先順位を付けます。

優先順位はスプール時に設定し、優先順位が高いものから順番に印刷されます。

使用例

  • CSV

    VrSetPrintPriority=High

  • XML

    <document printpriority="High">

VrSetOutputVPrinter

機能

文書のスプール後、即時印刷するプリンターグループ名を指定します。

関数

  • CSV

    VrSetOutputVPrinter=group

  • XML

    <document outputvprinter="group">

引数

  • group

    出力プリンターグループ名

説明

RDEに文書をスプール後、即時印刷するプリンターグループ名（RDE上で登録したプリンターグループ名）を指定します。

プリンターグループに登録されたプリンターで自動印刷する場合に使用します。VrSetOutputPrinter APIとVrSetOutputVPrinter2 API との併用はできません。

使用例

  • CSV

    VrSetOutputVPrinter=GROUP1

  • XML

    <document outputvprinter="GROUP1">

VrSetOutputVPrinter2

機能

印刷先のプリンターグループ名を指定してスプールします。スプールは行いますが印刷せずに停止します。

関数

  • CSV

    VrSetOutputVPrinter2=group

  • XML

    <document outputvprinter2="group">

引数

  • group

    出力プリンターグループ名

説明

印刷するプリンターグループ名（RDE上で登録したプリンターグループ名）を指定し、RDEに文書をスプールします。

スプール完了後は印刷せずに停止します。

ユーティリティから印刷ダイアログを開くと、プリンターグループが選択された状態になるため、印刷先を選択する必要がありません。

存在しないプリンターグループを指定した場合は、スプール時にエラーになりません。

VrSetOutputPrinter APIとVrSetOutputVPrinter API との併用はできません。

使用例

  • CSV

    VrSetOutputVPrinter2=GROUP1

  • XML

    <document outputvprinter2="GROUP1">

: