CGI / サーブレット パラメータリスト

OPRO X Server の CGI / サーブレット に対するパラメータの一覧です。
「固定パラメータ」は、その操作での指定方法が確定しているものです。必要に応じて「...」の部分に「可変パラメータ」を追加してください。

操作固定パラメータ可変パラメータ
ドキュメントのダウンロードDO=ex&OP=dl& ... &ES=oddsFM, TP, CS, RF, TM, AFn, XT, EXT, FE, AT
OXB での直接印刷DO=ex&OP=dp& ... &ES=oddsTP, CS, RF, TM
ドキュメント生成DO=ex&OP=cr& ... &ES=oddsFM, TP , CS, TM, AFn, XT, EXT, FE, AT
メール送信DO=ex&OP=ml& ... &ES=oddsFM, UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, MTn_m, MCCn_m, MBCn_m, MF, RT, MDL, MSJ, MB, MA, RRNn_m, HMn_m, TP, DC, TM, CS, XT, EXT, FE, AT
FAX 送信DO=ex&OP=fx& ... &ES=oddsUN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM, FR, CS
FAX 送信 (ApeosPort)DO=ex&OP=fxa& ... &ES=oddsUN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM, CS
FAX 送信 (imagio)DO=ex&OP=fxi& ... &ES=oddsUN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM, CS
サーバ印刷DO=ex&OP=pr& ... &ES=oddsUN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, NCn_m, TP, TM, CS
データのダウンロードDO=ex&OP=dl& ... &ES=odtsFM, SE, CP, TP, CS, {USERINPUT}
サーバリストDO=sl& ... &ES=oddsOP
プリンタリストDO=pl& ... &ES=oddsOP, TSn
ステータスDO=st& ... &ES=oddsOP, TSn, PID
キュー情報(メール/FAX/FAX(ApeosPort)/FAX(imagio)/サーバ印刷)DO=qi& ... &ES=oddsOP, TSn, PID
キャンセル(ドキュメント生成/メール/FAX/FAX(ApeosPort)/FAX(imagio)/サーバ印刷)DO=pcl& ... &ES=oddsOP, TSn, UN, PW, PID
エラーメッセージDO=er& ... &ES=oddsEC
サーバのバージョン情報DO=sv&ES=odcaw-
データベースへの再接続DO=rc&ES=odcs-
ユーザインプット
(Dataset の検索条件、Hide Layout if など)
-(例) {Dataset1_1}, {request1}, {template.1}
OCCS 関連DO=ex& ... &ES=occsOP, CID

補足

ドキュメントのダウンロード

固定パラメータ

DO=ex&OP=dl& ... &ES=odds

可変パラメータ意味指定方法備考
FMドキュメントのフォーマット FM=o (OPR)
FM=x (OXR, 圧縮されていない OPR)
FM=v (OXV, OPRO X Viewer用フォーマット)
FM=p (PDF)
FM=h (HTML)
FM=h1 (1 ページの HTML を生成)
FM=d (DocuWorksフォーマット)
省略時は、FM=pとして動作します。
TPテンプレート名(例)テンプレート名が「sample01.oxt」の場合
TP=sample01
テンプレート名を指定しなかった場合は、ODCAW.xml の <ODCAW>/<COMMON>/<ODDS>/<DEFAULT_TEMPLATE> 要素内で定義されたテンプレートが使用されます。
省略時は、ODCAW.xmlのDEFAULT_TEMPLATEで設定したデフォルトテンプレートが使用されます。
CSURL パラメータの文字コード(例)URL パラメータの文字コードに Shift_JIS を指定する場合
CS=Shift_JIS
省略時は、MS932として動作します。
RFレスポンス HTML の更新時間 (例)レスポンス HTML の更新時間を 10 秒に指定する場合
RF=10
・この操作では、レスポンス HTML の [OXS_REQUEST_XX] キーワードの機能を利用しますので、レスポンス HTMLで [OXS_REQUEST_RF] が適切に記述されている必要があります。
・RF に正でない数値を指定すると、指定しない場合と同意になります。
省略時、指定しない場合は、レスポンスHTMLを返しません。
TMタイムスタンプサーバ名ODCAW.xml の<ODDS>/<TIMESTAMP>/<SERVER> で設定したタイムスタンプサーバ名を指定します。
(例)TM=tsa1
省略時は、タイムスタンプトークンファイルが作成されません。
AFn
(n= 複数添付する場合の、通し番号)
OPR/OXR/PDF の添付ファイル名OPR/OXR/PDF に添付するファイルは ODCAW.xml の<ODCAW>/<ODDS>/<PATH>/<ATTACHMENT> 要素内で定義されたディレクトリに配置します。
(例)AF0=sample1.doc&AF1=sample2.doc
省略時は、添付されません。
XTXSLT ファイル名FM=x を指定して生成される OXR ドキュメントを、XSLT を用いて変換することができます。XSLT ファイルは ODCAW.xml の <ODCAW>/<ODDS>/<OPMS>/<XSLT_IN_FILE> 要素内で定義されたディレクトリに配置します。
(例)XT=SampleTranform.xsl
省略時は、XSLTを使用しません。
EXTOXR ファイルの変換後の拡張子FM=x 及び XT パラメタを指定して OXR ファイルの変換を行う場合に、変換後の拡張子を指定します。
(例)EXT=txt
省略時は、拡張子の変更を行いません。
FEPDF へのフォントの埋め込みFM=p の時、FE=true を指定するとフォントを埋め込みます
(例)FE=true
FE を省略した場合、フォントは埋め込まれません。
ATXSLT 名: AGENT_TYPE の name 属性で指定FM=h の場合に使用する XSLT ファイルを指定します。
(例) ODCAW.xml で <AGENT_TYPE name="sample"> と定義した XSLT ファイルを指定する場合
AT=sample
省略時、リクエストしたユーザエージェントとODCAW.xmlの<ODDS>/<OPMS>/<USER_AGENT>/<AGENT_TYPE>/<TYPE>の値が合致する場合は、そこで設定されている XSLT を使用します。
DIT(PDF)文書のプロパティのタイトルPDFの「文書のプロパティ」の「タイトル」に表示させたい文字列を指定します。省略時は、テンプレート名が表示されます。
DIA(PDF)文書のプロパティの作成者PDFの「文書のプロパティ」の「作成者」に表示させたい文字列を指定します。省略時は空になります。
DIS(PDF)文書のプロパティのサブタイトルPDFの「文書のプロパティ」の「サブタイトル」に表示させたい文字列を指定します。省略時は空になります。
DIK(PDF)文書のプロパティのキーワードPDFの「文書のプロパティ」の「キーワード」に表示させたい文字列を指定します。省略時は空になります。
返り値

HTTP リダイレクト (ドキュメントの URL)
※ RF パラメータの値が正の場合は、レスポンスHTML

OXB での直接印刷

OPRO X Browser の直接印刷機能を使用します。

固定パラメータ

DO=ex&OP=dp& ... &ES=odds

可変パラメータ意味指定方法備考
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
RFレスポンス HTML の更新時間「ドキュメントのダウンロード」の RF 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
返り値

HTTP リダイレクト (直接印刷用 OPR の URL)
※ RF パラメータの値が正の場合は、レスポンス HTML

ドキュメント生成

ドキュメントの生成のみを行います。これにより、生成後の任意の時間にダウンロードすることが可能です。

固定パラメータ

DO=ex&OP=cr& ... &ES=odds

可変パラメータ意味指定方法備考
FMドキュメントのフォーマット「ドキュメントのダウンロード」の FM 参照
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
AFn
(n= 複数添付する場合の、通し番号)
OPR/OXR/PDF に添付するファイル名「ドキュメントのダウンロード」の AFn 参照
XTXSLT ファイル名「ドキュメントのダウンロード」の XT 参照
EXTOXR ファイルの変換後の拡張子「ドキュメントのダウンロード」の EXT 参照
FEPDF へのフォントの埋め込み「ドキュメントのダウンロード」の FE 参照
ATXSLT 名: AGENT_TYPE の name 属性で指定「ドキュメントのダウンロード」の AT 参照
返り値

レスポンス HTML

メール送信

生成したドキュメントを添付、または本文(HTML メールの場合)としてメールを送信します。

固定パラメータ

DO=ex&OP=ml& ... &ES=odds

可変パラメータ意味指定方法備考
FMドキュメントのフォーマット「ドキュメントのダウンロード」の FM 参照
UNログインユーザ名ODCAW.xml の ODMS_INFO で設定したユーザ名
(例) UN=ADMIN
省略不可
PWログインパスワードODCAW.xml の ODMS_INFO で設定したパスワード
(例) PW=admin
省略不可
TSn
(n=ServerIndex)
ターゲットサーバODCAW.xml の ODMS_INFO で設定した URL の name を指定
(例) TS0=DEFAULT
省略不可
DNn_m
(n=ServerIndex,m=DeviceIndex)
デバイス名 (SMTPサーバを指定)(例) DN0_0=127.0.0.1省略時は、ODCAW.xml のOMPS_COMMONで設定されている値を使用します。
GTn_m
(n=ServerIndex,m=DeviceIndex)
生成時刻GMT での時刻を yyyyMMddHHmm 形式で指定
(例)2003年8月25日15時00分
GT0_0=200308251500
省略時は即時生成します。
FPTn_m
(n=ServerIndex,m=DeviceIndex)
スケジュール時刻GMT での時刻を yyyyMMddHHmm 形式で指定
(例)2003年8月25日15時30分
FPT0_0=200308251530
省略時は、スケジューリングを行いません。
CE確認メールの宛先メールアドレス(例) CE=mail@host省略時は、ODCAW.xml のCONFIRMATION_SENDERで設定されている値を使用します。
MTn_m
(n=ServerIndex,m=DeviceIndex)
宛先メールアドレス(To)(例) MT0_0=user1@host
,(カンマ)で区切ることで、複数指定することができます。
MCCn_mかMBCn_mが指定されている場合のみ、省略することができます。
MCCn_m
(n=ServerIndex,m=DeviceIndex)
宛先メールアドレス(CC)(例) MCC0_0=user2@host
,(カンマ)で区切ることで、複数指定することができます。
省略時は、CCを指定しません。
MBCn_m
(n=ServerIndex,m=DeviceIndex)
宛先メールアドレス(BCC)(例) MBC0_0=user3@host
,(カンマ)で区切ることで、複数指定することができます。
省略時は、BCCを指定しません。
MF差出人メールアドレス(例) MF=admin@host省略時は、ODCAW.xmlのDEFAULT_FROMで設定されている値を使用します。
RT返信メールアドレス(例) RT=admin@host省略時は、差出人メールアドレスを使用します。
MDL ドキュメントの場所 指定時は、ODCAW.xml の MAX_ATTACHMENT の設定は無視されます。
(例)
MDL=att (ドキュメントをメールに添付)
MDL=url (ドキュメントの URL をメール本文に記載)
MDL=none (添付も URL の記載もなし)
省略時は、ODCAW.xml の MAX_ATTACHMENT の設定に従います。
MSJ件名(例) MSJ=MailSubject省略時は、件名は空白になります。
MBメール本文(例) MB=MailBody省略時は、本文は空白になります。
MA添付ファイル名(例) MA=MailAttachement省略時は、OXSが生成したファイル名になります。
RRNn_m
(n=ServerIndex,m=DeviceIndex)
開封確認開封確認: true(=問い合わせる), false(=問い合わせない)
(例) RRN0_0=true
省略時は、=false として動作します。
HMn_m
(n=ServerIndex,m=DeviceIndex)
HTML メールHTML メール: true(= HTML メールにする), false(= HTML メールにしない)
(例) HM0_0=true
省略時は、=false として動作します。
TPテンプレート名「ドキュメントのダウンロード」のTP 参照
DC ドキュメントのパス 送信するドキュメント(OPR、OXR、ODP)を、ローカルパスかURLで指定します。
(例)
DC=C%3A%2F%2Fsample.opr (C://sample.opr を URL エンコードした場合)
DC=http%3A%2F%2Fhost%2Fsample.oxr (http://host/sample.oxr をURLエンコードした場合)
DCとTPを指定した場合、TPが優先的に使用されます。DCとTPを省略した場合、ODCAW.xmlのDEFAULT_TEMPLATEで設定したデフォルトテンプレートが使用されます。
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」のCS 参照
XTXSLT ファイル名「ドキュメントのダウンロード」のXT 参照
EXTOXR ファイルの変換後の拡張子「ドキュメントのダウンロード」のEXT 参照
FEPDF へのフォントの埋め込み「ドキュメントのダウンロード」のFE 参照
ATXSLT 名: AGENT_TYPE の name 属性で指定「ドキュメントのダウンロード」のAT 参照
返り値

レスポンス HTML

FAX送信

OXSが生成したドキュメントを、モデムまたはFAXボードを使ってFAX送信します。

固定パラメータ

DO=ex&OP=fx& ... &ES=odds

可変パラメータ意味指定方法備考
UNログインユーザ名ODCAW.xml の OIFS_INFO で設定したユーザ名
(例) UN=ADMIN
省略不可
PWログインパスワードODCAW.xml の OIFS_INFO で設定したパスワード
(例) PW=admin
省略不可
TSn
(n=ServerIndex)
ターゲットサーバODCAW.xml の OIFS_INFO で設定した URL の name を指定
(例) TS0=DEFAULT
省略不可
DNn_m
(n=ServerIndex,m=DeviceIndex)
デバイス名 (FAX モデムポート番号を指定)(例) DN0_0=1省略時は、標準のファックスポートが使用されます。
GTn_m
(n=ServerIndex,m=DeviceIndex)
生成時刻「メール送信」の GTn_m 参照
FPTn_m
(n=ServerIndex,m=DeviceIndex)
スケジュール時刻「メール送信」の FPTn_m 参照
CE確認メールの宛先メールアドレス「メール送信」のCE参照
DCドキュメントのパス「メール送信」のDC参照
FNn_mFAX 番号(例) FN0_0=0123456789
,(カンマ)で区切ることで、複数指定することができます。
省略不可
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
FRFAXの解像度(例) FR=normal
(ノーマルモード)

(例) FR=fine
(ファインモード)
省略時は、ODCAW.xml の RESOLUTION で指定したモードを使用します。

また、パラメータはそれぞれ以下のように省略できます。
nomal = n, no, nor, norm, norma
fine = f, fi, fin
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
返り値

レスポンスHTML

FAX送信 (ApeosPort)

OXSで生成したドキュメントや、その他の印刷可能なフォーマット(※)を、ApeosPortを使ってFAX 送信します。
※ 確認済フォーマット・・・PDF, XDW, DOC, XLS, PPT

固定パラメータ

DO=ex&OP=fxa& ... &ES=odds

可変パラメータ意味指定方法備考
UNログインユーザ名ODCAW.xml の MFP_FX_INFO で設定したユーザ名
(例) UN=ADMIN
省略不可
PWログインパスワードODCAW.xml の MFP_FX_INFO で設定したパスワード
(例) PW=admin
省略不可
TSn
(n=ServerIndex)
ターゲットサーバODCAW.xml の MFP_FX_INFO で設定した URL の name を指定
(例) TS0=DEFAULT
省略不可
DNn_m
(n=ServerIndex,m=DeviceIndex)
ApeosPort名DO=plリクエストによって取得できるApeosPort名を指定します。
(例) DN0_0=FX ApeosPort C7550 I FAX
省略時は、最初に認識した、対応する複合機を使用します。
GTn_m
(n=ServerIndex,m=DeviceIndex)
生成時刻「メール送信」の GTn_m 参照
FPTn_m
(n=ServerIndex,m=DeviceIndex)
スケジュール時刻「メール送信」の FPTn_m 参照
CE確認メールの宛先メールアドレス「メール送信」のCE参照
DCドキュメントのパス「メール送信」のDC参照
FNn_mFAX 番号「FAX送信」の FNn_m 参照省略不可
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
返り値

レスポンスHTML

FAX送信 (imagio)

OXSで生成したドキュメントや、その他の印刷可能なフォーマット(※)を、imagioを使ってFAX 送信します。
※ 確認済フォーマット・・・PDF, XDW, DOC, XLS, PPT

固定パラメータ

DO=ex&OP=fxi& ... &ES=odds

可変パラメータ意味指定方法備考
UNログインユーザ名ODCAW.xml の MFP_RICOH_INFO で設定したユーザ名
(例) UN=ADMIN
省略不可
PWログインパスワードODCAW.xml の MFP_RICOH_INFO で設定したパスワード
(例) PW=admin
省略不可
TSn
(n=ServerIndex)
ターゲットサーバODCAW.xml の MFP_RICOH_INFO で設定した URL の name を指定
(例) TS0=DEFAULT
省略不可
DNn_m
(n=ServerIndex,m=DeviceIndex)
imagio名DO=plリクエストによって取得できるimagio名を指定します。
(例) DN0_0=RICOH PCFAX(imagio MP 6000)
省略時は、最初に認識した、対応する複合機を使用します。
GTn_m
(n=ServerIndex,m=DeviceIndex)
生成時刻「メール送信」の GTn_m 参照
FPTn_m
(n=ServerIndex,m=DeviceIndex)
スケジュール時刻「メール送信」の FPTn_m 参照
CE確認メールの宛先メールアドレス「メール送信」のCE参照
DCドキュメントのパス「メール送信」のDC参照
FNn_mFAX 番号「FAX送信」の FNn_m 参照省略不可
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
返り値

レスポンスHTML

サーバ印刷

生成したドキュメントをサーバサイドに接続されたプリンタから印刷します。

固定パラメータ

DO=ex&OP=pr& ... &ES=odds

可変パラメータ意味指定方法備考
UNログインユーザ名ODCAW.xml の OIPS_INFO で設定したユーザ名
(例) UN=ADMIN
省略不可
PWログインパスワードODCAW.xml の OIPS_INFO で設定したパスワード
(例) PW=admin
省略不可
TSn
(n=ServerIndex)
ターゲットサーバODCAW.xml の OIPS_INFO で設定した URL の name を指定
(例) TS0=DEFAULT
省略不可
DNn_m
(n=ServerIndex,m=DeviceIndex)
デバイス名 (プリンタ名を指定)DO=pl リクエストで取得できるプリンタ名で指定
(例) DN0_0=Printer1
省略時は、起動方法によって動作が異なります。

サービス起動時:最初に認識したプリンタを使用

バッチ起動時:OXS起動ユーザの標準のプリンタを使用
GTn_m
(n=ServerIndex,m=DeviceIndex)
生成時刻「メール送信」のGTn_m参照
FPTn_m
(n=ServerIndex,m=DeviceIndex)
スケジュール時刻「メール送信」のFPTn_m参照
CE確認メールの宛先メールアドレス「メール送信」のCE 参照
DCドキュメントのパス「メール送信」のDC参照
NCn_m
(n=ServerIndex,m=DeviceIndex)
部数(例) NC0_0=2省略時は、=1として動作します。
TPテンプレート名「ドキュメントのダウンロード」の TP 参照
TMタイムスタンプサーバ名「ドキュメントのダウンロード」の TM 参照
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
返り値

レスポンス HTML

データのダウンロード

Dataset のプロパティ「Save」から保存した、OQM ファイル(クエリファイル)のクエリの結果を、CSV、XML としてダウンロードします。

固定パラメータ

DO=ex&OP=dl& ... &ES=odts

可変パラメータ意味指定方法備考
FMドキュメントのフォーマットFM=c (CSV)
FM=x (XML)
省略不可
SEセパレータCSV のセパレータとして、カンマ(,)やスペースなどの文字を指定
(例) SE=,
省略時は、セパレータ無しになります。
CPCSVファイルの Caption の表示「false」とすると、CSV ファイルの Caption 行を省略します。
(例)CP=true
省略時は、=trueとして動作します。
TPテンプレート名OQM ファイル(OXD の Dataset の「Save」から保存したクエリファイル)名を、拡張子も含めて指定
(例) OQM ファイルが「sample01.oqm」の場合
TP=sample01.oqm
省略不可
CSURL パラメータの文字コード「ドキュメントのダウンロード」の CS 参照
{USERINPUT} ユーザインプット (例) {USERINPUT}=value01
※ 「value01」は、検索条件などの、クエリで必要になる値
※ 複数の {USERINPUT} が存在する場合は、クエリで必要になる順番でリクエストする必要があります
{USERINPUT}が必要な場合は、省略できません。
返り値

HTTP リダイレクト (ドキュメントの URL)

サーバリスト

ODCAW.xml の ODMS_INFO、OIFS_INFO、OIPS_INFO で設定されている URL の name のリストを、各操作ごとに表示します。

固定パラメータ

DO=sl& ... &ES=odds

可変パラメータ意味指定方法備考
OP操作 OP=ml (メール送信)
OP=fx (FAX 送信)
OP=pr (サーバ印刷)
省略不可
返り値

以下のような HTML が OXS から返されます。

<html><head><title>OPRO Server List Response</title>
<META name="OPRO_TS" content="DEFAULT">
<META name="OPRO_TS" content="OIPS1">
<META name="OPRO_TS" content="OIPS_SOAP">
</head><body>
DEFAULT
OIPS1
OIPS_SOAP
</body></html>

プリンタリスト

DN パラメータで指定可能な値のリストを、各操作ごとに表示します。

固定パラメータ

DO=pl& ... &ES=odds

可変パラメータ意味指定方法備考
OP操作「サーバリスト」の OP 参照
TSn
(n=ServerIndex)
ターゲットサーバOP=ml の時
ODCAW.xml の ODMS_INFO で設定した URL の name を指定
(例) TS0=ODMS1
OP=fx の時
ODCAW.xml の OIFS_INFO で設定した URL の name を指定
(例) TS0=OIFS1
OP=pr の時
ODCAW.xml の OIPS_INFO で設定した URL の name を指定
(例) TS0=OIPS1
省略不可
返り値

以下のような HTML が OXS から返されます。

<html><head><title>OPRO Device List Response</title>
<META name = "OPRO_Printer" content ="FAX">
<META name = "OPRO_Printer" content ="APF Fax Printer">
</head><body>
FAX
APF Fax Printer
</body></html>

ステータス

OXSのジョブのステータスを表示します。

固定パラメータ

DO=st& ... &ES=odds

可変パラメータ意味指定方法備考
OP 操作 OP=cr (ドキュメント生成のみ)
OP=ml (メール送信)
OP=fx (FAX送信)
OP=pr (サーバ印刷)
省略不可
TSn
(n=ServerIndex)
ターゲットサーバ OP=cr の時(指定しない)
OP=ml の時
ODCAW.xml の ODMS_INFO で設定した URL の name を指定
(例) TS0=ODMS1
OP=fx の時
ODCAW.xml の OIFS_INFO で設定した URL の name を指定
(例) TS0=OIFS1
OP=pr の時
ODCAW.xml の OIPS_INFO で設定した URL の name を指定
(例) TS0=OIPS1
省略不可
PIDプロセスID(例) PID=OPRO__649671573
レスポンスHTMLから取得可能
省略不可
返り値

以下のような HTML が OXS から返されます。

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Cache-Control" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<title>OPRO X Server - Print Service Request</title>
<meta name="OXS_PID" content="ADMIN_110604032015620_0" />
<meta name="OXS_DOCUMENT_URL" content="C:/Inetpub/wwwroot/odcaw2out/KOPRO__1199315202_1" />
<meta name="OXS_CANCEL_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds" />
<meta name="OXS_STATUS_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds" />
<meta name="OXS_STATUS" content="Printed" />
<meta name="OXS_PRINT_TYPE" content="ODPS" />
<meta name="OXS_PRINT_OWNER" content="ADMIN" />
<meta name="OXS_PRINT_PRINTER_NAME" content="\\qa1\HP LaserJet 4050 Series PCL 5e" />
<meta name="OXS_PRINT_COPIES" content="1" />
<meta name="OXS_PRINT_PAGESPERCOPY" content="1" />
<meta name="OXS_PRINT_SIZE" content="2" />
<meta name="OXS_PRINT_SUBMIT_TIME" content="200501180925" />
<meta name="OXS_PRINT_PRIORITY" content="1" />
<meta name="OXS_PRINT_GENERATE_TIME" content="" />
<meta name="OXS_PRINT_SCHEDULE_TIME" content="" />
<meta name="OXS_PRINT_PXC_TIME" content="200501180925" />
<meta name="OPRO_EC" content="" />
<meta name="OPRO_ERR_DETAILS" content="" />
<meta name="OPRO_ERR_DES" content="" />
<style type="text/css">
body { margin: 0; padding: 0; border: none; color: #000; background: #fff; font: normal 100%/120% sans-serif; }
h1 { margin: 0; padding: 0.5em 1em; border: none; border-bottom: 2px solid #036; color: #000; background: #def; font: bold 180% sans-serif; }
h2 { margin: 0; padding: 0.5em 1em; border: 1px #036; border-style: solid none; color: #036; background: #fff; font: bold 120% sans-serif; }
dl { margin: 0; padding: 1em; color: #000; background: #def; }
table { margin: 1em; border-collapse: collapse; }
th, td { padding: 0.1em 0.3em; border: 1px solid #999; }
th { color: #036; background: #9cf; font: bold 80% sans-serif; }
td { color: #000; background: #fff; font: normal 90% sans-serif; }
.sub { color: #036; font: bold 80% sans-serif; }
</style>
</head>
<body>
<h1>OPRO X Server <span class="sub">Print Service Request</span></h1>
<h2>Request Job Status</h2>
<dl>
<dt>Latest Status</dt>
<dd><strong>Printed</strong></dd>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds">Current Status</a></dt>
<dd>Follow the above link to get updated job status.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds">CANCEL</a></dt>
<dd>cancels your request to generate a document.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=va&OP=pr&UN=ADMIN&PW=abcd&TS0=DEFAULT&ES=odds">PRINT Applet for DEFAULT</a></dt>
<dd>shows the status of Print Service requests for DEFAULT.</dd>
</dl>
<h2>Request Parameters</h2>
<table summary="This table charts the name of request parameter, its values, and its role on execution.">
<thead>
<tr><th>Name</th><th>Value</th><th>Role</th></tr>
</thead>
<tbody>
<tr><td>DO</td><td>st</td><td>What to do</td></tr>
<tr><td>OP</td><td>pr</td><td>Operation</td></tr>
<tr><td>UN</td><td></td><td>Login User Name</td></tr>
<tr><td>TS0</td><td>DEFAULT</td><td>Target Server</td></tr>
<tr><td>NC0_0</td><td></td><td>Number of Copies</td></tr>
<tr><td>TP</td><td></td><td>Template</td></tr>
<tr><td>SS</td><td></td><td>Source Service</td></tr>
<tr><td>ES</td><td>odds</td><td>Execution Service</td></tr>
</tbody>
</table>
</body>
</html>

キュー情報(メール/FAX/FAX(ApeosPort)/FAX(imagio)/サーバ印刷)

固定パラメータ

DO=qi& ... &ES=odds

可変パラメータ意味指定方法備考
OP操作「サーバリスト」の OP 参照
TSn
(n=ServerIndex)
ターゲットサーバ「プリンタリスト」の TSn 参照
PIDプロセス ID「ステータス」の PID 参照
返り値

HTML が OXS から返されます(「ステータス」の「返り値」参照)。

キャンセル(ドキュメント生成/メール/FAX/FAX(ApeosPort)/FAX(imagio)/サーバ印刷)

固定パラメータ

DO=pcl& ... &ES=odds

可変パラメータ意味指定方法備考
OP操作「サーバリスト」のOP参照
TSn
(n=ServerIndex)
ターゲットサーバ「プリンタリスト」のTSn参照
PIDプロセス ID「ステータス」の PID 参照
返り値

以下のような HTML が OXS から返されます。

<html>
<head>
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Cache-Control" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<title>OPRO X Server - Fax Service Request</title>
<meta name="OXS_PID" content="110604254762630" />
<meta name="OXS_DOCUMENT_URL" content="http://192.168.100.91/odcaw2out/KOPRO__3356449932.opr" />
<meta name="OXS_CANCEL_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=fx&TS1=81&PID=110604254762630&ES=odds" />
<meta name="OXS_STATUS_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=fx&TS1=81&PID=110604254762630&ES=odds" />
<meta name="OXS_STATUS" content="OIFS job canceled." />
<meta name="OPRO_EC" content="" /><meta name="OPRO_ERR_DETAILS" content="" />
<meta name="OPRO_ERR_DES" content="" />
<style type="text/css">
body { margin: 0; padding: 0; border: none; color: #000; background: #fff; font: normal 100%/120% sans-serif; }
h1 { margin: 0; padding: 0.5em 1em; border: none; border-bottom: 2px solid #036; color: #000; background: #def; font: bold 180% sans-serif; }
h2 { margin: 0; padding: 0.5em 1em; border: 1px #036; border-style: solid none; color: #036; background: #fff; font: bold 120% sans-serif; }
dl { margin: 0; padding: 1em; color: #000; background: #def; }
table { margin: 1em; border-collapse: collapse; }
th, td { padding: 0.1em 0.3em; border: 1px solid #999; }
th { color: #036; background: #9cf; font: bold 80% sans-serif; }
td { color: #000; background: #fff; font: normal 90% sans-serif; }
.sub { color: #036; font: bold 80% sans-serif; }
</style>
</head>
<body>
<h1>OPRO X Server <span class="sub">Fax Service Request</span></h1>
<h2>Request Job Status</h2>
<dl>
<dt>Latest Status</dt>
<dd><strong>OIFS job canceled.</strong></dd>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=fx&TS1=81&PID=110604254762630&ES=odds">Current Status</a></dt>
<dd>Follow the above link to get updated job status.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=fx&TS1=81&PID=110604254762630&ES=odds">CANCEL</a></dt>
<dd>cancels your request to generate a document.</dd>
</dl>
<dl>
<dt><a href="">FAX Applet for </a></dt>
<dd>shows the status of Fax Service requests for .</dd>
</dl>
<h2>Request Parameters</h2>
<table summary="This table charts the name of request parameter, its values, and its role on execution.">
<thead>
<tr>
<th>Name</th>
<th>Value</th>
<th>Role</th>
</tr>
</thead>
<tbody>
<tr><td>DO</td><td>st</td><td>What to do</td></tr>
<tr><td>OP</td><td>fx</td><td>Operation</td></tr>
<tr><td>UN</td><td></td><td>Login User Name</td></tr>
<tr><td>TS0</td><td></td><td>Target Server</td></tr>
<tr><td>FN0_0</td><td></td><td>Fax Number</td></tr>
<tr><td>TP</td><td></td><td>Template</td></tr>
<tr><td>SS</td><td></td><td>Source Service</td></tr>
<tr><td>ES</td><td>odds</td><td>Execution Service</td></tr>
</tbody>
</table>
</body>
</html>

エラーメッセージ

ODCAW.xml の MSG_FILE 要素で設定されているエラーメッセージファイル(通常は[OXS インストールディレクトリ]/conf/Error_descriptionJ.err)に記載されている Description および Detail の内容を表示します。
これにより、エラーメッセージの意味を知ることができます。

固定パラメータ

DO=er& ... &ES=odds

可変パラメータ意味指定方法備考
EC エラーコード ODCAW.xml の MSG_FILE で指定されている、Error_descriptionJ.err(もしくはError_description.err)内のエラーコードを指定。
(例) EC=OXS-00001

返り値

以下のような HTML が OXS から返されます。

<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
<title>OPRO X Server - Error Message</title>
<META name = "OPRO_EC" content ="OXS-04110">
<META name = "OPRO_ERR_DES" content ="Invalid Target Server specified">
<META name = "OPRO_ERR_DETAILS" content ="The Target Server(TS) you specified is not listed in the ODCAW.xml.">
</head><body>
<h1>Invalid Target Server specified</h1>
<p>OXS-04110: The Target Server(TS) you specified is not listed in the ODCAW.xml.</p>
</body></html>

サーバのバージョン情報

OXS のバージョン情報を表示します。

固定パラメータ

DO=sv&ES=odcaw

返り値

以下のような HTML が OXS から返されます。

<html>
<head><title>OPRO X Server Build Number</title></head>
<body>OXS 2.6.0.0</body>
</html>

データベースへの再接続

データベースへの再接続を試みます。

固定パラメータ

DO=rc&ES=odcs

返り値

以下のような HTML が OXS から返されます。

<html>
<head><title>ODCS Reconnect Status</title>
<body>Reconnected to :MSSQL_JDBC.</body>
</html>

ユーザインプット

可変パラメータ意味指定方法備考
{DatasetName_1}
...
{DatasetName_n}
※ DatasetName は、OXD 上での Dataset の Name
Dataset のユーザインプット (例) {Dataset1_1}=value01
※ 「value01」は、検索条件などの、クエリで必要になる値
複数のテンプレートを使用する場合(マルチテンプレート)は、
{TemplateName_DatasetName_n}
のように指定します。(※ TemplateName は、テンプレート名)
(例) {sample01_Dataset1_1}=value01
省略すると、クエリの一部を省略することとなり、その結果データを取得できないといったことが考えられます。
{DBExecuteName_1}
...
{DBExecuteName_n}
※ DBExecuteName は、OXD 上での DBExecute の Name
DBExecute のユーザインプット (例) {DBExecute1_1}=value01
※ 「value01」 は値
複数のテンプレートを使用する場合(マルチテンプレート)は、
{TemplateName_DBExecuteName_n}
のように指定します。(※ TemplateName は、テンプレート名)
(例) {sample01_DBExecutet1_1}=value01
省略すると、DBExecuteに設定されたスクリプトのユーザインプット部分を省略することになります。
{RequestParamName}
※ RequestParamName は、OXD の「リクエストパラメータ名」の値
Data の Type を Request にした場合のユーザインプット OXD 上で、Data の Type を Request にし、「リクエストパラメータ名」の値を「request1」にした場合の例
{request1}=value01
※ 「value01」は値
複数のテンプレートを使用する場合(マルチテンプレート)は、
{TemplateName_RequestParamName}
のように指定します。(※ TemplateName は、テンプレート名)
(例) {sample01_request}=value01
省略すると、該当の Label は空白になります。
{TP.LayoutIndex}=value
※ TP は、テンプレート名
※ LayoutIndex は、OXD で「何番目のレイアウトか」を表す数字
※ valueは、OXDの「次の条件でレイアウトを隠す」の「{USERINPUT}=」で定義された値
「Hide Layout if」機能を使って、表示しないレイアウト Hide Layout if は、リクエストごとに「出力しないレイアウトを指定する」ための機能です。
テンプレート名が「sample.oxt」で、OXD 上の 1 番目のレイアウトの「次の条件でレイアウトを隠す」プロパティで「{USERINPUT}=hide」と設定されている場合の例
{sample.1}=hide
この指定をすることにより、1 番目の Layout が無い状態のドキュメントを生成することができます。
省略時はHide Layout if機能を使用しません。

OCCS 関連

固定パラメータ

DO=ex& ... &ES=occs

可変パラメータ意味指定方法備考
OP操作OP=cd (OCCS コンテンツの表示)
OP=cc (OCCS コンテンツのクリック結果を表示)
省略不可
CIDOCCS ContentIDOCCS ContentID は、OPRO X Server Administrative Tools の、「OPRO Content Control Service Administrator」で確認できます。
(例) CID=1
省略不可
返り値

HTTP リダイレクト(OP=cd の場合は OCCS コンテンツの URL。OP=cc の場合はリンク先 URL。)

補足

ServerIndex, DeviceIndex について

ServerIndex
リクエスト内での TS パラメータに割り振る通し番号(0 ... n)
DeviceIndex
ServerIndex が付加されたパラメータに割り振る通し番号(0 ... m)

パラメータの順番について

パラメータをリクエストする順番には、以下のような決まりがあります。

  1. 「DO」で始まらなければなりません。
  2. 「ES」で終わらなければなりません。
  3. 複数の「TP」が存在し(マルチテンプレート)、同一の値(テンプレートが同じ)である場合、あるテンプレートに対する「Dataset のユーザインプット」や「Data の Type を Request にした場合のユーザインプット」は、次の「TP」パラメータの前に指定する必要があります。
    例えば、「sample01.oxt」でマルチテンプレートリクエストを行う場合は、
    DO=ex&OP=dl&FM=o&TP=sample01&{sample01_Dataset1_1}=value01&TP=sample01&{sample01_Dataset1_1}=value02&ES=odds
    のように、最初の「{sample01_Dataset1_1}=value01」という指定は、2 番目の「TP=sample01」の前に行います。

複数のユーザインプット・マルチテンプレートの例

ひとつのテンプレートで、Dataset のユーザインプットが複数存在
DO=ex&OP=dl&FM=o&TP=sample01&{Dataset1_1}=value01&{Dataset1_2}=value02&ES=odds
複数のテンプレートで、Dataset のユーザインプットが複数存在
DO=ex&OP=dl&FM=o&TP=sample02&{sample02_Dataset1_1}=value01&{sample02_Dataset1_2}=value02&TP=sample01&{sample01_Dataset1_1}=value03&{sample01_Dataset1_2}=value04&ES=odds
1つのテンプレートで、Dataset のユーザインプットと、Data の Type を Request にした場合のユーザインプットが存在
DO=ex&OP=dl&FM=o&TP=sample01&{Dataset1_1}=value01&{Dataset1_2}=value02&{request}=value03&ES=odds
複数のテンプレートで、Dataset のユーザインプットと、Data の Type を Request にした場合のユーザインプットが存在
DO=ex&OP=dl&FM=o&TP=sample02&{sample02_Dataset1_1}=value01&{sample02_Dataset1_2}=value02&{sample02_request}=value03&TP=sample01&{sample01_Dataset1_1}=value04&{sample01_Dataset1_2}=value05&ES=odds
Copyright: © 2014 OPRO Japan Co., Ltd. - 日本オプロ株式会社 https://www.opro.net/