WebReportCafe Server SOAPインタフェースガイド

WRC Server SOAP インターフェースガイド
2
SOAPインターフェースガイド
目次
SOAPインフェースガイド..........................................................................................................................................................................................3
概要..........................................................................................................................................................................................................................3
1.SQLReportServiceサービス........................................................................................................................................................................3
1 – 1 requestPdfDataメソッド.........................................................................................................................................................................4
1 – 2 requestSavingPdfDataメソッド...........................................................................................................................................................5
1 – 3 requestPdfURLメソッド...........................................................................................................................................................................5
1 – 4 requestSavingPdfURLメソッド.............................................................................................................................................................5
1 – 5 requestPdfMailメソッド.........................................................................................................................................................................6
1 – 6 requestSavingPdfMailメソッド...........................................................................................................................................................7
1 – 7 requestPdfMailメソッド.........................................................................................................................................................................7
1 – 8 requestSavingPdfMailメソッド...........................................................................................................................................................8
1 – 9 requestPrintDataメソッド....................................................................................................................................................................8
2.XMLReportServiceサービス........................................................................................................................................................................9
2 – 1 requestPdfDataメソッド......................................................................................................................................................................10
2 – 2 requestPdfDataWithXMLFormメソッド.............................................................................................................................................10
2 – 3 requestSavingPdfDataメソッド........................................................................................................................................................10
2 – 4 requestSavingPdfDataWithXMLFormメソッド...............................................................................................................................10
2 – 5 requestPdfURLメソッド........................................................................................................................................................................10
2 – 6 requestPdfURLWithXMLFormメソッド...............................................................................................................................................10
2 – 7 requestSavingPdfURLメソッド...........................................................................................................................................................11
2 – 8 requestSavingPdfURLWithXMLFormメソッド..................................................................................................................................11
2 – 9 requestPdfMailメソッド.......................................................................................................................................................................11
2 – 10 requestPdfMailWithXMLFormメソッド...........................................................................................................................................11
2 – 11 requestSavingPdfMailメソッド......................................................................................................................................................12
2 – 12 requestSavingPdfMailWithXMLFormメソッド.............................................................................................................................12
2 – 13 requestPdfMailメソッド....................................................................................................................................................................12
2 – 14 requestPdfMailWithXMLFormメソッド..........................................................................................................................................12
2 – 15 requestSavingPdfMailメソッド......................................................................................................................................................13
2 – 16 requestSavingPdfMailWithXMLFormメソッド.............................................................................................................................13
2 – 17 requestPrintDataメソッド...............................................................................................................................................................13
2 – 18 requestPrintDataWithXMLFormメソッド......................................................................................................................................13
3.CSVReportServiceサービス......................................................................................................................................................................14
3 – 1 requestPdfDataメソッド......................................................................................................................................................................14
3 – 2 requestSavingPdfDataメソッド........................................................................................................................................................15
3 – 4 requestSavingPdfURLメソッド..........................................................................................................................................................15
3 – 5 requestPdfMailメソッド......................................................................................................................................................................15
3 – 6 requestSavingPdfMailメソッド........................................................................................................................................................16
3 – 7 requestPdfMailメソッド......................................................................................................................................................................16
3 – 8 requestSavingPdfMailメソッド........................................................................................................................................................17
3 – 9 requestPrintDataメソッド.................................................................................................................................................................17
4.WRSUtilServiceサービス...........................................................................................................................................................................18
4 – 1 getCreatedPDFメソッド........................................................................................................................................................................18
4 – 2 getPrinterAliasNameListメソッド.................................................................................................................................................18
4 – 3 getFolderListメソッド........................................................................................................................................................................18
4 – 4 getReoportListメソッド......................................................................................................................................................................19
4 – 5 getCreatedReoportDateListメソッド.............................................................................................................................................19
Copyright(C) SIOS Technology, Inc.
3
SOAPインターフェースガイド
SOAP インフェースガイド
概要
WRC ServerではPDFの作成及び、帳票の印刷要求を行うために、Webサービス(SOAP)のインターフェースを提
供しています。このドキュメントでは WRC ServerのSOAPインタフェースについて説明します。
・WRC ServerではSOAPプロトコルを使用して、4種類のWeb サービスを使用することが出来ます。
No サービス名
説明
1
SQLReportService
レポートを要求するサービスです。データソースが SQLの場合に使用します。
2
XMLReportService
レポートを要求するサービスです。データソースが XMLの場合に使用します。
3
CSVReportService
レポートを要求するサービスです。データソースが CSV の場合に使用します。
4
WRSUtilService
WRC Serverで提供している様々なサービスを要求することができます。
生成済み PDFの取得、プリンター別名の取得、ダイレクト印刷の再印刷などの
要求をすることができます。
1.SQLReportService サービス
レポートで使用するデータソースが SQLの場合に使用します。
SQLReportServiceサービスにはレポートを要求する9種類のメソッドがあります。
項目名
URL アドレス
http://localhost:8080/wrs/services/SQLReportService
SOAPエンドポイント
WSDLファイル
http://localhost:8080/wrs/services/SQLReportService?wsdl
※ホスト名(localhost)及びポート番号(8080)は環境に応じて変更して下さい。
No メソッド名
1
requestPdfData
説明
作成されたPDFのバイト配列を取得します。
2
requestSavingPdfData
3
requestPdfURL
作成された PDF のバイト配列を取得します。又、サーバー上に PDF ファイルを
出力します。
作成されたPDFのURLを取得します。
4
requestSavingPdfURL
5
requestPdfMail
6
requestSavingPdfMail
7
requestPdfMail
8
requestSavingPdfMail
9
requestPrintData
作成された PDF の URL を取得します。又、サーバー上に PDF ファイルを出力
します。
作成されたPDFをメール送信します。
作成された PDF をメール送信します。又、サーバー上に PDF ファイルを出力し
ます。
作成されたPDFをメール送信します。
※No3のメソッドとは引数が異なります。
作成された PDF をメール送信します。又、サーバー上に PDF ファイルを出力し
ます。
※No3のメソッドとは引数が異なります。
プリンターにダイレクトに出力します。
Copyright(C) SIOS Technology, Inc.
4
SOAPインターフェースガイド
1 – 1 requestPdfData メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。
戻り値:byte[] (バイト配列)
順序
パラメーター名
型
説明
第1引数
第2引数
第3引数
第4引数
第5引数
folderName
reportAppName
userId
password
xmlParam
String
String
String
String
String
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
SQLパラメーター
実行する帳票定義ファイルの SQL のWhere 句にパラメーター(:パラメータ名(コロン
+パラメータ名))が埋め込まれている場合、 このプロパティに、XML 形式のパラメ
ータを指定できます。
指定するXMLの文法は下記のようになります。
<ParamSet>
<Param Name="[パラメーター名1]" Type="[タイプ文字列1]">[値1]</Param>
<Param Name="[パラメーター名2]" Type="[タイプ文字列2]">[値2]</Param>
</ParamSet>
第6引数
isPrivate
boolean
第7引数
directPrint
boolean
第8引数
第9引数
printerAliasName
sql
String
String
タイプ文字列と型の対応は下記の通りです。
型
タイプ文字列
フォーマット
STRING
STRING型
SHORT
SHORT型
LONG
LONG型
INT
INT型
FLOAT
FLOAT型
DOUBLE
DOUBLE型
BOOLEAN
BOOLEAN型
BIGDECIMAL型 BIGDECIMAL
DATE
yyyy/MM/dd
DATE型
TIME
HH::mm:ss
TIME型
TIMESTAMP
yyyy/MM/dd HH:mm:ss
TIMESTAMP型
配布先の指定
true:Private実行
false:Public実行
ダイレクト印刷の指定
true:プリンター出力有り
false:プリンター出力無し
プリンター出力する場合のプリンターの別名
SQL 文字列。このパラメーターに SQL をセットした場合、帳票を作成する際、この
SQLが優先して使用されます。
※WRC Server側で、SQLの置換を許可している場合のみ、指定可能です。
Copyright(C) SIOS Technology, Inc.
5
第 10
引数
弟 11
引数
SOAPインターフェースガイド
sqlReplaceRule
sendMailOnError
String
boolean
SQL置換規則プロパティ.
SQL に埋め込まれた置換文字列“/* [置換文字列名] */”を置換するための置換規則文
字列を指定します。
置換規則文字列とは、属性name に置換文字列名、属性value に置き換えられる文字
列をセットした複数の<replace>タグを <rule>または<rule2>で挟んだ XML データ
です。
[例]下記のSQL文を設定した場合
select * from product where cost = /* cost */ or product_name = /* name */
<rule>
<replace name="cost" value="20000"/>
<replace name="name" value="'キーボード'"/>
</rule>
または
<rule2>
<replace name="cost">20000</replace>
<replace name="name">'キーボード'</replace>
</rule2>
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレスにエラーを
送信します。falseを指定すると、エラーが発生してもメールが送信されません。
1 – 2 requestSavingPdfData メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
パラメーターはrequestPdfDataメソッドに第12引数が追加されたメソッドです。
弟 12
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
1 – 3 requestPdfURL メソッド
■メソッド説明
説明:作成されたPDFのURL を取得します。
戻り値:String <例> http://localhost:8080/wrs/[email protected]=345
パラメーターはrequestPdfDataメソッドと同様です。
1 – 4 requestSavingPdfURL メソッド
■メソッド説明
説明:作成されたPDFのURL を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:String <例> http://localhost:8080/wrs/[email protected]=345
パラメーターはrequestSavingPdfDataメソッドと同様です。
Copyright(C) SIOS Technology, Inc.
6
SOAPインターフェースガイド
1 – 5 requestPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
xmlParam
型
String
String
String
String
String
mailBean
jp.co.ten
artni.wr
s.def.Ma
ilDescri
ption
第7引数
mailType
String
第8引数 isPrivate
第9引数 directPrint
第10引数 printerAliasNa
me
第11引数 sql
boolean
boolean
String
第12引数 sqlReplaceRule
弟 13 引 sendMailOn
Error
数
String
boolean
String
説明
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
SQLパラメーター
メール情報の構造体
タイプ文字列と型の対応は下記の通りです。
名前
説明
to
メールToアドレス
※指定しない場合は、レポート実行者のアドレスが設定されま
す。
from
メールFromアドレス
※指定しない場合は、「システムプロパティ登録」画面で登録さ
れた「メールアドレス(FROM)」が設定されます。
※WRC Server側で、メールFromアドレスの置換を許可して
いる場合のみ、指定可能です。
cc
メールのCCアドレス
Bcc
メールのBccアドレス
body
メールの本文
※指定しない場合は、「システムプロパティ登録」画面で登録さ
れた「メール本文」が設定されます。
【メール置換パラメーター】
$FOLDER_NAME$・・・メール送信時にフォルダー名に置換
されます。
$REPORT_NAME$・・・メール送信時にレポート名に置換さ
れます。
$URL$・・・メール送信時にレポートのURLに置換されます。
subject
メールの題名
※指定しない場合は、「システムプロパティ登録」画面で登録さ
れた「メール題名」が設定されます。
replyTo
メールreplyToアドレス
メール送信タイプ文字列の指定
メール送信タイプ文字列
内容
ATTACHED_PDF_MAIL
PDFを添付する場合
COMPLETION_MAIL
PDFを添付しない場合
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
SQL文字列
※WRC Server側で、SQLの置換を許可している場合のみ、指定可能です。
SQL置換規則プロパティ
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレスにエラーを送
信します。falseを指定すると、エラーが発生してもメールが送信されません。
Copyright(C) SIOS Technology, Inc.
7
SOAPインターフェースガイド
1 – 6 requestSavingPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します。又、サーバー上に PDFファイルを出力します。
戻り値:なし
パラメーターはrequestPdfMailメソッドに第14引数が追加されたメソッドです。
弟 14
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
1 – 7 requestPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
メールの構造体(MailDescriptionクラス)を使用しない場合はこのメソッドを使用して下さい。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
xmlParam
from
型
String
String
String
String
String
String
第7引数
to
String
第8引数
subject
String
第9引数
body
String
第10引数
mailType
String
第11引数
第12引数
第13引数
第14引数
isPrivate
directPrint
printerAliasName
sql
boolean
boolean
String
String
第15引数
sqlReplaceRule
String
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
SQLパラメーター
メールFromアドレス
※指定しない場合は、「システムプロパティ登録」画面で登録された「メー
ルアドレス(FROM)」が設定されます。
※WRC Server側で、メールFromアドレスの置換を許可している場合の
み、指定可能です。
メールToアドレス
※指定しない場合は、レポート実行者のアドレスが設定されます
メールの題名
※指定しない場合は、「システムプロパティ登録」画面で登録された「メー
ル題名」が設定されます。
メールの本文
※指定しない場合は、「システムプロパティ登録」画面で登録された「メー
ル本文」が設定されます。
【メール置換パラメーター】
$FOLDER_NAME$・・・メール送信時にフォルダー名に置換されます。
$REPORT_NAME$・・・メール送信時にレポート名に置換されます。
$URL$・・・メール送信時にレポートのURLに置換されます。
メール送信タイプ文字列
メール送信タイプ文字列
内容
ATTACHED_PDF_MAIL
PDFを添付する場合
COMPLETION_MAIL
PDFを添付しない場合
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
SQL文字列
※WRC Server側で、SQLの置換を許可している場合のみ、指定可能で
す。
SQL置換規則プロパティ
Copyright(C) SIOS Technology, Inc.
8
弟 16 引数
SOAPインターフェースガイド
sendMailOnErr
or
boolean
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
1 – 8 requestSavingPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します。又、サーバー上に PDFファイルを出力します。
メールの構造体(MailDescriptionクラス)を使用しない場合はこのメソッドを使用して下さい。
戻り値:なし
パラメーターはrequestPdfMailメソッドに第17引数が追加されたメソッドです。
弟 17
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
1 – 9 requestPrintData メソッド
■メソッド説明
説明:帳票を作成しサーバのプリンターでダイレクトに印刷します。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
xmlParam
mailType
型
String
String
String
String
String
String
第7引数
第8引数
第9引数
isPrivate
printerAliasName
sql
boolean
String
String
第10引数
第11引数
sqlReplaceRule
synchronize
String
boolean
弟 12 引数
sendMailOnErr
or
boolean
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
SQLパラメーター
プリンターキューへの出力が完了した際、メールを送信するかどうか
メール送信タイプ文字列
(注意)COMPLETION_MAILのみ使用可能です
配布先の指定
プリンター出力する場合のプリンターの別名
SQL文字列
※WRC Server側で、SQLの置換を許可している場合のみ、指定可能で
す。
SQL置換規則プロパティ
true をセットした場合、印刷ジョブをキューに出力するまで待
機する。false をセットした場合ジョブを待機しない。
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
Copyright(C) SIOS Technology, Inc.
9
SOAPインターフェースガイド
2.XMLReportService サービス
レポートで使用するデータソースが XMLの場合に使用します。
XMLReportServiceサービスにはレポート要求する18.種類のメソッドがあります。
項目名
URL アドレス
http://localhost:8080/wrs/services/XMLReportService
SOAPエンドポイント
WSDLファイル
http://localhost:8080/wrs/services/XMLReportService?wsdl
※ホスト名(localhost)及びポート番号(8080)は環境に応じて変更して下さい。
No メソッド名
1
requestPdfData
説明
作成されたPDFのバイト配列を取得します。
2
requestPdfDataWithXMLForm
作成されたPDFのバイト配列を取得します。
3
requestSavingPdfData
5
作成された PDF のバイト配列を取得します。又、サーバ
ー上にPDFファイルを出力します。
requestSavingPdfDataWithXMLForm 作成された PDF のバイト配列を取得します。又、サーバ
ー上にPDFファイルを出力します。
requestPdfURL
作成されたPDFのURLを取得します。
6
requestPdfURLWithXMLForm
作成されたPDFのバイト配列を取得します。
7
requestSavingPdfURL
8
requestSavingPdfURLWithXMLForm
9
requestPdfMail
作成された PDF の URL を取得します。又、サーバー上
にPDFファイルを出力します。
作成された PDF のバイト配列を取得します。又、サーバ
ー上にPDFファイルを出力します。
作成されたPDFをメール送信します。
10
requestPdfMailWithXMLForm
作成されたPDFをメール送信します。
11
requestSavingPdfMail
12
requestSavingPdfMailWithXMLForm
13
requestPdfMail
作成された PDF をメール送信します。又、サーバー上に
PDFファイルを出力します。
作成された PDF をメール送信します。又、サーバー上に
PDFファイルを出力します。
作成されたPDFをメール送信します。
14
requestPdfMailWithXMLForm
作成されたPDFをメール送信します。
15
requestSavingPdfMail
16
requestSavingPdfMailWithXMLForm
17
requestPrintData
作成された PDF をメール送信します。又、サーバー上に
PDFファイルを出力します。
作成された PDF をメール送信します。又、サーバー上に
PDFファイルを出力します。
プリンターにダイレクトに出力します。
18
requestPrintDataWithXMLForm
プリンターにダイレクトに出力します。
4
※メソッド名+WithXMLForm のメソッドは引数として、帳票定義ファイルを渡せるメソッドです。
Copyright(C) SIOS Technology, Inc.
10
SOAPインターフェースガイド
2 – 1 requestPdfData メソッド
2 – 2 requestPdfDataWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。
戻り値:byte[] (バイト配列)
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
第7引数
第8引数
弟 9 引数
パラメーター名
folderName
reportAppName
userId
password
xmlSchema
isPrivate
directPrint
printerAliasName
sendMailOnEr
ror
型
String
String
String
String
String
boolean
boolean
String
boolean
説明
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
XMLスキーマデータ
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
※requestPrintDataWithXMLFormの場合は、「第5引数」と「第6引数」の間に下記パラメーターを指定出来ます。
パラメーター名
xmlForm
型
String
説明
帳票定義ファイル
※WRC Server側で、帳票定義ファイルの置換を許可している場合のみ、指定可能です。
2 – 3 requestSavingPdfData メソッド
2 – 4 requestSavingPdfDataWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
requestSavingPdfDataメソッドはrequestPdfDataメソッドに第10引数が追加されたメソッドです。
requestSavingPdfDataXMLFormメソッドはrequestPdfDataWithXMLFormメソッドに第11引数が追加されたメソッドです。
弟 10 、
11 引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
2 – 5 requestPdfURL メソッド
2 – 6 requestPdfURLWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのURL を取得をします。
戻り値:String <例> http://localhost:8080/wrs/[email protected]=345
パラメーターはrequestPdfDataメソッドと同様です。
Copyright(C) SIOS Technology, Inc.
11
SOAPインターフェースガイド
2 – 7 requestSavingPdfURL メソッド
2 – 8 requestSavingPdfURLWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
requestSavingPdfURLメソッドはrequestPdfDataメソッドに第10引数が追加されたメソッドです。
requestSavingPdfDataXMLFormメソッドはrequestPdfDataWithXMLFormメソッドに第11引数が追加されたメソッドです。
弟 10 、
11
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
2 – 9 requestPdfMail メソッド
2 – 10 requestPdfMailWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
xmlSchema
型
String
String
String
String
String
mailBean
jp.co.ten
artni.wrs
.def.Mail
Descripti
on
第7引数
mailType
String
メール送信タイプ文字列
第8引数
第9引数
第10引数
弟 11 引数
isPrivate
directPrint
printerAliasName
sendMailOnErro
r
boolean
boolean
String
boolean
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
説明
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
XMLスキーマデータ
メール情報の構造体
※requestPdfMailWithXMLFormの場合は、「第5引数」と「第6引数」の間に下記パラメーターを指定出来ます。
パラメーター名
xmlForm
型
String
説明
帳票定義ファイル
※WRC Server側で、帳票定義ファイルの置換を許可している場合のみ、指定可能で
す。
Copyright(C) SIOS Technology, Inc.
12
SOAPインターフェースガイド
2 – 11 requestSavingPdfMail メソッド
2 – 12 requestSavingPdfMailWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
requestSavingPdfMailメソッドはrequestPdfMailメソッドに第12引数が追加されたメソッドです。
requestSavingPdfMailWithXMLFormメソッドはrequestPdfMailWithXMLFormメソッドに第13引数が追加されたメソッド
です。
弟 12 、
13
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
2 – 13 requestPdfMail メソッド
2 – 14 requestPdfMailWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
メールの構造体(MailDescriptionクラス)を使用しない場合はこのメソッドを使用して下さい。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
第7引数
第8引数
第9引数
第10引数
第11引数
第12引数
第13引数
弟 14 引数
パラメーター名
folderName
reportAppName
userId
password
xmlSchema
from
to
subject
body
mailType
isPrivate
directPrint
printerAliasName
sendMailOnErro
r
型
String
String
String
String
String
String
String
String
String
String
boolean
boolean
String
boolean
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
XMLスキーマデータ
メールFromアドレス
※WRC Server側で、メールFromアドレスの置換を許可している場合の
み、指定可能です。
メールToアドレス
メールの題名
メールの本文
メール送信タイプ文字列
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
※requestPdfMailWithXMLFormの場合は、「第5引数」と「第6引数」の間に下記パラメーターを指定出来ます。
パラメーター名
xmlForm
型
String
説明
帳票定義ファイル
※WRC Server側で、帳票定義ファイルの置換を許可している場合のみ、指定可能で
す。
Copyright(C) SIOS Technology, Inc.
13
SOAPインターフェースガイド
2 – 15 requestSavingPdfMail メソッド
2 – 16 requestSavingPdfMailWithXMLForm メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
requestSavingPdfMailメソッドはrequestPdfMailメソッドに第15引数が追加されたメソッドです。
requestSavingPdfMailWithXMLFormメソッドはrequestPdfMailWithXMLFormメソッドに第16引数が追加されたメソッド
です。
弟 15 、
16
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
2 – 17 requestPrintData メソッド
2 – 18 requestPrintDataWithXMLForm メソッド
■メソッド説明
説明:帳票を作成しサーバのプリンターでダイレクトに印刷します。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
xmlSchema
isPrivate
型
String
String
String
String
String
boolean
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
XMLスキーマデータ
配布先の指定
第7引数
mailType
String
第8引数
printerAliasNam
e
String
プリンターキューへの出力が完了した際、メールを送信するかどうか
メール送信タイプ文字列
(注意)COMPLETION_MAILのみ使用可能です
プリンター出力する場合のプリンターの別名
第9引数
synchronize
boolean
true をセットした場合、印刷ジョブをキューに出力するまで待
機する。 false をセットした場合ジョブを待機しない
弟 10 引数
sendMailOnErr
or
boolean
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
※requestPrintDataWithXMLFormの場合は、「第5引数」と「第6引数」の間に下記パラメーターを指定出来ます。
パラメーター名
xmlForm
型
String
説明
帳票定義ファイル
※WRC Server側で、帳票定義ファイルの置換を許可している場合のみ、指定可能で
す。
Copyright(C) SIOS Technology, Inc.
14
SOAPインターフェースガイド
3.CSVReportService サービス
レポートで使用するデータソースが CSVの場合に使用します。
CSVReportService サービスにはレポート要求する5 種類のメソッドがあります。
(※注 サブレポートを含む帳票の場合、CSVReportService は利用できません。SQLReportService または
XMLReportServceを利用してください。)
項目名
URL アドレス
http://localhost:8080/wrs/services/CSVReportService
SOAPエンドポイント
http://localhost:8080/wrs/services/CSVReportService?wsdl
WSDLファイル
※ホスト名(localhost)及びポート番号(8080)は環境に応じて変更して下さい。
No メソッド名
1
requestPdfData
説明
作成されたPDFのバイト配列を取得します。
2
requestSavingPdfData
3
requestPdfURL
作成された PDF のバイト配列を取得します。又、サーバー上に PDF
ファイルを出力します。
作成されたPDFのURLを取得します。
4
requestSavingPdfURL
5
requestPdfMail
6
requestSavingPdfMail
7
requestPdfMail
8
requestSavingPdfMail
9
requestPrintData
作成された PDF の URL を取得します。又、サーバー上に PDF ファ
イルを出力します。
作成されたPDFをメール送信します。
作成された PDF をメール送信します。又、サーバー上に PDF ファイ
ルを出力します。
作成されたPDFをメール送信します。
作成された PDF をメール送信します。又、サーバー上に PDF ファイ
ルを出力します。
プリンターにダイレクトに出力します。
3 – 1 requestPdfData メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。
戻り値:byte[] (バイト配列)
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
第7引数
第8引数
弟 9 引数
パラメーター名
folderName
reportAppName
userId
password
csvData
isPrivate
directPrint
printerAliasName
sendMailOnError
型
String
String
String
String
String
boolean
boolean
String
boolean
説明
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
CSVデータ
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
Copyright(C) SIOS Technology, Inc.
15
SOAPインターフェースガイド
3 – 2 requestSavingPdfData メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:byte[] (バイト配列)
パラメーターはrequestPdfDataメソッドに第10引数が追加されたメソッドです。
弟 10
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
3 – 3 requestPdfURL メソッド
■メソッド説明
説明:作成されたPDFのURLを取得をします。
戻り値:String <例> http://localhost:8080/wrs/[email protected]=345
パラメーターは requestPdfData メソッドと同様です。
3 – 4 requestSavingPdfURL メソッド
■メソッド説明
説明:作成されたPDFのバイト配列を取得します。又、サーバー上に PDFファイルを出力します。
戻り値:String <例> http://localhost:8080/wrs/[email protected]=345
パラメーターはrequestPdfDataメソッドに第10引数が追加されたメソッドです。
弟 10
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
3 – 5 requestPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
csvData
型
String
String
String
String
String
mailBean
jp.co.ten
artni.wrs
.def.Mail
Descripti
on
第7引数
mailType
String
メール送信タイプ文字列。
第8引数
第9引数
第10引数
isPrivate
directPrint
printerAliasName
boolean
boolean
String
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
説明
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
CSVデータ
メール情報の構造体
Copyright(C) SIOS Technology, Inc.
16
弟 11 引数
SOAPインターフェースガイド
sendMailOnErro
r
boolean
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
3 – 6 requestSavingPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します。又、サーバー上に PDFファイルを出力します。
戻り値:なし
パラメーターはrequestPdfMailメソッドに第12引数が追加されたメソッドです。
弟 12
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
3 – 7 requestPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します
メールの構造体(MailDescriptionクラス)を使用しない場合はこのメソッドを使用して下さい。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
第7引数
第8引数
第9引数
第10引数
第11引数
第12引数
第13引数
弟 14 引数
パラメーター名
folderName
reportAppName
userId
password
csvData
from
to
subject
body
mailType
isPrivate
directPrint
printerAliasName
sendMailOnError
型
String
String
String
String
String
String
String
String
String
String
boolean
boolean
String
boolean
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
CSVデータ
メールFromアドレス
※WRC Server側で、メールFromアドレスの置換を許可している場合の
み、指定可能です。
メールToアドレス
メールの題名
メールの本文
メール送信タイプ文字列
配布先の指定
ダイレクト印刷の指定
プリンター出力する場合のプリンターの別名
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
Copyright(C) SIOS Technology, Inc.
17
SOAPインターフェースガイド
3 – 8 requestSavingPdfMail メソッド
■メソッド説明
説明:作成されたPDFをメール送信します。又、サーバー上に PDFファイルを出力します。
戻り値:なし
パラメーターはrequestPdfMail(3-6)メソッドに第15引数が追加されたメソッドです。
弟 15
引数
hostPdfFileName
String
サーバーのファイルディレクトリに保存するPDFファイル名
このプロパティを使用する場合は、wrs.config ファイルの「HostPdfFileDir」属性を必
ず指定する必要があります。ここで指定するファイル名は、「HostPdfFileDir」以下の
パスを指定します。
3 – 9 requestPrintData メソッド
■メソッド説明
説明:帳票を作成しサーバのプリンターでダイレクトに印刷します。
戻り値:なし
順序
第1引数
第2引数
第3引数
第4引数
第5引数
第6引数
パラメーター名
folderName
reportAppName
userId
password
csvData
mailType
型
String
String
String
String
String
String
第7引数
isPrivate
boolean
URL アドレス
フォルダー名
レポート名
ユーザーID
ユーザーパスワード
CSVデータ
プリンターキューへの出力が完了した際、メールを送信するかどうか
メール送信タイプ文字列
(注意)COMPLETION_MAILのみ使用可能です
配布先の指定
第8引数
printerAliasName
String
プリンター出力する場合のプリンターの別名
第9引数
synchronize
boolean
true をセットした場合、印刷ジョブをキューに出力するまで待
弟 10 引数
sendMailOnError
boolean
機する。false をセットした場合ジョブを待機しない。
エラーメール送信フラグ
true を指定すると、エラーが発生した際、実行したユーザの登録アドレス
にエラーを送信します。falseを指定すると、エラーが発生してもメールが
送信されません。
Copyright(C) SIOS Technology, Inc.
18
SOAPインターフェースガイド
4.WRSUtilService サービス
WRC Serverで提供している様々なサービスを要求することができます。
WRSUtilServiceサービスを要求する7つのメソッドがあります。
項目名
URL アドレス
http://localhost:8080/wrs/services/WRSUtilService
SOAPエンドポイント
http://localhost:8080/wrs/services/WRSUtilService?wsdl
WSDLファイル
※ホスト名(localhost)及びポート番号(8080)は環境に応じて変更して下さい。
No メソッド名
1
getCreatedPDF
説明
生成済み PDFレポートの取得します。
2
getPrinterAliasNameList
プリンター別名の取得します。
3
getFolderList
実行可能なフォルダー名の取得します。
4
getReoportList
実行可能なレポート名の取得します。
5
getCreatedReoportDateList
生成済みレポートの作成日時の取得します。
4 – 1 getCreatedPDF メソッド
■メソッド説明
説明:作成済みPDFのバイト配列を取得します。
戻り値:byte[] (バイト配列)
順序
第1引数
第2引数
第3引数
パラメーター名
folderName
reportAppName
createdDateTime
型
String
String
String
説明
フォルダー名
レポート名
作成された日時(必須) yyyyMMddhhmiss
(例)2003年06月25日 11時間01分33秒 → 20030625110133
4 – 2 getPrinterAliasNameList メソッド
■メソッド説明
説明:プリンター別名を要求をします。
戻り値:String[] (プリンター別名のString配列)
4 – 3 getFolderList メソッド
■メソッド説明
説明:実行可能なフォルダーを要求します。
戻り値:String[] (実行可能なフォルダー名の String配列)
Copyright(C) SIOS Technology, Inc.
19
SOAPインターフェースガイド
4 – 4 getReoportList メソッド
■メソッド説明
説明:実行可能なレポートを要求します。
戻り値:String[] (実行可能なレポート名のString 配列)
順序
第1引数
パラメーター名
folderName
型
String
説明
フォルダー名
4 – 5 getCreatedReoportDateList メソッド
■メソッド説明
説明:生成済みレポートの作成日時を要求します。
戻り値:String[] (レポート作成日時の文字列の配列(例)2003年06月25 日 11時間01 分33秒 → 20030625110133)
順序
第1引数
第2引数
第3引数
パラメーター名
folderName
reportAppName
fromDate
型
String
String
String
第4引数
toDate
String
説明
フォルダー名
レポート名
取得するレポートの検索開始日 yyyyMMdd
(例)2003年06月25日 → 20030625
指定しない場合は19000101が設定されます。
取得するレポートの検索終了日 yyyyMMdd
(例)2003年06月30日 → 20030630
指定しない場合は99990101が設定されます。
Copyright(C) SIOS Technology, Inc.