rde utility developers kit - wingarc-support.comrde utility developers...

はじめに

RDE Uti l ity Developers KIT をご購入いただき、まことにありがとうございます。

RDE Uti l ity Developers KIT は、 Report Director Enterprise サーバの「 Report

Director Enterprise ユーティリティ」の機能をユーザアプリケーションに組み込むための

ライブラリ製品です。Report Director Enterprise サーバへのログイン・ログアウト、スプ

ール文書情報の取得、サーバプリンタ情報の取得、印刷の実行・中断などの処理機

能を備えたアプリケーションの開発が可能となります。

本マニュアルでは、RDE Uti l ity Developers KIT を使用する上で必要な Java クラスラ

イブラリの設定方法、使用方法について掲載しています。

＊本マニュアルに記載されている会社名、商品名は各社の商標または登録商標です。

ii

1 製品概要 1

Ver.8.0 からの新機能 .................................................. ........................................... 5

動的コメントの出力... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

スプール済みのページ数の取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Ver.8.0 で仕様変更されたメソッド... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

ファイル構成 ......................................................... .................................................... 7

動作環境 ............................................................... ................................................... 7

2 セットアップ 8

クラスライブラリのセットアップ ................................................ ................................ 8

クラスライブラリ側オプション................................................. .................................. 8

データベースへの最大接続数について.............................................. .................. 11

バージョンの確認....................................................... ............................................. 11

3 サンプルプログラムの実行 12

準備 ............................................................. ........................................................... 13

グループとユーザの登録 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

文書のスプール ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

サンプルファイルのセット ................................................... .................................... 15

コンパイルの実行 ....................................................... ............................................ 16

プログラムの実行 ....................................................... ............................................ 16

サンプルプログラム ...................................................... .......................................... 19

ユーザ情報取得と、ユーザ情報の変更と更新 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

スプール文書情報の取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

ごみ箱からの文書の削除 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

サーバプリンタ情報の取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

スプール文書のサーバプリンタからの出力 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

動的コメント出力 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

プリンタキュー情報の取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

プリンタキュー優先順位の変更 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

サーバプリンタプロパティの変更... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

テスト印刷 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

プリンタの停止／再開 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

複数の接続先 RDE サーバの切り替え ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

サーバプリンタのステータス手動取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

停止文書の印刷先変更 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

ユーザパスワード有効期限の取得・ユーザパスワードの有効期限の警告状態を取得 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

ユーザパスワードの変更... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

データベース接続プーリングの解放 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

4 クラスライブラリの内容 41

階層ツリーとクラスの概要 ................................................... .................................. 41

iii

5 Web サービス版の使用 42

システム要件 ......................................................... ................................................. 42

Web サービス版 RDE UDK のセットアップ ......................................... ................. 43

API 利用の準備 ....................................................... .............................................. 44

セッションの利用 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

日付型フィールドの特殊フィールド... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

同期と非同期呼び出し ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

タイムアウト設定について ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

サンプルプログラム ...................................................... .......................................... 46

C#の場合 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

VisualBasic.Net の場合 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

API 関数 .......................................................... ....................................................... 49

ログイン関連 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

ログインする.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

ユーザ追加情報を指定してログインする .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

DB を指定する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ログアウトする .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ログイン状態を取得する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

ユーザ情報関連... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

ユーザ情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

現在ログイン中のユーザ名を取得する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

ユーザパスワードを変更する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

ユーザ情報を更新する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

ユーザ定義カラム情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

プリンタ関連 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

プリンタ機種名一覧を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

ダウンロード可能なプリンタ機種名の一覧を取得する... . . . . . . . . . . . . . . . . . . . . . . 57

プリンタ機種のデフォルトプロパティを取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

サーバプリンタ名一覧を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

サーバプリンタ情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

サーバプリンタ情報一覧を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

サーバプリンタのステータスを取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

サーバプリンタのステータスを取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

サーバプリンタを停止する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

サーバプリンタを再開する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

サーバプリンタのプロパティを変更する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

文書関連 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

文書情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

文書情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

文書情報を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

文書管理番号を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

印刷を実行する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

コメントを指定して印刷を実行する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

印刷を実行する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

テスト印刷を実行する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

コメントを指定してテスト印刷を実行する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

テスト印刷を実行する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

印刷を停止する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

iv

印刷を停止する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

印刷を中断する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

印刷を中断する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

印刷を再開する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

印刷を再開する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

文書を削除する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

プリンタキュー文書情報一覧を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

プリンタキュー文書の優先順位を変更する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

プリンタキューの優先順位を変更する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

停止文書の印刷先を変更する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

印刷データを取得する... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

プリンタプロパティを指定して印刷データを取得する... . . . . . . . . . . . . . . . . . . . . . . . . 75

プリンタプロパティとコメントを指定して印刷データを取得する ... . . . . . . . 75

印刷データを生成し、ダウンロードするための PATH（URL）を取得する .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

指定プリンタプロパティで作成した印刷データを生成し、ダウンロードのための PATH（URL）を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

指定プリンタプロパティとコメントで作成した印刷データを生成し、ダウンロードのための PATH（URL）を取得する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

ゴミ箱関連 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

文書をゴミ箱へ移動する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

ゴミ箱から文書を復帰する ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

ゴミ箱を空にする .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

インタフェースクラス仕様 ................................................... ................................... 80

ユーザ情報クラス(userInfo)プロパティ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

文書抽出条件クラス(documentFilter)プロパティ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

サーバプリンタクラス(serverPrinter)プロパティ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

印刷属性(printAttributes)プロパティ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

文書クラス(document)プロパティ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82

プリンタキュー文書クラス(queueDocument)プロパティ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83

ユーザ定義カラム情報(defineColumnInfo)プロパティ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

nameAndValue クラスプロパティ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

文書項目番号 ......................................................... .............................................. 86

メソッド対応表 ........................................................ ................................................ 87

6 エラーコード 90

7 注意事項・制限事項 95

注意事項 ............................................................... ................................................. 95

制限事項 ............................................................... ................................................. 97

索引索引-1

1 製品概要

1

1 製品概要

RDE Uti l ity Developers KIT（以下、「RDE UDK」）は、Report Director Enterprise（以下

「RDE」）サーバの「RDユーティリティ」の機能をユーザアプリケーションに組み込むためのライ

ブラリ製品です。RDEサーバへのログイン・ログアウト、スプール文書情報の取得、サーバプリ

ンタ情報の取得、印刷の実行・中断などの処理機能を備えたアプリケーションの開発が可

能となります。

RDE UDKには、Javaアプリケーションから利用するJava版とMicrosoft .Net Frameworkを

用いて開発されたアプリケーションより、Webサービス（SOAP1.2）経由で使用するWebサー

ビス版が用意されています。

＜RDE UDK Java版の構成＞

RDE Util ity Developers KIT ユーザーズ・マニュアル

2

＜RDE UDK Webサービス版の構成＞

RDE UDKを利用することにより、「RDユーティリティ」のつぎの処理機能を実装することがで

きます。

ログイン機能 RDEサーバへのログイン・ログアウト

ログインしているユーザの操作の確認

ユーザ情報の取得

ユーザ情報の更新

文書情報取得スプール文書情報の取得

スプール文書の削除

ゴミ箱内文書に対する操作

印刷機能印刷属性の設定

印刷

印刷の中断

印刷の停止・再開

サーバプリンタ関連機能

サーバプリンタ情報の取得

印刷可能なプリンタ機種の一覧取得

ファイルダウンロード機能

スプール文書をファイルとしてダウンロード

1 製品概要

3

また、RDE UDKを利用することにより、1つのユーザアプリケーション上から複数のRDEサーバ

に接続することが可能になります。それにより、複数のRDEサーバ上のスプール文書に対し

て処理を実行することが可能となります。


4

RDE UDKを利用したユーザアプリケーションを実行するためには、RdDbWrapper.jarが

必要となります。接続しているRDEと同じバージョンのRdDbWrapper.jarを使用してくだ

さい。

複数のRDEサーバを使用する場合、同時に異なるバージョンのRDEには接続できませ

ん。かならず同じバージョンのRDEを使用してください。

RDE内のデータベースに、別サーバ上から接続する場合は、別途設定が必要となりま

す。詳細については、「複数の接続先 RDEサーバの切り替え」（p.34）を参照してくださ

い。

「RD環境設定」でRDServerのアドレスとして「localhost」や「127.0.0.1」といった、ローカル

ループバックアドレスを指定している場合は、RDE UDKをRDServerと別筐体で使用する

ことはできません。

Ver.8.0 では、Microsoft .Net Frameworkを用いて開発されたアプリケーションより、Web

サービス（SOAP1.2）経由でRDユーティリティ関連の操作メソッドを使用する場合のため

に、Webサービス版RDE UDKが用意されています。

Webサービス版RDE UDKの使用については、「5 Webサービス版の使用」を参照してくだ

さい。

1 製品概要

5

Ver.8.0では、つぎの機能が追加されています。各機能の利用方法については、「３サンプ

ルプログラム実行」の「サンプルプログラム」を参照にしてください。

動的コメントの出力 ······························································· ························

スプール文書を取り出す際に、文書内の指定のフィールドに任意の文字列を出力すること

ができるようになりました。これにより、出力者の詳細情報やコメントなどの自動出力が可能

になります。

・最大10フィールドのコメントデータを動的に出力することができます。

・フィールド名は、次の予約されたフィールド名を使用して、あらかじめ様式に設計されている

ことが前提となります。

rd_comment0

rd_comment1

：

rd_comment9

「rd_comment」という文字列に0から始まる連番(配列のインデックス)を付加した形式にな

ります（以下「rdコメント配列」とします）。連番は9まで指定可能です。

例えば、「印刷時刻（YYYY/MM/DD HH:MM:SS）」と「社員番号」（３桁）を出力する場合、

SVFX-Designer、またはSuper Visual Formade設計部で帳票デザインをおこなう場合、次

のように設定します。

・印刷時刻用フィールド：フィールド名「rd_comment0」

・社員番号用フィールド：フィールド名「rd_comment1」

次の３つのメソッドで本機能の利用が可能です。

・PrintToServerPrinter

・TestPrintToServerPrinter

・CreatePrintData

動的コメント出力されたデータはRDEの監査ログにも出力されます。

監査ログ項目名 RD_COMMENT

値がカンマ区切りで出力されます。

例 RD_COMMENT="2006/03/27 17:37:33 ",null,"318 ","",null,null,null,null,null,null

Ver.8.0 からの新機能


6

スプール済みのページ数の取得 ······························································· ···

文書状態が「スプール中」の文書について、スプール済みのページ数を取得することができ

るようになりました。これにより、スプールの途中経過がわかるようになります。

Ver.8.0 で仕様変更されたメソッド ·····························································

PrintToStreamメソッドは非推奨です。またEMFでの利用はおこなえません。機能強化がお

こなわれているCreatePrintDataメソッドを利用してください。

フィールドの「編集式」、「計算式」、「リンクフィールド」は利用できません。

コメントデータ出力フィールドは、サブフォーム内では利用できません。

RDEへスプールする時に出力したデータは、印刷データ作成時に、rdコメント配列の要

素に値があれば上書きされます。

上書きしたくない場合は、rdコメント配列の要素にnull値を指定します。

動的コメント指定されたデータは保存されません。

RDE、RDE UDKともにVer3.2 以降の組み合わせの場合にのみ動作します。

SVFのAPIのVrSetFormの出力のモードが 0、1、4 で利用可能です。

またSUM関数などで集計をおこなっている帳票の場合は、集計対象のフィールドより後

に集計結果が出力される場合に本機能の利用が可能です。

スプール中ページ数を取得する文書の特定方法

文書管理番号以外、例えばユーザ定義カラムなどで確認する文書を特定して、該当

の文書に対するページ数を取得することになります。

1 製品概要

7

提供されるソフトウェアは次のファイル構成となっています。

RDESDK.jar コアモジュール

rdsdk.properties 設定ファイル

RDE設定手順.txt Webサービス版をRDEと同じサーブレットコンテナ上で動作

させる場合の設定手順ファイル

doc JavaDoc（API）のHTML

rdjava Webサービス版モジュール

Samples Webサービス版サンプルプログラム

Java Java用サンプルプログラム

dotNet.NET用サンプルプログラム

ASPNET ASP.NET用サンプルプログラム

CSharpNET C#.NET用サンプルプログラム

VBNET VB.NET用サンプル（非同期呼び出し）

RDE UDKの動作環境は、つぎの通りです。

OS 利用するRDEのバージョンに準拠

Java実行環境利用するRDEのバージョンに準拠 ※Webサービス版は、JRE1.5 上で動作するTomcat5.5

Report Director Enterprise 3.0a, 3.1, 3.2, 8.0 ※Webサービス版は 8.0

ファイル構成

動作環境


8

2 セットアップ

Javaアプリケーションが稼動するアプリケーションサーバで、RDE UDKのセットアップをおこな

います。例として、RDEがセットアップされている環境にセットアップをおこなう場合の手順を

記します。

クラスライブラリのセットアップは、つぎの手順でおこないます。

1 「RDESDK.jar」と、「rdsdk.properties」を同一ディレクトリに配置します。

2 ファイルの配置先をCLASSPATHに追加します。

Windowsで使用している場合は、以下のjarファイルをCLASSPATHに追加します。

・ %FIT_PRODUCTS_BASE%\rdjava\lib 以下の postgresql-8.1-404.jdbc2.jar 、

RdDbWrapper.jar

・%FIT_PRODUCTS_BASE%\logging以下のlogging.jar、log4j.jar

UNIX、Linuxで使用している場合は、以下のjarファイルをCLASSPATHに追加します。

・$FIT_PRODUCTS_BASE/rdjava/l ib以下のpgjdbc1.jar postgresql-8.1-404.jdbc2.jar、

RdDbWrapper.jar

・$FIT_PRODUCTS_BASE/logging 以下の logging.jar、log4j.jar

CLASSPATH に追加後 Java プログラムから使用する事が可能となります。

「rdsdk.properties」ファイル内の設定について記述します。

「rdsdk.properties」

# this file's encoding

encoding=SJIS

# DebugLog

Log.Mode=OFF

Log.FileOut=true

Log.Level=1823

Log.FileEncoding=MS932

クラスライブラリのセットアップ

クラスライブラリ側オプション


9

Log.LogDir=.

Log.OutputFileName=rdsdk.log

Log.SystemOut=false

Log.SystemOutLevel=1823

# DB

Db.Url=jdbc:postgresql://127.0.0.1:44100/rddb

Db.UseDriver=org.postgresql.Driver

Db.User=svf

Db.Password=svf

#Db.MaxConnection=15

#Db.ConnectionTimeout=600

Db.ConnectionMode=Fixed

#Db.ConnectionMode=Variable

DefaultLanguage=ja

Session.MaxInactiveInterval=1440

encoding= rdsdk.propertiesファイル自体のエンコーディングを指定します。

この設定は変更しないでください。

Log.Mode= デバッグログの出力モードを指定します。

ON 出力します。

OFF 出力しません。

Log.FileOut= デバッグログをファイルに出力するか、しないかを指定します。

True=デバッグログをファイルに出力します。

False=デバッグログをファイルに出力しません。

Log.Level= デバッグログのファイル出力する際のレベルを指定します。デフォルトでは、

「1823」が指定されています。

Log.FileEncoding=

デバッグログファイルのエンコーディングを指定します。デフォルトでは、

「MS932」が指定されています。

Log.LogDir= デバッグログの出力先ディレクトリを指定します。

Log.OutputFileName=

出力するデバッグログファイルの名称を指定します。デフォルトでは、

「rdsdk.log」が指定されています。

Log.SystemOut=

デバッグログを標準出力するか、しないかを指定します。

True=デバッグログを標準出力します。

False=デバッグログを標準出力しません。

Log.SystemOutLevel=

デバッグログの出力レベルを指定します。基本的にデフォルト値「1823」

は変更しないでください。


10

Db.Url= データベースへの接続 URL を指定します。デフォルトでは、

「jdbc:postgresql://127.0.0.1:44100/rddb」が指定されています。

Db.UseDriver= データベースに接続する際に使用する接続ドライバを指定します。デフォ

ルトでは、「org.postgresql.Driver」が指定されています。

Db.User= 接続ユーザ名を指定します。デフォルトでは、「svf」が指定されています。

Db.Password= 接続ユーザのパスワードを指定します。デフォルトでは、「svf」が指定され

ています。

Db.MaxConnection=

データベースへの最大接続数を指定します。

Db.ConnectionTimeout=

タイムアウトとする待ち時間（ms）を指定します。

Db.ConnectionMode=

接続モードを指定します。

Fixed 固定接続先モードを指定します。

Variable

可変接続先モードを指定します。

Session.MaxInactiveInterval=

RDEサーバとRDE UDK間の接続セッションのタイムアウト時間（分）を設

定します。デフォルトは 1440 分です。


11

データベース接続数の詳細については、「RDEユーザーズ・マニュアル Ver.8.0」の「６章運

用管理」の「16 データベース接続数の管理」を参照してください。

RDE UDKのバージョンを確認する場合は、つぎのコマンドを実行します。

> java -jar RDESDK.jar

＜コマンドプロンプトで実行した例＞

データベースへの最大接続数について

バージョンの確認


12

3 サンプルプログラムの実行

RDE UDKには、サンプルプログラム「Sample.java」がついています。ここではこのサンプルプ

ログラムを利用し、実際にRDEサーバ上にスプールされた文書に対して、つぎの処理を実行

し、正常に動作するかを確認します。

ここでは、Windows環境で使用している例を用いて説明します。

サンプルプログラムでおこなう処理

・ユーザ情報取得と、ユーザ情報の変更と更新

・スプール文書情報の取得

・ごみ箱からの文書の削除

・サーバプリンタ情報の取得

・スプール文書のサーバプリンタからの出力

・スプール文書をPDFファイルとしてダウンロード

・データベース接続プーリングの解放

・複数の接続先RDEサーバの切り替え

・サーバプリンタプロパティの変更

・プリンタキュー情報の取得

・プリンタキュー優先順位の変更

・テスト印刷

・用紙変更メッセージの取得

次の機能は、RDE Ver.3.1 以降のみで対応しているものとなります。

・サーバプリンタのステータス取得

次の機能は、RDE Ver.3.2 以降で対応しているものとなります。

・ユーザパスワード有効期限の取得

・ユーザパスワードの有効期限が警告状態であるか取得

・ユーザパスワードの変更

・停止文書の印刷先変更

・印刷先が変更可能か判定

・動的コメントの出力

・スプール済みのページ数の取得

スプール文書をPDFファイルとしてダウンロードする処理を確認するためには、PDFオプ

ションが導入されている必要があります。

複数の接続先RDEサーバの切り替え処理を確認するためには、複数のRDEサーバが導

入されている必要があります。


13

RD環境設定で、サンプルプログラムを実行するために、グループ「test」とユーザ「test」をあ

らかじめ登録しておきます。また、文書をRDEサーバにスプールしておきます。

グループとユーザの登録 ······························································· ················

まず、グループ「test」とユーザ「test」をあらかじめ登録しておきます。

1 RD環境設定で、グループ「test」を作成します。

［グループの作成］ダイアログボックスの［権限］タブで、すべての権限を有効に設定します。

デフォルトでは、すべての権限が有効になっています。

2 ユーザ「test」を以下の内容で作成します。

ユーザ名 test

説明入力しません。

パスワード test

所属するグループ

test

準備


14

文書のスプール ······························································· ······························

文書の出力を実行するために、あらかじめ文書をスプールしておきます。

ここでは、RDEのサンプルファイル「Sample.bat」（UNIX、Linux版は「sample.sh」）を実行して、

文書のスプールをおこないます。

＜RDユーティリティでスプール文書を確認＞


15

サンプルファイルをセットします。

1 「RDESDK.jar」と、「rdsdk.properties」が存在するディレクトリに「Sample.java」をコピー

します。

2 「Sample.Java」をテキストエディタで開き、つぎの個所について、実行環境にあわせて修

正します。

「Sample.java」

import java.io.*;

import jp.co.fit.rd.api.*;

class Sample {

private String CLIENTID = "RdSdk800"; // 任意の文字列を指定してください

private String LANG = "ja"; // 言語

private String USERNAME = "test"; // テスト用のアカウント

先ほど設定したユーザ名「test」を指定します。

private String PASSWORD = ""; // パスワード

ユーザ「test」のパスワード「test」を指定します。

private String PRINTER_NAME = "TestServerPrinter"; //印刷可能なサーバプリンタを指定してください

実際に印刷可能なサーバプリンタ名を指定します。

private String FILENAME = "test.pdf"; // ダウンロード系印刷時のファイル名

PDFファイルとしてダウンロードする際のファイル名を指定します。

private String DRIVERNAME = "org.postgresql.Driver" // DB DriverName

private String DB_URL1 = "jdbc:postgresql://127.0.0.1:44100/rddb"; // DB接続先URL1

可変接続先モードでデータベースに接続する場合に、1 つ目の接続先データベースのURLを指定します。

private String DB_URL2 = "jdbc:postgresql://localhost:44100/rddb"; // DB接続先URL2

可変接続先モードでデータベースに接続する場合に、2 つ目の接続先データベースのURLを指定します。

private PrintWriter console;

：

3 上書き保存します。

サンプルファイルのセット

サンプルプログラムでは、ファイルのダウンロード、およびデータベースの切り替えをおこな

うように設定されています。RDEオプション製品を導入していない場合や、複数のデータ

ベースで運用していない場合は、設定はしなくても問題ありません。


16

編集した「Sample.java」をコンパイルします。

1 コマンドプロンプトを起動し、Sample.javaのあるディレクトリに移動します。

2 次のコマンドを入力し、「Sample.java」をコピーしたディレクトリ上で、「Sample.java」をコ

ンパイルします。

> javac -classpath ".¥RDESDK.jar" Sample.java

※上記は、Windowsの場合の例となります。UNIX/Linuxの場合は、適宜パス区切りを変更してください。

同じディレクトリにコンパイルされたファイル「Sample.class」が作成されます。

先ほど作成したプログラムを実際に実行してみます。まず、RDEサーバ上に文書をスプール

させます。

1 RDEのサンプルファイル「Sample.bat」を利用して、RDEサーバに文書をスプールします。

3 文書ほどスプールしてください。

2 つぎのコマンドを入力し、先ほどコンパイルしたプログラム「Sample.class」を実行します。

実行にはRDESDK.jar、RdDbWrapper.jar、pgjdbc1.jarが必要となります。環境にあわせて

適切にclasspathを指定してください。

※pgjdbc1.jarは、Ver3.2以降JDBCドライバは「postgresql-8.1-404.jdbc2.jar」となります。

> java -classpath

".¥;.¥RDESDK.jar;%FIT_PRODUCTS_BASE%¥rdjava¥lib¥RdDbWrapper.jar;%FIT_PR

ODUCTS_BASE%¥rdjava¥lib¥pgjdbc1.jar;%FIT_PRODUCTS_BASE%¥logging¥logging

.jar;%FIT_PRODUCTS_BASE%¥logging¥log4j.jar" Sample

※上記は、Windowsの場合の例となります。UNIX/Linuxの場合は、適宜パス区切りを変更してください。

コンパイルの実行

プログラムの実行


17

正常に実行されると、画面につぎのような実行状況が表示されます。

サーバプリンタの設定が正常におこなわれていれば、サーバプリンタから帳票が出力されま

す。また、「Sample.class」と同じディレクトリ上に「test.pdf」が出力されます。

RDEオプション（PDF）が導入されていない場合は、PDFは出力されません。


18

RD環境設定で、ユーザ「test」の設定内容を確認してみましょう。

ユーザ「test」のユーザ情報「説明」部に、ユーザ作成時には設定していなかったコメントが

入力されています。

＜RD環境設定＞


19

実際に実行されたサンプルプログラム「Sample.java」の内容は、つぎの通りです。

「Sample.java」 import java.util.*;

import java.io.*;

import jp.co.fit.rd.api.*;

class Sample {

private String CLIENTID = "RdSdk800"; // 任意の文字列を指定してください

private String LANG = "ja"; // 言語

private String USERNAME = "test"; // テスト用のアカウント

private String PASSWORD = ""; // パスワード

private String PRINTER_NAME = "TestServerPrinter"; //印刷可能なサーバプリンタを指定してください

private String FILENAME = "test.pdf"; // ダウンロード系印刷時のファイル名

private String DRIVERNAME = "org.postgresql.Driver" // DB DriverName

private String DB_URL1 = "jdbc:postgresql://127.0.0.1:44100/rddb"; // DB接続先URL1

private String DB_URL2 = "jdbc:postgresql://localhost:44100/rddb"; // DB接続先URL2

private PrintWriter console;

public Sample() {

console = new PrintWriter(System.out, true);

}

public static void main(String[] args) {

Sample sample1 = new Sample();

// ユーザ情報取得・更新の例

sample1.UserInfo();

// 文書情報取得の例

sample1.GetDocuments();

// ごみ箱関連・削除の例

sample1.DeleteDocument();

// サーバプリンタの列挙の例

sample1.EnumServerPrinter();

// サーバプリンタ印刷の例

sample1.PrintToServerPrint();

// ファイル系印刷の例

sample1.FileDownloadPrint();

// 複数の接続先を使い分ける例

// このサンプルコードを動かす前に、rdsdk.properties中、Db.ConnectionMode=Fixedの指定を

// Db.ConnectionMode=Variableに変更してください。

// sample1.SwitchingDb();

// プリンタキュー情報取得の例

sample1.GetPrinterQueueDocuments();

// プリンタキュー優先順位変更の例

サンプルプログラム


20

sample1.UpdatePrinterQueueDocuments();

// サーバープリンタプロパティ変更の例

sample1.UpdateServerPrinterProperties();

// サーバプリンタへのテスト印刷の例

sample1.TestPrintToServerPrint();

// プリンタの停止／再開の例

sample1.StopRestartPrinter();

// DB接続プーリングの解放

sample1.CloseDbConnectionPooling();

}

：

ユーザ情報取得と、ユーザ情報の変更と更新 ···········································

：

//

// ユーザ情報取得・更新の例

public void UserInfo()

{

// RdConnectCreatorのインスタンス作成

RdConnectCreator creator = new RdConnectCreator();

RdConnect rd = null;

try {

// RdConnectのインスタンス作成

新しいRdConnectオブジェクトを生成します。

rd = creator.create(CLIENTID, LANG);

// ログインの実行

指定したユーザ名、パスワードでRDEサーバにログインします。

rd.Login(USERNAME, PASSWORD);

// ユーザ情報の取得

ログインしたユーザの情報を取得します。

UserInfo ui = rd.GetUserInfo();

console.println("ユーザ名：" + ui.getName());

console.println("説明：" + ui.getExplanation());

console.println("ユーザグループ名：");

String[] groups = ui.getUserGroupNames();

for (int i = 0; i < groups.length; i++) {

console.println(" " + (i+1) + ") " + groups[i]);

}

ユーザの新しいパスワードを指定します。

String NEWPASS = "hoge";


21

// パスワードの変更

ユーザのパスワードを先ほど設定したあたらしいパスワードに変更します。

ui.setPassword(PASSWORD, NEWPASS);

// ユーザの説明の変更

ユーザの説明を変更します。

ui.setExplanation("hoge-hoge");

//ユーザ情報の更新

現在ログインしているユーザ情報を更新します。

rd.UpdateUserInfo(ui);

console.println("パスワードを変更しました。");

// パスワードを元に戻しておく

先ほど変更したログインユーザのパスワードを元の内容に戻します。

ui = rd.GetUserInfo();

ui.setPassword(NEWPASS, PASSWORD);

rd.UpdateUserInfo(ui);

}

catch (RdConnectException e) {

console.println("ErrorCode = " + e.errorCode);

console.println(e.getMessage());

e.printStackTrace();

}

finally {

if ((rd != null ) && (rd.getLoginStatus() == RdConnect.STATUS_LOGIN)) {

rd.Logout();

}

}

}

：

スプール文書情報の取得 ······························································· ·············

：

//

// 文書情報取得の例

public void GetDocuments()

{




try {






22



// フィルターの作成

文書情報取得のために新しく抽出条件を指定します。

DocumentFilter filter = new DocumentFilter();

// 未印刷文書を取得する

取得区分として未印刷文書を指定します。

filter.subdivision = DocumentFilter.SUB_DOC_NOT_PRINTED;

// スプール開始時刻が昨日と今日の文書を取得する

文書情報を取得します。

Calendar startCal = Calendar.getInstance();

startCal.set(startCal.get(Calendar.YEAR), startCal.get(Calendar.MONTH),

startCal.get(Calendar.DATE) - 5, 0, 0, 0);

filter.spoolFrom = startCal.getTime().getTime();

Calendar endCal = Calendar.getInstance();

endCal.set(endCal.get(Calendar.YEAR), endCal.get(Calendar.MONTH),

endCal.get(Calendar.DATE), 23, 59, 59);

filter.spoolTo = endCal.getTime().getTime();

// ユーザ定義カラムに'hide'が設定されている文書を除外する条件を指定する例

// filter.condition = "NOT usercolumn1='hide'";

console.println("スプール開始時刻が、" + startCal.getTime().toString() + "から、");

console.println(endCal.getTime().toString() + "までの未印刷文書を取得します");

Document[] updocs = rd.GetDocuments(filter);

// 一覧を表示する

if (updocs.length > 0) {

console.println("文書名：管理番号：ステータス：ユーザ名：スプール開始日：用紙方向：ユーザ

定義カラム１");

console.println(

"======================================================");

for (int i = 0; i < updocs.length; i++) {

console.print(updocs[i].getDocName());

console.print(" : " + updocs[i].getDocNum());

console.print(" : " + updocs[i].getStatusString());

console.print(" : " + updocs[i].getUserName());

console.print(" : " + String.valueOf(updocs[i].getSpoolPageCount()));//スプール中のページ

数取得

Date dt = new Date(updocs[i].getSpoolStartTime());

console.print(" : " + dt.toString());

console.print(" : " + updocs[i].getFormPaperOrientationName));

console.println(" : " + (String)updocs[i].getFieldValue(Document.IDX_USER_DEFINE));

}

}


23

}




}

finally {


rd.Logout();

}

}

}

ごみ箱からの文書の削除 ······························································· ··············

：

//

// ごみ箱関連・文書の削除の例

public void DeleteDocument()

{




try {


新しいRdConnectオブジェクトを生成します





// 文書情報の取得条件を作成(印刷済み文書)


// filter.subdivision = DocumentFilter.SUB_DOC_PRINTED;


// 文書情報の取得

Document[] pdocs = rd.GetDocuments(filter);

if (pdocs.length >= 3) {

// 文書削除

// rd.DeleteDocument(pdocs[2].getDocNum());

// console.println("文書情報を削除しました->文書管理番号(" + pdocs[2].getDocNum() + ")");

}

if (pdocs.length >= 2) {


24

// ごみ箱へ移動

文書をごみ箱に移動します。

rd.MoveDocumentToTrash(pdocs[1].getDocNum());

console.println("ごみ箱へ移動しました->文書管理番号(" + pdocs[1].getDocNum() + ")");

// ごみ箱から戻す

文書をごみ箱から移動します。

rd.RestoreDocumentFromTrash(pdocs[1].getDocNum());

console.println("ごみ箱から戻しました->文書管理番号(" + pdocs[1].getDocNum() + ")");

}

}




}

finally {


rd.Logout();

}

}

}

：

サーバプリンタ情報の取得 ······························································· ············

：

//

// サーバプリンタ列挙の例

public void EnumServerPrinter()

{




try {







サーバプリンタ情報を取得します。

ServerPrinter[] printers = rd.GetServerPrinters();

if (printers.length > 0) {

console.println("プリンタ名 : コメント : 機種 : サーバ名 : 出力区分 : 言語：ステータス");

console.println("==================================================

======");


25

for (int i = 0; i < printers.length; i++) {

console.print(printers[i].getName() + " : ");

console.print(printers[i].getComment() + " : ");

console.print(printers[i].getPrinterKind() + " : ");

console.print(printers[i].getServerName() + " : ");

console.print(printers[i].getSpoolMethodName() + " : ");

console.print(printers[i].getLanguage() + " : ");

console.println(printers[i].getStatusName());

}

console.println();

}

else {

console.println("サーバプリンタが見つかりませんでした。");

}

}




}

finally {

if (rd.getLoginStatus() == RdConnect.STATUS_LOGIN) {

rd.Logout();

}

}

}

：

スプール文書のサーバプリンタからの出力 ················································

：

//

// サーバプリンタ印刷の例

public void PrintToServerPrint()

{




try {







// 文書情報の取得条件を作成(未印刷文書)




26






if (updocs.length < 1) {

console.println("未印刷文書がひとつも存在しなかったので印刷を実行しませんでした。");

return;

}

// サーバプリンタの取得


ServerPrinter printer;

printer = rd.GetServerPrinter(PRINTER_NAME);

// 印刷属性を作成する

印刷時の属性を指定します。

PrintAttributes pas = new PrintAttributes();

pas.copyCount = 2; // 2 部印刷

pas.copyType = PrintAttributes.COPY_TYPE_COLLATED_COPIES; // 部単位で印刷

pas.pageRange = "*"; // すべて印刷

pas.tray = 1; // 給紙トレイの指定

pas.outputBin = 2; // 排紙ビンの指定

// サーバプリンタへの印刷を実行

スプール文書を指定したサーバプリンタに出力します。

rd.PrintToServerPrinter(printer, updocs[0].getDocNum(), pas);

console.println(printer.getName() + "へ、文書管理番号(" + updocs[0].getDocNum() + ")の文書

を印刷しました");

// 文書情報を再取得

出力を実行したスプール文書のステータスを取得します。

updocs[0] = rd.GetDocument(updocs[0].getDocNum());

// 文書ステータスを表示

console.println("文書ステータス->" + updocs[0].getStatusString());

}




}

finally {


rd.Logout();

}

}

}

：


27

動的コメント出力 ······························································· ····························

：

// コメントデータを作成する

// 予約されたフィールド名(rd_comment0～rd_comment9)を使用して帳票が設計されているものとする

String[] comments = new String[10]; // 指定できるコメントの最大数は 10 フィールドまで

DateFormat df = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");

comments[0] = "コメントデータ"; // rd_comment0 フィールドに任意の文字列を上書き

comments[1] = null; // rd_comment1 フィールドはスプール時のまま

comments[2] = df.format(new java.util.Date()); // rd_comment2 フィールドに現在時刻を上書き

// 印刷データを生成する

String fileName = "sample.pdf";

try {

OutputStream out = new FileOutputStream(fileName);

rd.CreatePrintData(prnProp, docNum, pas, out, comments);

out.close();

：


28

}

プリンタキュー情報の取得 ······························································· ·············

：

//

// プリンタキュー情報取得の例

public void GetPrinterQueueDocuments()

{




try {







// プリンタキュー情報を取得する

プリンタキュー情報を取得します。

QueueDocument[] docs = rd.GetPrinterQueueDocuments(PRINTER_NAME);

// 一覧を表示する

console.println("文書名 : 管理番号 : プライオリティ : キュー投入時間 : 印刷ページ数 : 文書に対する

権限");

console.println("==================================================

===================================");

for (int i = 0; i < docs.length; i++) {

console.print(docs[i].getDocName());

console.print(" : " + docs[i].getDocNum());

console.print(" : " + docs[i].getQuePriority());

console.print(" : " + (new Date(docs[i].getQuePrinterTime())).toString());

console.print(" : " + docs[i].getQueParameter());

console.println(" : " + docs[i].hasQueAuthority());

}

}




}

finally {

if ((rd != null) && (rd.getLoginStatus() == RdConnect.STATUS_LOGIN)) {

rd.Logout();

}

}

}


29

プリンタキュー優先順位の変更 ······························································· ····

：

//

// プリンタキュー優先順位変更の例

public void UpdatePrinterQueueDocuments()

{




try {







// 優先順位を変更する

優先順位を変更します。この例では、優先順位を上げています。

QueueDocument[] docs = rd.GetPrinterQueueDocuments(PRINTER_NAME);

rd.UpdatePrinterQueueDocuments(docs, RdConnect.QUE_PRIORITY_UP);

}




}

finally {

if ((rd != null) && (rd.getLoginStatus() == RdConnect.STATUS_LOGIN)) {

rd.Logout();

}

}

}


30

ｓ

サーバプリンタプロパティの変更 ······························································· ···

：

//

// サーバープリンタプロパティ更新の例

public void UpdateServerPrinterProperties()

{




try {







// サーバプリンタ情報の取得


ServerPrinter printer = rd.GetServerPrinter(PRINTER_NAME);

// プロパティインスタンス取得

プロパティ情報を格納するオブジェクトのインスタンスを生成します。

Properties prop = printer.getPrinterProperties();

// 接続タイムアウト時間の取得

実際のプロパティ値を取得します。ここでは、接続タイムアウトを取得しています。

String key = "Spooler.ConnectionTimeoutSec";

int timeOutSec = new Integer(prop.getProperty(key, "")).intValue();

// プロパティ編集例

プロパティ情報を変更します。

prop.setProperty(key, String.valueOf(timeOutSec + 20));

// プロパティのインスタンスへのセット

プリンタのプロパティ情報へ反映します。

printer.setPrinterProperties(prop);

// プロパティ変更の実行

RDEに対して、プロパティ情報の変更を通知します。

rd.UpdateServerPrinterProperties(printer);

console.println(printer.getName() + " の接続タイムアウト時間を" + "[ " + timeOutSec + " ]" + "

から" + "[ " + (timeOutSec + 20) + " ]" + "に変更しました");


31

// 接続タイムアウト時間を元に戻しておく

prop.setProperty(key, String.valueOf(timeOutSec)); printer.setPrinterProperties(prop); rd.UpdateServerPrinterProperties(printer); console.println("接続タイムアウト時間を元に戻しました"); } catch (RdConnectException e) { console.println("ErrorCode = " + e.errorCode); console.println(e.getMessage()); e.printStackTrace(); } finally { if ((rd != null ) && (rd.getLoginStatus() == RdConnect.STATUS_LOGIN)) { rd.Logout(); } }

}

テスト印刷 ······························································· ·······································

：

//

// サーバプリンタへのテスト印刷の例

public void TestPrintToServerPrint()

{




try {






rd.Login(USERNAME, PASSWORD, "additionalUserInfo");








if (updocs.length < 1) {


32

console.println("未印刷文書がひとつも存在しなかったのでテスト印刷を実行しませんでした。");

return;

}

// サーバプリンタの取得


ServerPrinter printer;

printer = rd.GetServerPrinter(PRINTER_NAME);


印刷時の属性を指定します。

PrintAttributes pas = new PrintAttributes();

pas.pageRange = "*"; // すべて印刷

pas.tray = 1; // 給紙トレイの指定

pas.outputBin = 2; // 排紙ビンの指定

// サーバプリンタへのテスト印刷を実行

指定した文書をテスト印刷します。

rd.TestPrintToServerPrinter(printer, updocs[0].getDocNum(), pas);

console.println(printer.getName() + "へ、文書管理番号(" + updocs[0].getDocNum() + ")の文書

をテスト印刷しました");

// 文書情報を再取得

出力を実行したスプール文書のステータスを取得します。

updocs[0] = rd.GetDocument(updocs[0].getDocNum());

// 文書ステータスを表示

console.println("文書ステータス->" + updocs[0].getStatusString());

}




}

finally {


rd.Logout();

}

}

}


33

プリンタの停止／再開 ······························································· ···················

：

//

// プリンタの停止／再開の例

public void StopRestartPrinter()

{




try {










// 停止する

if (!printer.isStopping()) {

rd.StopPrinter(PRINTER_NAME);

}

// 再開する

else {

rd.RestartPrinter(PRINTER_NAME);

}

}





}

finally {


rd.Logout();

}

}

}


34

複数の接続先RDEサーバの切り替え ·························································

： //

// 複数の接続先を切り替える例

public void SwitchingDb()

{


RdConnectCreator creator1 = new RdConnectCreator();

RdConnectCreator creator2 = new RdConnectCreator(); RdConnect rd1 = null;

RdConnect rd2 = null;

try {

// changeDbPropertiesメソッドは、接続先固定モードの時に呼び出すと

// RdConnectExceptionをthrowします。

creator1.changeDbProperties(DB_URL1, null, null, null);

creator2.changeDbProperties(DB_URL2, null, null, null);


rd1 = creator1.create(CLIENTID, LANG);

rd2 = creator2.create(CLIENTID, LANG);

// 接続先 1、接続先 2、両方に同じ名前とパスワードをもつアカウントが存在することを前提にしています。


rd1.Login(USERNAME, PASSWORD);

rd2.Login(USERNAME, PASSWORD);








int[] docNums = rd1.GetDocNums(filter);

console.println("接続先１に、未印刷文書が " + docNums.length + "文書あります");

docNums = rd2.GetDocNums(filter);

console.println("接続先２に、未印刷文書が " + docNums.length + "文書あります");

} catch (RdConnectException e) { console.println("ErrorCode = " + e.errorCode); e.printStackTrace(); } finally { if ((rd1 != null ) && (rd1.getLoginStatus() == RdConnect.STATUS_LOGIN)) { rd1.Logout(); } if ((rd2 != null ) && (rd2.getLoginStatus() == RdConnect.STATUS_LOGIN)) { rd2.Logout(); } } } ：


35

サーバプリンタのステータス手動取得 ························································

：

//

// サーバプリンタのステータス手動取得の例

public void GetServerPrinterStatus() {




try {







サーバプリンタ情報を手動取得します。


// ステータス手動取得可能か判定します

サーバプリンタのステータスが手動取得可能か判断します。

if (printer.canGetStatus()) {

// サーバプリンタのステータス手動取得

サーバプリンタのステータスを手動取得します。

printer = rd.GetServerPrinterStatus(PRINTER_NAME);

if (printer != null) {

サーバプリンタのステータスを表示します。

console.println(printer.getName() + "のステータス-> " + printer.getStatusName());

}

}

else {

console.println("プリンタステータスを取得できない設定です ");

}

}





}

finally {


rd.Logout();

}

}

}


36

停止文書の印刷先変更 ······························································· ···············

：

//

// 停止文書の印刷先変更の例

public void ChangePrinter() {




try {







Document doc = null;


filter.subdivision = DocumentFilter.SUB_DOC_PRINTED;


Document[] docs = rd.GetDocuments(filter);

for (int i = 0; i < docs.length; i++) {

// 印刷先の変更が可能な文書を取得

// 印刷先の変更ができる文書ステータス：「印刷データ作成完了」「印刷待ち」

印刷先が変更可能か判定。

if (docs[i].canChangePrinter()) {

doc = docs[i];

break;

}

}

if (doc == null) {

console.println("印刷先の変更が可能な文書はありませんでした。");

return;

}

// 変更前プリンタの取得

ServerPrinter oldPrinter = rd.GetServerPrinter(doc.getPrinterName());

// 変更先プリンタの取得

// 変更前プリンタと同一サーバ上にあり、同一プリンタ機種のもの

ServerPrinter newPrinter = rd.GetServerPrinter(PRINTER_NAME2);

// 停止文書の印刷先変更

停止文書の印刷先変更。

rd.ChangePrinter(oldPrinter, newPrinter, doc.getDocNum());


37

console.println("文書管理番号(" + doc.getDocNum() + ")の文書の印刷先を、" +

oldPrinter.getName() + "から" + newPrinter.getName() + "へ変更しました。");

}





}

finally {


rd.Logout();

}

}

}

ユーザパスワード有効期限の取得・ユーザパスワードの有効期限の警告状態を取得·····

：

//

// ユーザパスワード有効期限取得・ユーザパスワードの有効期限が警告状態であるか取得の例

public void UserInfo() {




try {







ユーザ情報を取得します。

UserInfo ui = rd.GetUserInfo();

console.println("ユーザ名：" + ui.getName());

console.println("説明：" + ui.getExplanation());

console.println("ユーザグループ名：");

String[] groups = ui.getUserGroupNames();

for (int i = 0; i < groups.length; i++) {

console.println(" " + (i+1) + ") " + groups[i]);

}

ユーザ情報を取得します。

long date = ui.getPasswordValidDate();

SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd");


38

if (date != -1) {

console.println("パスワード有効期限：" + format.format(new Date(date)));

}

パスワード有効期限が警告状態であるか判定します。

if (ui.isPasswordAlertState()) {

console.println("*********** message *************");

console.println("パスワードの有効期限が近づいています");

console.println("パスワードを変更してください");

console.println("*********************************");

}

}





}

finally {


rd.Logout();

}

}

}

ユーザパスワードの変更 ······························································· ·················

この機能は、ログイン時にパスワード変更を要求されている時、つまりログイン状態が「パス

ワード変更待ち状態」の時のみ呼び出せます。ユーザパスワードの変更をおこなっているとき

は、パスワード変更が正常に終了するまで他の処理をおこなうことはできません。

：

//

// ユーザパスワード変更の例

public void ChangeUserPassword() {




try {





// ログイン時パスワード変更が要求されている場合、RdConnectException が発生し、

// ログイン状態が「パスワード変更待ち(RdConnect.STATUS_CHANGE_PASS_WAITING)」

// になります

// 発生するRdConnectException のエラーコードは「-9109(パスワード変更を要求されています)」

// です


39



// ログイン状態が「パスワード変更待ち」状態の時

「パスワード変更待ち」かを確認します。

if ((rd != null ) && (rd.getLoginStatus() == RdConnect.STATUS_CHANGE_PASS_WAITING)) {

try {

// ユーザパスワードの変更

String NEWPASS = "hoge";

// パスワードの変更が正常に終了した場合、ログイン状態が「ログイン(STATUS_LOGIN)」

// になります

パスワードを変更します。

rd.ChangeUserPassword(PASSWORD, NEWPASS);

console.println("ユーザパスワードの変更に成功しました");

}





}

finally {


rd.Logout();

}

}

}

}


40

データベース接続プーリングの解放 ····························································

：

//

// 接続先固定モード時、DB接続プーリングを終了する

public void CloseDbConnectionPooling()

{

// 接続先固定モード時はアプリケーション終了時にこのメソッドを呼び出して、

// プーリングしているDB接続を解放するようにしてください。

RdConnectCreator.finalizeDbConnectionPooling();

}

}

：

4 クラスライブラリの内容

41

4 クラスライブラリの内容

ここでは、RDE UDKが提供するパッケージ「jp.co.fit.rd.api」の階層ツリーおよびクラスの概

要について説明します。なお、APIの詳細については、JavaDoc（API）のHTMLから参照する

ことができます。JavaDocは製品CD-ROMに含まれています。

以下は、RDE UDKのパッケージ「jp.co.f it.rd.api」の階層ツリーになります。

階層ツリーとクラスの概要


42

5 Webサービス版の使用

Webサービス版RDE UDKで使用するAPI関数について記載します。

Webサービス版RDE UDKを使用する際の、システム要件は次の通りです。

クライアント Microsoft .NetFramework2.0 以降がインストールされている環境

サーバ Report Director Enterprise Ver.8.0 が動作する環境

JRE1.5 上で動作しているTomcat5.5

Report Director Enterprise Ver.8.0 がJRE1.5 で動作している環境では、

本サービスが提供するモジュールのセットアップのみで利用可能となりま

す。

クライアントの開発言語

VisualBasic.Net、C#

システム要件

5 Web サービス版の使用

43

セットアップは次の手順でおこないます。

1 「UdkWS」フォルダを%FIT_PRODUCTS_BASE%/rdjava/apache-tomcat-5.5.25/

webapps/配下にコピーします。

以降は FIT_PRODUCTS_BASE の環境変数を Windows 版に例え

て、%FIT_PRODUCTS_BASE%として記載します。

2 「RDESDK.jar」「rdsdk.properties」および「DBWrapper.jar」を以下のディレクトリに配

置します。

Windows 版・UNIX 版共通

%FIT_PRODUCTS_BASE%/rdjava/apache-tomcat-5.5.25/webapps/UdkWS/

WEB-INF/l ib 配下

3 Webブラウザを開き、次のURLを指定して、WebServiceが動作するかどうかを確認しま

す。

URL : http://servername:44090/UdkWS/

バージョン情報がWebブラウザ画面に表示されれば、セットアップ完了です。

Webサービス版RDE UDKのセットアップ

本製品を使用する場合は、JRE1.5 以上を利用する必要があります。

RDE と同じ Tomcat 上で使用する為には、RDE 側の設定の変更が必要になります。同

梱されている「RDE 設定手順.txt」を参照して、下記手順の前にあらかじめ RDE 側の設

定をおこなってください。


44

Webサービス版RDE UDKのAPIを利用するためにVisual Studioの[ソリューションエクスプロー

ラ］から、［Web参照の追加．．．］で本サービスに接続します。

参照先URLは次を指定します。

http://[サーバ名]:44090/UdkWS/UdkService?wsdl

セッションの利用 ······························································· ·····························

サーバ側 (Webサービス)ではクライアント側 (.NET)のログイン情報を保持するために、セッ

ションを利用します。このためクライアント側ではCookieを有効にしてください。

// UDKの参照設定をインスタンス

WebRef.UdkConnect.UdkService udkConnect = new WebRef.UdkConnect.UdkService();

// Cookieを有効にする

udkConnect.CookieContainer = new System.Net.CookieContainer();

日付型フィールドの特殊フィールド ······························································

日付型フィールドは「フィールド名+Specified」という名の特殊フィールドとセットで構成され

ます。これはサーバ側との通信の際にフィールドの値が有効かどうかのフラグとなります。

Webサービス版RDE UDK使用時には、次のことに注意してください。

≪サーバ側から受信したデータの日付型フィールドを利用する場合≫

「フィールド名+Specified」フィールドの値が真(True)の場合のみ、有効値と判断します。

//文書情報を取得する

WebRef.UdkConnect.document doc = udkConnect.GetDocument(docNum);

if( doc.spoolStartTimeSpecified == true )

{

Console.WriteLine("スプール日時：" + doc. spoolStartTime);

}

API利用の準備


45

≪クライアント側からサーバ側に日付型フィールドを含むデータを送信する場合≫

「日付型フィールド名+Specified」のフィールド値を真(True)にします。

//文書の検索条件を作成する

WebRef.UdkConnect.documentFilter filter = new

WebRef.UdkConnect.documentFilter();

filter. spoolFrom = new DateTime (2007,1,1);

filter. spoolFromSpecified = true;

//文書情報一覧を取得する

WebRef.UdkConnect.document[]docs = udkConnect.GetDocuments(filter);

同期と非同期呼び出し ······························································· ··················

.NETの場合、［Web参照の追加．．．］でWebサービス定義時に自動的に生成されるプロキ

シクラスによって「同期」「非同期」の2種類のWebメソッドの呼び出し方法が利用可能とな

ります。

本マニュアルでは「同期」による呼び出し例を使用して説明します。

非同期呼び出しをおこなう場合は、「メソッド名+Async」を使用して呼び出しをおこない、

コールバック関数で後処理をおこなう必要があります。非同期呼び出しの使用例として本

製品に付属のサンプルプログラム(VB.NET)を参考にしてください。

タイムアウト設定について ······························································· ··············

Webサービス定義時に生成されるプロキシクラスのプロパティ「Timeout」の値によってクライ

アント側でタイムアウトが発生します。

処理によってはサーバ側の処理が完了する前にタイムアウトする場合もあるため、クライアン

ト側で適切な値に調整してください。


46

クライアントのユーザアプリケーション開発言語別（Visual Basic.Net、C#）にサンプルプログ

ラムを記載します。

C#の場合 ······························································· ········································

本サービスをWeb参照に「WebRef.UdkConnect」として定義した場合のサンプルプログラム

です。

namespace UdkSample

{

/// UDK for WebServiceのSample(C#版)

class Sample

{

/// 定数

static String LANG = "ja"; // 言語

static String USERNAME = "test"; // テスト用のアカウント

static String PASSWORD = ""; // パスワード

/// UDKサービス

private WebRef.UdkConnect.UdkService udkConnect;

/// コンストラクタ

Sample()

{

// サンプルを生成

Sample sample = new Sample();

// サンプルを実行

sample.Execute();

}

/// コンストラクタ

Sample()

{

// Udkサービスを生成

this.udkConnect = new WebRef.UdkConnect.UdkService();

// Cookieを有効にする

this.udkConnect.CookieContainer = new System.Net.CookieContainer();

}

サンプルプログラム


47

/// サンプル実行

/// (ログイン→ユーザ情報取得＆表示→ログアウト)

Execute()

{


udkConnect.Login(USERNAME, PASSWORD, LANG);

// ユーザ情報の取得

WebRef.UdkConnect.userInfo ui = udkConnect.GetUserInfo();

// 取得したユーザ情報を表示

Console.WriteLine("ユーザ名：" + ui.name);

Console.WriteLine("説明：" + ui.explanation);

Console.WriteLine("ユーザグループ名：");

String[] groups = ui.userGroupNames;

for (int i = 0; i < groups.Length; i++)

{

Console.WriteLine(" " + (i + 1) + "→" + groups[i]);

}

// ログアウト

udkConnect.Logout();

}

}

}

VisualBasic.Netの場合 ······························································· ·················

本サービスをWeb参照に「WebRef.UdkConnect」として定義した場合のサンプルプログラム

です。

Public Class Sample

'' UDK for WebServiceのSample(VB.NET版)

''定数

Private LANG As String = LANG = "ja" ' 言語

Private USERNAME As String = "test" ' テスト用のアカウント

Private PASSWORD As String = "" 'パスワード

'' UDKサービス

Private udkConnect As WebRef.UdkConnect.UdkService

''メイン


48

Sub Main()

' サンプルを生成

Dim sample As New Sample()

' サンプルを実行

sample.Execute()

End Sub

'' コンストラクタ

Sub Sample()

' Udkサービスを生成

udkConnect = New WebRef.UdkConnect.UdkService()

' Cookieを有効にする

udkConnect.CookieContainer = New System.Net.CookieContainer()

End Sub

'' サンプル実行

'' (ログイン→ユーザ情報取得＆表示→ログアウト)

Sub Execute()

' ログインの実行

udkConnect.Login(USERNAME, PASSWORD, LANG)

' ユーザ情報の取得

Dim ui As WebRef.UdkConnect.userInfo = udkConnect.GetUserInfo()

' 取得したユーザ情報を表示

Console.WriteLine("ユーザ名：" & ui.name)

Console.WriteLine("説明：" & ui.explanation)

Console.WriteLine("ユーザグループ名：")

Dim groups As String() = ui.userGroupNames

For i As Integer = 0 To groups.Length - 1

Console.WriteLine(" " & (i + 1) & "→" & groups(i))

Next i

' ログアウト

udkConnect.Logout()

End Sub

End Class


49

Webサービス版RDE UDKで使用できるAPI関数について説明します。

メソッド名メソッドページ

■ログイン関連

ログインする Login p.52

ユーザ追加情報を指定してログイ

ンする

LoginWithAddit ionalUserInfo p.52

DBを指定する SetDbProperty p.53

ログアウトする Logout p.53

ログイン状態を取得する GetLoginStatus p.54

■ユーザ関連

ユーザ情報を取得する GetUserInfo p.54

現在ログイン中のユーザ名を取得

する

GetLoginUserName p.54

ユーザパスワードを変更する ChangeUserPassword p.55

ユーザ情報を更新する UpdateUserInfo p.55

ユーザ定義カラムを取得する GetDefineColumnInfo p.56

■プリンタ関連

プリンタ機種名一覧を取得する GetPrinterKindNames p.57

ダウンロード可能なプリンタ機種名

の一覧を取得する

GetDownloadablePrinterKindNames p.57

プリンタ機種のデフォルトプロパティ

を取得する

GetPrinterKindProperties p.58

サーバプリンタ名一覧を取得する GetServerPrinterNames p.58

サーバプリンタ情報を取得する GetServerPrinter p.59

サーバプリンタ情報一覧を取得す

る

GetServerPrinters p.59

サーバプリンタのステータスを取得

する

GetServerPrinterStatus p.60

サーバプリンタのステータスを取得

する

GetServerPrinterStatusWithTimeout p.60

サーバプリンタを停止する StopPrinter p.61

サーバプリンタを再開する RestartPrinter p.61

プリンタプロパティを変更する UpdateServerPrinterProperties p.62

API関数


50


■文書関連

文書情報を取得する GetDocument p.63

文書情報を取得する GetDocuments p.63

文書情報を取得する GetDocumentsWithIndexes p.64

文書管理番号を取得する GetDocNums p.65

印刷を実行する PrintToServerPrinter p.65

コメントを指定して印刷を実行する PrintToServerPrinterWithComments p.66

印刷を実行する PrintsToServerPrinter p.67

テスト印刷を実行する TestPrintToServerPrinter p.67

コメントを指定してテスト印刷を実

行する

TestPrintToServerPrinterWithComments p.68

テスト印刷を実行する TestPrintsToServerPrinter p.69

印刷を停止する StopDocument p.70

印刷を停止する StopDocuments p.70

■文書関連

印刷を中断する AbortDocument p.70

印刷を中断する AbortDocuments p.71

印刷を再開する RestartDocument p.71

印刷を再開する RestartDocuments p.71

文書を削除する DeleteDocument p.72

プリンタキュー情報を取得する GetPrinterQueueDocuments p.72

プリンタキューの優先順位を変更す

る

UpdatePrinterQueueDocument p.72

プリンタキューの優先順位を変更す

る

UpdatePrinterQueueDocuments p.73

停止文書の印刷先を変更する ChangePrinter p.73

プリンタプロパティを指定して印刷

データを取得する

GetPrintDataWithProperties p.74

プリンタプロパティとコメントを指定し

て印刷データを取得する

GetPrintDataWithPropertiesAndComments p.75

指定プリンタプロパティで作成した

印刷データを生成しダウンロードす

るためのPATHを取得する

GetPrintDataPathWithProperties p.76

指定プリンタプロパティとコメントで

作成した印刷データを生成しダウ

ンロードするためのPATHを取得す

る

GetPrintDataPathWithPropertiesAndComm

ents

p.78


51


■ゴミ箱関連

文書をゴミ箱へ移動する MoveDocumentToTrash p.79

ゴミ箱から文書を復帰する RestoreDocumentFromTrash p.79

ゴミ箱を空にする ClearTrash p.79


52

ログイン関連 ······························································· ···································

ログイン関連の操作をおこなうためのAPI関数について記載します。

ログインする

メソッド名 void Login( p1, p2, p3 )

パラメータ p1 String userName ユーザ名

p2 String password パスワード

p3 String language 言語

例外 RdConnectException

ログインに失敗した場合

使用例使用例は以下の通りです。

String userName = “test”; String password = “test123”; String language = “ja”; UdkConnect.Login( username, password, language );

ユーザ追加情報を指定してログインする

メソッド名 void LoginWithAdditionalUserInfo( p1, p2, p3, p4 )

パラメータ p1 String userName ユーザ名

p2 String password パスワード

p3 String language 言語

p4 String additonalUser ユーザ追加情報




String userName = “test”;

String password = “test123”;

String language = “ja”;

String additonalUser = “adduser”;

//DBを指定してログインする

UdkConnect.LoginWithAdditionalUserInfo(

username, password, language, additonalUser

);


53

DBを指定する

メソッド名 void SetDbProperty( p1, p2, p3, p4 )

パラメータ p1 String dbUrl ＤＢ接続ＵＲＬ

p2 String dbDriver ＪＤＢＣドライバ

p3 String dbUser ＤＢ接続ユーザ名

p4 String dbPassword ＤＢ接続バスワード


String dbUrl = “jdbc:postgresql://127.0.0.1:44100/rddb”;

String dbDriver = “org.postgresql.Driver”;

String dbUser = “svf”;

String dbPassword = “svf”;

//ＤＢの接続先を指定する

UdkConnect.SetDbProperty(dbUrl, dbDriver, dbUser, dbPassword);

//ログインする

String userName = “test”; String password = “test123”; String language = “ja”; UdkConnect.Login( username, password, language );

ログアウトする

メソッド名 void Logout()


// ログアウトする

UdkConnect.Logout();

本メソッドを利用する場合、プロパティファイル「 rdsdk.properties 」の

「Db.ConnectionMode」の値を「Variable」に設定する必要があります。

ログインメソッド呼び出し時のみ設定値が反映されます。


54

ログイン状態を取得する

メソッド名 int GetLoginStatus()

戻り値 0 未ログイン

1 ログイン済

2 パスワード変更待ち


// ログイン状態を取得する

int status = UdkConnect.GetLoginStatus();

switch( status )

{

0: // 未ログイン

Console.WriteLine( “未ログイン” );

break;

1: // ログイン済

Console. WriteLine ( “ログイン済” );

break;

2: // パスワード変更待ち

Console. WriteLine ( “パスワード変更待ち” );

break;

}

ユーザ情報関連 ······························································· ······························

ユーザ情報関連の操作をおこなうためのAPI関数について記載します。

ユーザ情報を取得する

メソッド名 UserInfo GetUserInfo()

戻り値ユーザ情報

詳細については、「ユーザ情報クラス(userInfo)プロパティ」（p.80）を参照

してください。


ユーザ情報取得に失敗した場合


//ユーザ情報を取得



55

現在ログイン中のユーザ名を取得する

メソッド名 UserInfo GetLoginUserName()

戻り値現在ログイン中のユーザ名


ユーザ名取得に失敗した場合


String userName = udkConnect.GetLoginUserName();

ユーザパスワードを変更する

メソッド名 void ChangeUserPassword( p1, p2 );

パラメータ p1 String oldPassword 旧パスワード

p2 String newPassword 新パスワード


パスワード変更に失敗した場合


String oldPassword = “pass123”;

String newPassword = “pass456”;

UdkConnect.ChangeUserPassword( oldPassword, newPassword );

ユーザ情報を更新する

メソッド名 void UpdateUserInfo( p1 );

パラメータ p1 UserInfo ui ユーザ情報

詳細については「ユーザ情報クラス(userInfo)プロパティ」（p.80）を参照し

てください。


ユーザ情報更新に失敗した場合


//ユーザ情報を取得


//ユーザ情報の編集

ui.oldPassword = “pass123”; // 旧パスワード

ui.newPassword = “pass456”; // 新パスワード

ui.explanation = “hoge” // 説明

//ユーザ情報を更新

udkConnect.UpdateUserInfo ( ui );


56

ユーザ定義カラム情報を取得する

メソッド名 DefineColumnInfo[] GetDefineColumnInfo()

戻り値ユーザ定義カラム情報の配列

詳細については「ユーザ定義カラム情報 (defineColumnInfo)プロパティ」

（p.85）を参照してください。


情報取得に失敗した場合


//ユーザ定義カラム情報を取得

WebRef.UdkConnect.defineColumnInfo[] colInfo =

udkConnect.GetDefineColumnInfo ();

for( int i = 0; i < colInfo.Length; i++ )

｛

Console.WriteLine( colInfo(i).fieldName + “ = “ + colInfo(i).fieldIndex );

｝

パスワード、説明のみ更新可能です。その他のプロパティを変更しても更新対象外とな

ります。


57

プリンタ関連 ······························································· ····································

プリンタ情報関連の操作をおこなうためのAPI関数について記載します。

プリンタ機種名一覧を取得する

メソッド名 String[] GetPrinterKindNames()




String[] kindNames =

UdkConnect.GetPrinterKindNames();

for( int i = 0; i < kindNames.Length; i++ )

{

Console.WriteLine( kindNames[i] );

}

ダウンロード可能なプリンタ機種名の一覧を取得する

メソッド名 String[] GetDownloadablePrinterKindNames()

戻り値ダウンロード可能なプリンタ機種名の配列




String[] kindNames =

UdkConnect.GetDownloadablePrinterKindNames ();


{

Console.WriteLine( kindNames[i] );

}


58

プリンタ機種のデフォルトプロパティを取得する

メソッド名 nameAndValue [] GetPrinterKindProperties( p1 )

パラメータ p1 String printerKind プリンタ機種名

戻り値プロパティ名と値(nameAndValue)の配列

詳細については「nameAndValueクラスプロパティ」（p.85）を参照してくだ

さい。




String kindName = “EMF”;

WebRef.UdkConnect.nameAndValue [] props =

UdkConnect. GetPrinterKindProperties(kindName);

for( int i = 0; i < props.Length; i++ )

{

Console.WriteLine(props[i].name + “ = ” + props[i].value);

}

サーバプリンタ名一覧を取得する

メソッド名 String[] GetServerPrinterNames()

戻り値サーバプリンタ名(String)の配列




//プリンタ名一覧を取得する

String[] kindNames = UdkConnect. GetServerPrinterNames();


{

Console.WriteLine(kindNames[i]);

}


59

サーバプリンタ情報を取得する

メソッド名 ServerPrinter GetServerPrinter( p1 )

パラメータ p1 String printerName サーバプリンタ名

戻り値サーバプリンタ情報(ServerPrinter)

詳細については「サーバプリンタクラス(serverPrinter)プロパティ」（p.81）

を参照してください。




String printerName = “TestPrinter”;

WebRef.UdkConnect.ServerPrinter printer =

UdkConnect.GetServerPrinter(printerName);

Console.WriteLine(printer.name);

サーバプリンタ情報一覧を取得する

メソッド名 ServerPrinter[] GetServerPrinters()

戻り値サーバプリンタ情報(ServerPrinter)の配列






//サーバプリンタ情報一覧を取得する

WebRef.UdkConnect.ServerPrinter[] printers = UdkConnect.GetServerPrinters();

for( int i = 0; i < printers.Length; i++ )

{

Console.WriteLine(printers[i].name);

}


60

サーバプリンタのステータスを取得する

メソッド名 ServerPrinter GetServerPrinterStatus( p1 )








//プリンタステータスを取得する


WebRef.UdkConnect.ServerPrinter serverPrinter =

UdkConnect. GetServerPrinterStatus(printerName);

Console.WriteLine(serverPrinter.statusName);

サーバプリンタのステータスを取得する

メソッド名 ServerPrinter GetServerPrinterStatusWithTimeout( p1, p2 )


p2 int timeoutSec ソケット通信のタイムアウト（ミリ秒）

ゼロを指定するとタイムアウトしません。







//プリンタステータスを取得する


WebRef.UdkConnect.ServerPrinter serverPrinter =

UdkConnect.GetServerPrinterStatusWithTimeout(printerName, 100);

Console.WriteLine(serverPrinter.statusName);

本メソッドを利用する場合、サーバプリンタプロパティのステータス取得を手動に設定す

る必要があります

本メソッドを利用する場合、サーバプリンタプロパティのステータス取得を手動に設定す

る必要があります。


61

サーバプリンタを停止する

メソッド名 ServerPrinter StopPrinter( p1 )

パラメータ P1 String printerName サーバプリンタ名





プリンタ停止に失敗した場合


//プリンタを停止する


UdkConnect.StopPrinter( printerName );

サーバプリンタを再開する

メソッド名 ServerPrinter RestartPrinter( p1 )

パラメータ P1 String printerName サーバプリンタ名





プリンタ再開に失敗した場合


//プリンタを停止する


UdkConnect.RestartPrinter( printerName );


62

サーバプリンタのプロパティを変更する

メソッド名 void UpdateServerPrinterProperties( p1 )

パラメータ P1 ServerPrinter printer サーバプリンタ情報




更新に失敗した場合


//サーバプリンタ情報を取得する




for( int i = 0; printer.properties.Length; i++ )

{

// 印字位置調整量(横)(mm)を調整

if(printer.properties[i].name.Equales("AdjustX")

{

printer.properties[i].value = "10";

}

// 印字位置調整量(縦)(mm)を調整

if(printer.properties[i].name.Equales("AdjustY")

{

printer.properties[i].value = "10";

}

}

//サーバプリンタのプロパティを変更する

UdkConnect. UpdateServerPrinterProperties(printer);


63

文書関連 ······························································· ·········································

文書関連の操作をおこなうためのAPI関数について記載します。

文書情報を取得する

メソッド名 Document GetDocument( p1 )

パラメータ p1 int docNum 文書管理番号





int docNum = 123; //文書管理番号 123

WebRef.UdkConnect document doc = UdkConnect.GetDocument ( docNum );

Console.WriteLine( doc.docName ); //文書名を表示する


メソッド名 Document[] GetDocuments( p1 )

パラメータ p1 DocumentFilter fi lter 抽出条件

詳細については「文書抽出条件クラス (documentFilter) プロパティ」





//検索条件を作成する

WebRef.UdkConnect documentFilter filter =

new WebRef.UdkConnect documentFilter();

filter.subdivision = 1; // 未印刷文書


WebRef.UdkConnect document[] docs = UdkConnect.GetDocuments( filter );

for( int i=0; i < docs.Length; i++ ) {

Console.WriteLine( docs[i].docName ); //文書名を表示する

}


64


メソッド名 Document[] GetDocumentsWithIndexes( p1, p2 )


詳細については「文書抽出条件クラス(documentFi lter)プロパ

ティ」（p.80）を参照してください。

p2 int[] indexes 集合化する対象の項目番号配列

指定可能な値については「文書項目番号」（p.86）を参照してく

ださい。




// 検索条件を作成する




//集合化する項目番号

int[] indexes = { 0, 1, 2 }; // 0:文書名、1:ｺﾝﾋﾟｭｰﾀ名、2:ユーザ名

// 文書情報を取得する

WebRef.UdkConnect document[] docs =

UdkConnect.GetDocumentsWithIndexes( filter, indexes );

for( int i=0; i < docs.Length; i++ ) {


}

indexesで指定された文書項目番号の文書情報が同じ値を持つ場合、それらは 1 つに

集合化されます。取得できる文書情報は、指定した文書項目番号の情報のみになりま

す。

返される文書情報オブジェクトは変更できません。返される文書情報オブジェクトは、

getDocuments()メソッド呼び出し時のスナップショットです。

つまり、RdServer上の文書情報の内容が変更されても、返される文書情報オブジェクト

の内容は更新されません。文書情報の変更を検出するには、個々の文書情報に対し

てgetDocument()を呼び出し、新規文書情報を以前の文書情報と比較します。


65

文書管理番号を取得する

メソッド名 int[] GetDocNums( p1 )







//検索条件を作成する




//文書管理番号一覧を取得する

Int[] docNums = UdkConnect. GetDocNums( filter );

for( int i=0; i < docNums.Length; i++ ) {

Console.WriteLine( docNums[i] );

}

印刷を実行する

メソッド名 void PrintToServerPrinter( p1, p2, p3 )

パラメータ p1 ServerPrinter printer サーバプリンタ情報

p2 int docNum 文書管理番号

p3 PrintAttributes pas 印刷属性


印刷に失敗した場合


// サーバプリンタ情報を取得する




int docNum = 123; // 文書管理番号 123


WebRef.UdkConnect.printAttributes pas =

new WebRef.UdkConnect.printAttributes();



66

pas.copyType = true; // 部数単位印刷

pas.pageRange = “*”; // すべて印刷

pas.tray = 1; // 給紙トレイの選択

pas.outputBin = 2; // 排紙ビンの選択

// 印刷を実行する

UdkConnect.PrintToServerPrinter( printer, docNum, pas );

コメントを指定して印刷を実行する

メソッド名 void PrintToServerPrinterWithComments( p1, p2, p3, p4 )




p4 String[] comments コメント

















Spas.outputBin = 2; // 排紙ビンの選択

// コメントを作成する

String[] comments = { “comment1”, “comment2”};


UdkConnect.PrintToServerPrinterWithComments ( printer, docNum, pas, comments );


67


メソッド名 void PrintsToServerPrinter( p1, p2, p3 )











Int[] docNums = { 123, 456 }; // 文書管理番号 123,456










UdkConnect.PrintsToServerPrinter( printer, docNum, pas );

テスト印刷を実行する

メソッド名 void TestPrintToServerPrinter( p1, p2, p3 )







68
















UdkConnect.TestPrintToServerPrinter( printer, docNum, pas );

コメントを指定してテスト印刷を実行する

メソッド名 void TestPrintToServerPrinterWithComments( p1, p2, p3, p4 )



















69




// コメントを作成する

String[] comments = { “comment1”, “comment2”};


UdkConnect.TestPrintToServerPrinterWithComments( printer, docNum, pas, comments );

テスト印刷を実行する

メソッド名 void TestPrintsToServerPrinter( p1, p2, p3 )











Int[] docNums = { 123, 456 }; // 文書管理番号 123,456










UdkConnect.TestPrintsToServerPrinter( printer, docNum, pas );


70

印刷を停止する

メソッド名 void StopDocument( p1 )



印刷停止に失敗した場合


// 印刷を停止する


UdkConnect.StopDocument( docNum );

印刷を停止する

メソッド名 void StopDocuments( p1 )



印刷停止に失敗した場合


// 印刷を停止する

Int[] docNums = { 123, 456 }; //文書管理番号 123,456

UdkConnect.StopDocuments( docNums );

印刷を中断する

メソッド名 void AbortDocument( p1 )



印刷中断に失敗した場合


// 印刷を中断する


UdkConnect.AbortDocument ( docNum );


71

印刷を中断する

メソッド名 void AbortDocuments( p1 )



印刷中断に失敗した場合


// 印刷を中断する


UdkConnect.AbortDocuments( docNums );

印刷を再開する

メソッド名 void RestartDocument( p1 )



印刷再開に失敗した場合


// 印刷を再開する


UdkConnect.RestartDocument( docNum );

印刷を再開する

メソッド名 int[] RestartDocuments( p1 )



印刷再開に失敗した場合


// 印刷を再開する


UdkConnect.RestartDocuments( docNums );


72

文書を削除する

メソッド名 void DeleteDocument( p1 )



文書の削除に失敗した場合


// 印刷を削除する


UdkConnect.DeleteDocument( docNum );

プリンタキュー文書情報一覧を取得する

メソッド名 QueueDocument[] GetPrinterQueueDocuments( p1 )

パラメータ p1 String printerName プリンタ名




//プリンタキューの文書情報一覧を取得する


WebRef.UdkConnect.queueDocument[] docs =

UdkConnect.GetPrinterQueueDocuments(printerName);

for( int i=0; i < docs.Length; i++ )

{


}

プリンタキュー文書の優先順位を変更する

メソッド名 void UpdatePrinterQueueDocument( p1, p2 )

パラメータ p1 QueueDocument doc プリンタキュー文書情報

p2 int updateKind 優先順位(0:UP, 1:DOWN)


情報更新に失敗した場合


73


// プリンタキューの文書情報一覧を取得する




if( docs != null && docs.Length > 0 )

{

// 先頭文書の優先順位を下げる

UdkConnect.UpdatePrinterQueueDocument( docs[0], 1 );

}

プリンタキューの優先順位を変更する

メソッド名 void UpdatePrinterQueueDocuments( p1, p2 )

パラメータ p1 QueueDocument[] docs プリンタキュー文書情報の一覧

p2 int updateKind 優先順位(0:UP, 1:DOWN)


更新に失敗した場合


// プリンタキューの文書情報一覧を取得する




// 全文書の優先順位を上げる

UdkConnect.UpdatePrinterQueueDocuments( docs, 0 );

停止文書の印刷先を変更する

メソッド名 void ChangePrinter( p1, p2, p3 )

パラメータ p1 ServerPrinter oldPrinter 変更元プリンタ情報

p2 ServerPrinter newPrinter 変更先プリンタ情報






74

// プリンタ情報を取得する

String printerName1 = “TestPrinter1”;

String printerName2 = “TestPrinter2”;

WebRef.UdkConnect.serverPrinter oldPrinter =

udkConnect.GetServerPrinter(printerName1)

WebRef.UdkConnect.serverPrinter newPrinter =

udkConnect.GetServerPrinter(printerName2)


// 印刷先を変更する

UdkConnect.ChangePrinter( oldPrinter, newPrinter, docNum );

印刷データを取得する

メソッド名 Byte[] GetPrintData( p1, p2, p3 )





印刷データ取得に失敗した場合


String printerKind = “PDF”; // プリンタ機種名=PDF








pas.tray = -1; // 給紙トレイの選択

pas.outputBin = -1; // 排紙ビンの選択


Byte[] data = UdkConnect.GetPrintData(printerKind, docNum, pas );

容量の大きい帳票データを取得する場合、本メソッドの使用は推奨しません。

「GetPrintDataPath」メソッドの使用を推奨します。


75

プリンタプロパティを指定して印刷データを取得する

メソッド名 Byte[] GetPrintDataWithProperties( p1, p2, p3 )

パラメータ p1 nameAndvalue [] props プリンタ機種のプロパティ







WebRef.UdkConnect.nameAndValue[] props =

UdkConnect.GetPrinterKindProperties(printerKind);










// 印刷データを取得する

Byte[] data = UdkConnect.GetPrintDataWithProperties(props, docNum, pas );

プリンタプロパティとコメントを指定して印刷データを取得する

メソッド名 Byte[] GetPrintDataWithPropertiesAndComments( p1, p2, p3, p4 )

パラメータ p1 nameAndValue [] props プリンタ機種のプロパティ







「GetPrintDataPathWithProperties」メソッドの使用を推奨します。


76














// rd_comment[0-9]のフィールドにコメントを設定

String[] comments = new String[10];

comments[0] = "コメント";


Byte[] data = UdkConnect.GetPrintDataWithPropertiesAndComments(

props, docNum, pas, comments

);

印刷データを生成し、ダウンロードするためのPATH（URL）を取得する

メソッド名 String GetPrintDataPath( p1, p2, p3 )







「GetPrintDataPathWithPropertiesAndComments」メソッドの使用を推奨します。


77












// 印刷データを作成する

String path = UdkConnect. GetPrintDataPath( printerKind, docNum,

pas );

指定プリンタプロパティで作成した印刷データを生成し、ダウンロードのためのPATH（URL）を取得する

メソッド名 String GetPrintDataPathWithProperties( p1, p2, p3 )



















// 印刷データを作成する

String path = UdkConnect.GetPrintDataPathWithProperties(props,

docNum, pas );


78

指定プリンタプロパティとコメントで作成した印刷データを生成し、ダウンロードのためのPATH（URL）を取得する

メソッド名 GetPrintDataPathWithPropertiesAndComments( p1, p2, p3, p4 )

パラメータ p1 NameAndValue[] props プリンタ機種のプロパティ










int docNum = 123; // 文書管理番号=123









// rd_comment[0-9]のフィールドにコメントを設定

String[] comments = new String[10];

comments[0] = "コメント";


Byte[] data = UdkConnect.GetPrintDataPathWithPropertiesAndComments(

props, docNum, pas, comments

);


79

ゴミ箱関連 ······························································· ·······································

ゴミ箱関連の操作をおこなうためのAPI関数について記載します。

文書をゴミ箱へ移動する

メソッド名 void MoveDocumentToTrash( p1 )



処理が失敗した場合


// 文書をごみ箱に移動する


UdkConnect. MoveDocumentToTrash( docNum );

ゴミ箱から文書を復帰する

メソッド名 void RestoreDocumentFromTrash( p1 )





//文書をごみ箱から復帰する


UdkConnect.RestoreDocumentFromTrash ( docNum );

ゴミ箱を空にする

メソッド名 void ClearTrash( p1 )







//文書抽出条件に該当する文書をごみ箱からクリアする



filter.subdivision = 3; // ゴミ箱

UdkConnect.ClearTrash( filter );


80

ユーザ情報クラス(userInfo)プロパティ ······················································

型プロパティ名説明

String[] userGroupNames ユーザの所属しているグループ名

String explanation ユーザの説明

String name ユーザ名

String oldPassword 旧パスワード

パスワード変更時に設定します。

String newPassword 新パスワード

パスワード変更時に設定します。

Boolean passwordAlertState パスワード有効期限が警告状態であるか

Date passwordVal idDate パスワード有効期限

文書抽出条件クラス(documentFilter)プロパティ ···································


String subdivis ion 取得区分

0:すべて、1:未印刷、2:印刷済、3:ごみ箱

String docNamePattern 文書名のパターン

int sortField ソートするフィールド

「文書項目番号の値」を参照してください。

int sortOrder ソート順

0:昇順、1:降順

Date spoolFrom 指定日時以降にスプールされた文書を指

定

Date spoolTo 指定日時以前にスプールされた文書を指

定

String condit ion その他の条件

例：

usercolumn1=' ウィングアーク ' and

usercolumn2='5000'"

インタフェースクラス仕様


81

サーバプリンタクラス(serverPrinter)プロパティ ·······································


String name プリンタ名

Boolean canGetStatus 手動取得によりステータス取得が可能かど

うか

String comment コメント

String language 言語

int paral le lJobCount 並列処理数(文書数)

String portName ポート

String printerKind プリンタ機種名

String serverName RDサーバ名

String spoolDirectory 出力ディレクトリ

int spoolMethod 出力区分

String spoolMethodName 出力区分名

int status ステータス

String statusName ステータス文字列

int statusInterval ステータス監視間隔(秒)

int statusProtocol ステータス取得プロトコル

Boolean stopping 停止中であるかどうか

nameAndValue[] properties 「nameAndValue」を参照してください。

int protocol 印刷プロトコル

印刷属性(printAttributes)プロパティ ······················································


String pageRange ページ範囲指定

Int copyCount 部数指定

Int copyType 部単位印刷指定か

Int tray 給紙トレイ指定

Int outputBin 排紙ビン指定

Boolean al lPageIsPrinted 印刷後に全ページを印刷済みにするか

int AdjustX 印字位置の横方向への移動量

int AdjustY 印字位置の縦方向への移動量


82

文書クラス(document)プロパティ ······························································


Boolean canAbort 中断可能か

Boolean canChangePrinter 印刷先変更可能か

Boolean canDelete 削除可能か

Boolean canFi lePrint ファイル印刷可能か

Boolean canMoveToTrash ごみ箱へ移動可能か

Boolean canPrint 印刷可能か

Boolean canRestart 再開可能か

Boolean canRestore 元に戻せるか

Boolean canStop 停止可能か

Boolean canView ビュー可能か

String computerName コンピュータ名

String docName 文書名

int docNum 文書管理番号

int formCopyCount 様式に指定されている部数

String formFi leName 様式ファイル名

int formPaperCode 様式に指定されている用紙コード

int formPaperOrientation 様式に指定されている用紙方向

String formPaperOrientationName 様式に指定されている用紙方向名

int formPaperSize 様式に指定されている用紙サイズ

String formPaperSizeName 様式に指定されている用紙サイズ名

int formPrintCount 綴りページ数

String outputFi leName PDF等ファイル系出力のファイル名

Int pageCount ページ数

String paperChangeMessage 用紙変更メッセージ

Boolean Printed 印刷済み文書か

int printedPageCount 印刷済みページ数

String printerName 印刷プリンタ名

Date spoolStartTime スプール開始日時

Date spoolEndTime スプール終了日時

Date printStartTime 印刷開始日時

Date printEndTime 印刷終了日時


83


String[] printablePrinterKindNames 印刷可能な機種名一覧

int spoolPageCount スプールページ数


String statusString ステータス名称

Boolean stopping 停止中か

Boolean trash ごみ箱文書か

int unprintedPageCount 未印刷ページ数

Date updateTime 最終更新時刻

String[] userColumnNames ユーザ定義カラム名一覧

本サービスの「GetDefineColumnInfo」メソッ

ドで取得したユーザ定義カラム順で値を設

定します。

String[] userColumnValues ユーザ定義カラム値一覧

String userName ユーザ名

Boolean canSpecifyPageRange 印刷時ページ範囲指定の制限 (文書セキュ

リティ情報)

falseの場合、pageRangeに「*(すべて)」以

外を指定できません

プリンタキュー文書クラス(queueDocument)プロパティ


Boolean canAbort 中断可能か

Boolean canChangePrinter 印刷先変更可能か

Boolean canDelete 削除可能か

Boolean canFi lePrint ファイル印刷可能か

Boolean canMoveToTrash ごみ箱へ移動可能か

Boolean canPrint 印刷可能か

Boolean canRestart 再開可能か

Boolean canRestore 元に戻せるか

Boolean canStop 停止可能か

Boolean canView ビュー可能か

String computerName コンピュータ名

String docName 文書名

int docNum 文書管理番号


84


int formCopyCount 様式に指定されている部数

String formFi leName 様式ファイル名

int formPaperCode 様式に指定されている用紙ｺｰﾄﾞ

int formPaperOrientation 様式に指定されている用紙方向

String formPaperOrientationName 様式に指定されている用紙方向名

int formPaperSize 様式に指定されている用紙サイズ

String formPaperSizeName 様式に指定されている用紙サイズ名

int formPrintCount 綴りページ数

String outputFi leName PDF等ファイル系出力のファイル名

int pageCount ページ数

String paperChangeMessage 用紙変更メッセージ

Boolean printed 印刷済み文書か

int printedPageCount 印刷済みページ数

String printerName 印刷プリンタ名

Date spoolStartTime スプール開始日時

Date spoolEndTime スプール終了日時

Date printStartTime 印刷開始日時

Date printEndTime 印刷終了日時

String[] printablePrinterKindNames 印刷可能な機種名一覧

int spoolPageCount スプールページ数


String statusString ステータス名称

Boolean stopping 停止中か

Boolean trash ごみ箱文書か

int unprintedPageCount 未印刷ページ数

Date updateTime 最終更新時刻

String[] userColumnNames ユーザ定義カラム名一覧



定します。

String[] userColumnValues ユーザ定義カラム値一覧



定します。


85


String userName ユーザ名

Boolean canSpecifyPageRange 印刷時ページ範囲指定の制限 (文書セキュ

リティ情報)

falseの場合、pageRangeに「*(すべて)」以

外を指定できません。

Boolean queAuthority 印刷優先順位の変更権限があるか

int queParameter 印刷ページ数

Date quePrinterTime キュー投入日時

int quePrior ity 優先度

Boolean canChangePrintQueue 印刷優先順位の変更が可能か

ユーザ定義カラム情報(defineColumnInfo)プロパティ ····························


int f ield Index インデックス番号

String f ieldName フィールド名

nameAndValueクラスプロパティ ······························································· ·


String name キー名

String value 値


86

使用できる文書項目番号は次の通りです。

値意味 Documentクラス(UDK)の定数

0 文書名 IDX_NAME

1 コンピュータ名 IDX_COMPUTER_NAME

2 ユーザ名 IDX_USER_NAME

3 印刷先プリンタ名 IDX_PRINTER_NAME

5 スプール開始時刻 IDX_SPOOL_START_TIME

6 スプール終了時刻 IDX_SPOOL_END_TIME

7 印刷開始時刻 IDX_PRINT_START_TIME

8 印刷終了時刻 IDX_PRINT_END_TIME

9 最終更新時刻

(ステータス変更時、ゴミ箱移動時、ゴミ箱から復

元時)

IDX_UPDATE_TIME

10 文書管理番号 IDX_MANAGE_NUM

12 ページ数 IDX_PAGE_COUNT

13 未印刷ページ数 IDX_UNPRINTING_PAGE_COUNT

14 文書ステータス IDX_STATUS

15 様式ファイル名 IDX_FORM_FILE_NAME

16 用紙サイズ IDX_FORM_SIZE

17 用紙方向 IDX_FORM_DIRECTION

18 綴りページ数 IDX_FORM_TUZURI_COUNT

19 部数 IDX_FORM_COPY_COUNT

20 用紙コード IDX_FORM_PAPER_CODE

23 印刷先（0:サーバプリンタ 1:クライアントプリンタ） IDX_PRINT_KIND

31 文書属性

[ 1=停止再開（0:印刷可 1:停止), 2=・・・]

IDX_DOC_ATTRIBUTE

33 プレビュー数 IDX_DOC_PREVIEW_COUNT

1000 ユーザ定義 IDX_DOC_USER_DEFINE

文書項目番号


87

通常のRDE UDKと、Webサービス版のメソッドの対応表を記載します。

メソッドメソッド名

WebServiece I/F UDK

■ログイン関連

ログインする Login Login

追加ユーザを指定してロ

グインする

LoginWithAddit ionalUserInfo Login

DBを指定する SetDbProperty ChangeDbProperties

ログアウトする Logout Logout

ログイン状態を取得する GetLoginStatus GetLoginStatus

■ユーザ関連

ユーザ情報を取得する GetUserInfo GetUserInfo

現在ログイン中のユーザ

名を取得する

GetLoginUserName GetLoginUserName

ユーザパスワードを変更

する

ChangeUserPassword ChangeUserPassword

ユーザ情報を更新する UpdateUserInfo UpdateUserInfo

ユーザ定義カラムを取得

する

GetDefineColumnInfo GetDefineColumnInfo

■プリンタ関連

プリンタ機種名一覧を取

得する

GetPrinterKindNames GetPrinterKindNames

ダウンロード可能なプリン

タ機種名の一覧を取得

する

GetDownloadablePrinterKindN

ames

GetDownloadablePrinterKindN

ames

プリンタ機種のデフォルト

プロパティを取得する

GetPrinterKindProperties GetPrinterKindProperties

サーバプリンタ名一覧を

取得する

GetServerPrinterNames GetServerPrinterNames

サーバプリンタ情報を取

得する

GetServerPrinter GetServerPrinter

サーバプリンタ情報一覧

を取得する

GetServerPrinters GetServerPrinters

サーバプリンタのステータ

スを取得する

GetServerPrinterStatus GetServerPrinterStatus

メソッド対応表


88


WebServiece I/F UDK

サーバプリンタのステータ

スを取得する

GetServerPrinterStatusWithTi

meout

GetServerPrinterStatus

サーバプリンタを停止す

る

StopPrinter StopPrinter

サーバプリンタを再開す

る

RestartPrinter RestartPrinter

プリンタプロパティを変更

する

UpdateServerPrinterProperties UpdateServerPrinterProperties

■文書関連

文書情報を取得する GetDocument GetDocument

文書情報を取得する GetDocuments GetDocuments

文書情報を取得する GetDocumentsWithIndexes GetDocuments

文書管理番号を取得する GetDocNums GetDocNums

印刷を実行する PrintToServerPrinter PrintToServerPrinter

コメントを指定して印刷

を実行する

PrintToServerPrinterWithCom

ments

PrintToServerPrinter

印刷を実行する PrintsToServerPrinter PrintToServerPrinter

テスト印刷を実行する TestPrintToServerPrinter TestPrintToServerPrinter

コメントを指定してテスト


TestPrintToServerPrinterWith

Comments

TestPrintToServerPrinter

テスト印刷を実行する TestPrintsToServerPrinter TestPrintToServerPrinter

印刷を停止する StopDocument StopDocument

印刷を停止する StopDocuments StopDocuments

印刷を中断する AbortDocument AbortDocument

印刷を中断する AbortDocuments AbortDocuments

印刷を再開する RestartDocument RestartDocument

印刷を再開する RestartDocuments RestartDocuments

文書を削除する DeleteDocument DeleteDocument

プリンタキュー情報を取

得する

GetPrinterQueueDocuments GetPrinterQueueDocuments

プリンタキューの優先順

位を変更する

UpdatePrinterQueueDocument UpdatePrinterQueueDocumen

t

プリンタキューの優先順

位を変更する

UpdatePrinterQueueDocuments UpdatePrinterQueueDocuments


89


WebServiece I/F UDK

■文書関連

停止文書の印刷先を変

更する

ChangePrinter ChangePrinter

印刷データを取得する GetPrintData CreatePrintData

プリンタプロパティを指定

して印刷データを取得す

る

GetPrintDataWithProperties CreatePrintData

プリンタプロパティとコメン

トを指定して印刷データ

を取得する

GetPrintDataWithPropertiesA

ndComments

CreatePrintData

印刷データを生成し、ダ

ウンロードするための

PATHを取得する

GetPrintDataPath CreatePrintData

指定プリンタプロパティで

作成した印刷データを生

成しダウンロードするため

のPATHを取得する

GetPrintDataPathWithProperti

es

CreatePrintData

指定プリンタプロパティと

コメントで作成した印刷

データを生成しダウンロー

ドするための PATH を取

得する

GetPrintDataPathWithProperti

esAndComments

CreatePrintData

■ゴミ箱関連

文書をゴミ箱へ移動する MoveDocumentToTrash MoveDocumentToTrash

ゴミ箱から文書を復帰す

る

RestoreDocumentFromTrash RestoreDocumentFromTrash

ゴミ箱を空にする ClearTrash ClearTrash


90

6 エラーコード

ここではエラーコードについて説明します。該当するエラーコードを参照してください。

エラー

コードエラーメッセージ

エラー内容と

対処方法

-9000 サーバ側で例外が発生しました。［エラー内容］

サーバ側で何らかの例外が発生しています。

［対処方法］

ログによる詳細確認が必要です。

-9001 セッションが見つかりません。［エラー内容］

設定された時間操作が無かった為、セッ

ション情報が失われました。

［対処方法］

ログインしなおしてください。

-9005 ユーザがグループに所属していませ

ん。

［対処方法］

ユーザをグループに所属させてください。

-9007 パスワードに誤りがあります。［エラー内容］

パスワードに誤りがあります。

［対処方法］

パスワードを確認してください。

-9010 RDサーバへの接続に失敗しました。［エラー内容］

RDサーバへの接続に失敗しています。

［対処方法］


-9011 RDサーバと接続中にIOエラーが発生

しました。

［エラー内容］

IOエラーが発生しています。

［対処方法］


-9013 文書の中断に失敗しました。［対処方法］

文書の中断に失敗しています。

-9016 印刷ページが指定されていません。［対処方法］

印刷ページを正しく指定してください。

-9017 文書が印刷できない状態です。［エラー内容］

文書のステータスは現在文書を印刷でき

る状態ではありません。

すでに印刷中の場合もあります。印刷中文

書は印刷できません。

-9019 表示可能文書数を超えました。［対処方法］

表示文書数が制限する数を超えました。


91

エラー


エラー内容と

対処方法

-9022 処理を行う権限がありません。［対処方法］

該当処理について、所属するグループには

権限がありません。

-9023 文書の停止／再開に失敗しました。［対処方法］

停止／再開できない文書ステータスとなっ

ています。

停止状態にできるのは、文書ステータスが

「印刷待ち」「印刷準備中」「印刷データ作

成中」「印刷データ作成完了」のものとなり

ます。それ以外のステータスの場合は停止

できません。

-9024 文書の停止／再開に失敗しました。［エラー内容］

停止／再開できない文書属性となってい

ます。

［対処方法］

文書のステータスを確認してください。

-9025 文書の停止／再開に失敗しました。［エラー内容］

印刷キューに文書が存在していないため、

停止／再開できません。

-9026 文書の印刷先変更に失敗しました。［エラー内容］

印刷先を変更できない文書ステータスと

なっています。印刷先の変更が可能な文書

は、文書ステータスが「印刷待ち」「印刷

データ作成完了」の文書のみとなります。

［対処方法］

文書のステータスを確認してください。


印刷先を変更できない文書属性となって

います。


印刷キューに文書が存在していないため、

印刷先を変更できません。


変更前のプリンタ名が異なっているため、印

刷先を変更できません。

-9032 パスワードに誤りがあります。［エラー内容］

パスワードに誤りがあるか、パスワードの暗号

化に失敗しています。

-9033 プリンタの一時停止／再開に失敗し

ました。


プリンタの状態が、一時停止または再開で

きる状態ではありません。

-9034 ユーザはロックされています。［対処方法］

RD環境設定の［セキュリティ設定］画面で、

ユーザの状況を確認の上、ロック解除など

の対処をおこなってください。


92

エラー


エラー内容と

対処方法

-9035 同一ユーザ名で既にログインされてい

ます。


同一ユーザ名で既にログインされています。

［対処方法］

別のユーザ名でログインするか、すでにログ

インしているユーザをログアウトさせてくださ

い。

-9036 パスワードは有効期限切れです。［エラー内容］

パスワードの有効期限が切れています。

［対処方法］

パスワードを変更してください。

-9037 指定されたパスワードは最近使われて

いるため使用不可です。


指定されたパスワードは最近使われている

ため使用できません。

［対処方法］

別のパスワードを使用してください。

-9038 パスワードが変更されていません。［エラー内容］

パスワードが変更されていません。

［対処方法］

パスワードの変更をおこなってください。

-9040 印刷可能なプリンタ機種ではありませ

ん。


印刷可能なプリンタ機種ではありません。

［対処方法］

印刷可能なプリンタ機種で印刷をおこなっ

てください。

-9041 ページ指定による印刷ができない文書

です。


帳票をスプールする際に、ページ指定不可

と設定しているため、ページ指定がおこなえ

ません。

［対処方法］

印刷をおこないたい場合は、全ページを出

力してください。再度同一の帳票がスプー

ル可能な場合は、ページ指定可能な状態

でスプール後、ページ指定印刷をおこなっ

てください。

-9042 ビューできない文書です。［対処方法］

帳票をスプールする際に、ビュー不可と設

定しているため、ビューがおこなえません。


異なるプリンタ機種の為、印刷先を変更で

きません。

［対処方法］

同一のプリンタ機種に印刷先を変更する

か、印刷をいったん中断した後に再度印刷

指示をおこなってください。


93

エラー


エラー内容と

対処方法


異なるサーバの為、印刷先を変更できませ

ん。

［対処方法］

同一サーバのプリンタに印刷先を変更する

か、印刷をいったん中断した後に再度印刷

指示をおこなってください。

-9100 ログインしていません。［エラー内容］

ログインしていない為、機能を使用できませ

ん。

［対処方法］

ログインしてください。

-9101 機能は実装されていません。［エラー内容］

接続先のRDEサーバのバージョンでは、呼び

出した機能がサポートされていません

［対処方法］

接続先RDEのバージョンアップをおこなうか、

エラーの発生した機能を使わないようにし

てください。

-9103 接続先を変更できません。［エラー内容］

接続先を変更できない設定がされていま

す。

［対処方法］

「rdsdk.properties」内での設定内容を確

認してください。

-9104 文書が削除できない状態です。［エラー内容］

文書のステータスは現在文書を削除でき

る状態ではありません。

-9105 文書がごみ箱へ移動できない状態で

す。


文書のステータスは現在文書をゴミ箱へ

移動できる状態ではありません。

-9108 パスワード桁数が制限されています。［対処方法］

制限内の長さのパスワードを指定してくださ

い。

-9109 パスワード変更を要求されています。［対処方法］

ChangeUserPasswordメソッドを使い、パス

ワードを変更してください。

-9110 パスワードの変更が出来ない状態で

す。


ログイン状態が「パスワード変更待ち」以外

の状態の時にパスワードを変更しようとしま

した。

［対処方法］

ログイン状態を確認してください。

-9111 文書の印刷先変更ができない状態で

す。

［対処方法］

同一機種のプリンタに変更してください。


94

エラー


エラー内容と

対処方法

-9112 propert ies ファイルの読み込みに失

敗しました。


指定されたpropertiesファイルが無効です。

［対処方法］

正しいpropertiesファイルを指定してくださ

い。

-9113 接続先はサポートされないバージョンで

す。

［対処方法］

接続先システム(RDE)のバージョンを確認し

てください。

-9999 評価期限が切れました。［対処方法］

評価の為のライセンス期限を越えました。

モジュールを更新してください

7 注意事項・制限事項

95


RDE UDKを使用する上での注意事項・制限事項はつぎの通りです。

RDE UDKでは、「RD環境設定」など管理者用の設定メニュー機能はAPIとして提供し

ていません。

スプール文書のステータスによっておこなえる処理が異なります。

文書ステータス印刷印刷

中断

停止/

再開

出力先の

変更

削除ごみ箱へ

移動

状態不明

文書ステータスが不明です。 × × × × ○ ○

スプール中

RDEにスプール中です。 × × × × × ×

スプール完了

RDE へのスプールが完了し

ました。

○ × × × ○ ○

スプール失敗

スプール処理中にエラーが発

生しました。

× × × × ○ ○

印刷待ち

印刷文書がプリンタキュー

（印刷待ち文書の待ち順）に

ある状態です。

× ○ ○ ○※1 × ×

印刷中

プリンタでの印刷が実行中です。 × ○ × × × ×

印刷完了

印刷処理が完了しました。 ○ × × × ○ ○

印刷中断

印刷が中断されました。 ○ × × × ○ ○

異常終了

印刷処理中にエラーが発生

しました。

○ × × × ○ ○

印刷停止

印刷処理が停止されていま

す。

○ × × × ○ ○

注意事項


96

文書ステータス印刷印刷

中断

停止/

再開

出力先の

変更

削除ごみ箱へ

移動

中断中

印刷中断の処理中です。 × × × × × ×

準備中

印刷支持後、プリンタキュー

（印刷待ち文書の待ち順）に

入るまでの状態です。

× × ○ × × ×

印刷データ作成中

プリンタへ送信する印刷デー

タを作成中です。

× ○ ○ × × ×

印刷データ作成完了

プリンタへ送信する印刷デー

タを作成完了しました。

× ○ ○ ○※1 × ×

プリンタ準備待ち

印刷データ作成完了後、

プリンタが印刷可能か

チェック中の状態です。

× ○ × × × ×

○＝実行（メニュー選択）可能です。

△＝実行（メニュー選択）可能ですが、何らかのエラーが発生します。

×＝実行（メニュー選択）不可能です。

※1：文書の印刷停止状態の場合に出力先の変更が可能となります。

RDEサーバ内のデータベースに、別サーバ上から接続する場合は、「pg_hba.conf」に

localhost以外からの接続を許可する設定をおこなう必要があります。

Windowsで使用する場合は、

%FIT_PRODUCTS_BASE%\rdjava\pgsql\data\pg_hba.conf内につぎの記述を追

加します。

接続タイプ、データベース名、ユーザ名、ネットワークアドレス、ネットマスク、認証方法の種類、オプション

例

host rddb svf 10.46.70.44 255.255.0.0 trust

UNIX、Linuxで使用する場合は、$FIT_PRODUCTS_BASE/rdjava/pgsql/data/

pg_hba.conf内につぎの記述を追加します。

接続タイプ、データベース名、ネットワークアドレス、ネットマスク、認証方法の種類

例

host rddb 10.46.70.44 255.255.0.0 trust


97

構成上の注意

「RD環境設定」でRDサーバのアドレスを「localhost」、または「127.0.0.1」を指定している

場合は、RDE UDKをRDサーバと別筐体で使用することはできません。

印字位置調整機能を使用する場合の注意

印字位置調整機能を使用する場合は、ClientIDを各プログラム・RDユーティリティで重

複しないように設定してください。重複した場合、同一ClientIDでは同じ設定が有効と

なるため、他のプログラム・RDユーティリティで設定した値が有効となってしまい、意図し

た印刷結果が得られない場合があります。

マルチスレッド動作について

同一のRdConnectオブジェクトに対して、複数のスレッドから同時にメソッドを呼び出した

際の動作は保障されませんので、おこなわないようにしてください。

別インスタンスに対するアクセスの場合は、マルチスレッド動作が可能です。

RdDbWrapper.jarに含まれるバージョン情報をもとに接続先のRDEサーバのバージョンを

判定するため、classpathに指定するRdDbWrapper.jarは、かならず接続するRDEのバー

ジョンと同じものを使用してください。

接続先可変モードで動的に接続先を切り替える場合、同時に異なるバージョンのRDE

サーバとは接続できません。

RDE用ActiveXプラグイン（以下、「RDE ActiveX」）について

RDE UDKでは、RDE ActiveXを利用している機能に対応していません。そのため、つぎ

の機能は使用できません。

・クライアントプリンタの情報取得・登録

・クライアントプリンタからの印刷

・プレビュー

全文検索機能

RDE UDKを使用する場合は全文検索機能は使用できません。

印刷指示はRDE UDKと非同期でおこなわれるため、印刷実行後の文書ステータスに

ついては再読み込み・更新により確認する必要があります。

RDE Ver.2.5 以降では、プリンタキューが空の時にGetPrinterQueueDocuments()を実

行するとErrorCode = -7103（クエリー結果が 0 件です）というエラーコードが返されます

が、これは正常な動作です。

以下のメソッドは監査ログに対応していません。

・AbortDocuments(int[] docNums)

制限事項


98

・PrintToServerPrinter(ServerPrinter printer, int[] docNums, PrintAttributes pas)

・RestartDocuments(int[] docNums)

・StopDocuments(int[] docNums)

・TestPrintToServerPrinter(ServerPrinter printer, int[] docNums, PrintAttributes

pas)

・UpdatePrinterQueueDocuments(QueueDocument[] docs, int updateKind)

RdConnectCreator#init ial izeDbConnectionPool ingは、通常ユーザアプリケーションから

明示的に呼び出す必要はありませんが、サーブレットの初期化時にあらかじめDB接続

を確立しておきたい等の理由で、呼び出すこともできるように公開しています。

このメソッドはアプリケーションの初期化時に一度だけ呼び出されることを想定していま

す。そのため、init()メソッド内での利用等にとどめてください。アプリケーションの動作中に

再呼び出しがおこなわれるようなコーディングはしないでください。

同様に、RdConnectCreator#final izeDbConnectionPool ingもdestroy()メソッド内での

利用等にとどめ、アプリケーションが終了する前に 1 度だけ呼び出されるようにしてくださ

い。

索引-1

索引 ····························································································································································································

Ｃ

CLASSPATH......................................................8

Ｄ

Db.ConnectionMode ........................................10

Db.ConnectionTimeout....................................10

Db.MaxConnection ..........................................10

Db.Password ....................................................10

Db.Url ..............................................................10

Db.UseDriver...................................................10

Db.User ............................................................10

defineColumnInfo............................................85

doc ......................................................................7

document .........................................................82

documentFilter ................................................80

Ｅ

encoding .............................................................9

Ｊ

JavaDoc............................................................41

jp.co.fit.rd.api...................................................41

Ｌ

Log.FileEncoding...............................................9

Log.FileOut........................................................9

Log.Level............................................................9

Log.LogDir .........................................................9

Log.Mode............................................................9

Log.OutputFileName ........................................9

Log.SystemOut ..................................................9

Log.SystemOutLevel .........................................9

Ｎ

nameAndValue................................................ 85

Ｐ

PATH を取得.................................................... 76

printAttributes................................................ 81

Ｑ

queueDocument .............................................. 83

Ｒ

RdDbWrapper.jar .............................................. 4

RDE UDK.......................................................... 1

RDE Utility Developers KIT ............................ 1

RDESDK.jar...................................................... 7

rdjava ................................................................ 7

rdsdk.properties............................................ 7, 8

Ｓ

Sample.java..................................................... 12

Samples ............................................................. 7

serverPrinter................................................... 81

Session.MaxInactiveInterval ......................... 10

Ｕ

userInfo ........................................................... 80

Ｗ

Web サービス版 ............................................... 42

い

印刷機能............................................................. 2

印刷属性........................................................... 81

印刷データを取得 .......................................74, 75

印刷を再開........................................................71

印刷を再開す ....................................................71

印刷を実行..................................................65, 67

印刷を中断..................................................70, 71

印刷を停止........................................................70

インタフェースクラス ......................................80

え

エラーコード ....................................................90

エンコーディング ...............................................9

か

階層ツリー........................................................41

可変接続先モード .............................................10

監査ログ ...........................................................97

く

クラスライブラリ .............................................41

クラスライブラリ側オプション..........................8

こ

固定接続先モード .............................................10

ゴミ箱から文書を復帰 ................................79, 83

ゴミ箱へ移動 ....................................................79

ゴミ箱を空にする .............................................79

コメントを指定して印刷を実行........................66

さ

サーバプリンタ関連機能 ....................................2

サーバプリンタクラス ......................................81

サーバプリンタ情報一覧を取得........................59

サーバプリンタ情報を取得...............................59

サーバプリンタのステータスを取得 ................60

サーバプリンタのプロパティを変更 ................62

サーバプリンタ名一覧を取得........................... 58

サーバプリンタを再開 ..................................... 61

サーバプリンタを停止 ..................................... 61

サンプルプログラム ............................. 12, 19, 46

し

システム要件.................................................... 42

す

ステータス ....................................................... 95

せ

制限事項........................................................... 97

セッション ....................................................... 44

接続ドライバ.................................................... 10

接続モード ....................................................... 10

接続ユーザのパスワード.................................. 10

接続ユーザ名.................................................... 10

セットアップ................................................ 8, 43

た

タイムアウト時間 ............................................ 10

タイムアウト設定 ............................................ 45

ち

注意事項........................................................... 95

て

停止文書の印刷先を変更.................................. 73

データベースへの最大接続数..................... 10, 11

データベースへの接続 URL............................. 10

テスト印刷を実行 ................................ 67, 68, 69

デバッグログの出力先ディレクトリ .................. 9

デバッグログの出力モード ................................ 9

デバッグログの出力レベル ................................ 9

索引-3

デバッグログの標準出力 ....................................9

デバッグログのファイル出力 .............................9

デバッグログのファイル出力レベル ..................9

デバッグログファイルのエンコーディング........9

デバッグログファイル名 ....................................9

と

同期 ..................................................................45

動作環境 .............................................................7

動的コメント ......................................................5

は

バージョンの確認 .............................................11

パッケージ........................................................41

ひ

日付型フィールド .............................................44

ふ

ファイル構成 ......................................................7

ファイルダウンロード機能.................................2

プリンタ機種のデフォルトプロパティを取得 ..58

プリンタ機種名一覧を取得.........................57, 63

プリンタキューの優先順位を変更 ....................73

プリンタキュー文書情報一覧を取得 ................72

プリンタキュー文書の優先順位を変更 .............72

文書管理番号を取得 .........................................65

文書クラス ....................................................... 82

文書項目番号.................................................... 86

文書情報取得...................................................... 2

文書情報を取得 .......................................... 63, 64

文書抽出条件クラス ......................................... 80

文書を削除 ....................................................... 72

へ

ページ数の取得 .................................................. 6

め

メソッド........................................................... 87

ゆ

ユーザ情報クラス ............................................ 80

ユーザ情報を更新 ............................................ 55

ユーザ情報を取得 ............................................ 54

ユーザ追加情報 ................................................ 52

ユーザ定義カラム情報 ..................................... 85

ユーザ定義カラム情報を取得........................... 56

ユーザ名を取得 ................................................ 55

ろ

ログアウト ....................................................... 53

ログイン..................................................... 52, 53

ログイン機能...................................................... 2

ログイン状態を取得 ......................................... 54

索引-4

RDE Utility Developers KIT ユーザーズ・マニュアル Ver.8.0

2008年 3月第1版販売元：ウイングアークテクノロジーズ株式会社［本社］〒108-0075 東京都港区港南 1-8-15 W ビル 14F

TEL：03-6710-1700（代表） FAX：03-6710-1701

ホームページ：http://www.wingarc.co.jp

開発元：株式会社エフ・アイ・ティ

〒102-0071 東京都千代田区富士見 2-14-37 FUJIMI EAST 2F

※本マニュアルに記載されている社名および商品名は、一般に各社の商標および登録商標です。 ※本マニュアルは予告なく変更することがあります。