OXS ユーザーガイド

OPRO X Server のセットアップ(Windows)

OPRO X Server を動作させるまでの簡易的な手順について記載します。

目次

用語解説

ここでは、以下の用語を使用します。

用語意味
[OXS_HOME]OPRO X Server インストールディレクトリー

ページの先頭 ページの先頭

準備

ユーザーの権限

OPRO X Server のインストールと設定には、管理者権限が必要です。

OPRO X Server インストーラー

インストーラーは、製品 CD の OPRO X Server/Windows/install/ ディレクトリー以下、またはサポートページから取得することができます。インストーラーのファイル名は、「oxs****.exe」または「oxs****x64.exe」(****はバージョン番号)という形式になります。

ウェブ / アプリケーションサーバー

関連項目: IIS の設定例 > 準備

OPRO X Server では、主に下記2つの用途でウェブ / アプリケーションサーバーを使用します。(ウェブ / アプリケーションサーバーの種類は特に問いません。)

OUT_FILE ディレクトリー
OPRO X Server が OPR、PDF 等のドキュメントを生成するための、ウェブサーバー上のディレクトリーです。OPRO X Server の作業フォルダーですので、頻繁に入出力が発生します。このため、OUT_FILE ディレクトリーは OPRO X Server と同一コンピューター上に配置できるようにしてください。
HTTP インターフェイス
OPRO X Server を呼び出すための HTTP インターフェイス(CGI またはサーブレット)を動作させます。

CGI は、Windows プラットフォームのみに対応しています。

サーブレットを動作させる場合、Servlet 2.2以上をサポートしている必要があります。

OPRO X Serverは、ダウンロード、サーバー印刷、FAX等、様々な出力を行うことができますが、最も基本的な、ドキュメント(PDF等の帳票ファイル)のダウンロードを行う際の動きは、以下のようになります。

1. クライアントが、ドキュメント生成指示を、OXSのservlet/cgiへ、HTTPにてリクエストします。
2. OXSのservlet/cgiが、受信したリクエストを、OXS本体へソケットにて転送(デフォルトは6001)します。
3. OXS本体が、受信したリクエストに基づき、出力ディレクトリーにドキュメントを生成します。
4. OXS本体が、生成したドキュメントのURLを、OXSのservlet/cgiに返します。
5. OXSのservlet/cgiが、OXS本体から返されたドキュメントのURLを、HTTPリダイレクトレスポンスとして、クライアントに返します。
6,7. クライアントが、HTTPリダイレクトレスポンスに基づき、ドキュメントを取得します。

ウェブ / アプリケーションサーバーの設定方法につきましては、弊社製品サポートの対象外となります。予めご了承ください。

ページの先頭 ページの先頭

OPRO X Server インストール

OPRO X Server インストーラーを実行し、ウィザードに従ってインストールを完了してください。
インストーラー

ページの先頭 ページの先頭

IN_FILE ディレクトリーの作成

IN_FILE ディレクトリーは、OPRO X Designer で作成したテンプレートファイル(.oxt)を格納するためのディレクトリーです。
OPRO X Server が、ローカルパスとして認識できる場所に新規作成してください。
ODCAW.xml のデフォルトは、OPRO X Server インストールディレクトリーと同階層にある「Templates」です。
IN_FILE

ページの先頭 ページの先頭

OUT_FILE ディレクトリーの作成

関連項目: IIS の設定例 > OUT_FILE ディレクトリーの作成

OUT_FILE ディレクトリーは、OPRO X Server が OPR、PDF 等のドキュメントを生成するためのディレクトリーです。
OUT_FILE ディレクトリーは、以下の条件を満たす場所に作成する必要があります。

OUT_FILE ディレクトリーのコピー

[OXS_HOME]/webapps/odcaw2/ を、ディレクトリーごとウェブサーバーのルートディレクトリー配下にコピーしてください。
IIS の例

MIME タイプの設定

opr、oxr、ofd、odp といったフォーマットを使用する場合は、OUT_FILE ディレクトリーがあるウェブサーバーで、以下のような MIME タイプの設定を行ってください。

拡張子MIME タイプ
oprapplication/x-opro-opr
oxrapplication/x-opro-oxr
ofdapplication/x-opro-ofd
odpapplication/x-opro-odp

HTTP での確認

上記 OUT_FILE ディレクトリー配下にファイルを配置し、HTTP で参照できることを確認してください。
例えば、簡単なテキストファイルを配置し、ウェブブラウザで URL を指定します。

この時、「ページが見つかりません」「ページを表示できません」等のメッセージが表示された場合は、ウェブサーバーが起動しているか、ネットワークに問題はないか、ファイルが適切な場所に配置されているか、URL(ウェブサーバーのポート番号含む)に誤りはないかといったことをご確認ください。

ウェブサーバーのコンテンツを HTTP で参照できないという問題については、弊社製品サポートの対象外となります。予めご了承ください。

ページの先頭 ページの先頭

CGI / サーブレットを動作させる

CGI / サーブレットの配置

CGI を使用する場合

関連項目: IIS の設定例 > CGI の配置

CGI のファイル(Windows 用は「odcaw2_cgi.exe」、Linux / UNIX 用は「odcaw2_cgi.cgi」)は、それぞれのプラットフォーム用のインストーラーでインストールした OPRO X Server の [OXS_HOME]/tools/cgi/ 以下にあります。ここでは、Windows 用 CGI を例に説明します。

  1. [OXS_HOME]/tools/cgi/ 以下の odcaw2_cgi.exe と odcaw2_cgi.cfg を、アプリケーションサーバー上の、CGI が動作するディレクトリーにコピーしてください。
  2. アプリケーションサーバー上の odcaw2_cgi.cfg を、テキストエディタ等で開き、設定を確認してください。
    # CGI Interface Program  for OPRO X Server - Configuration File 
    
    # OPRO X Server Settings
      ODCAW_HOST = 127.0.0.1
      ODCAW_PORT = 6001
    
    # If you need to keep log files put YES
      LOG_FILE = NO
      LOG_PATH = c:\inetpub\scripts\
    
    ODCAW_HOSTOPRO X Server が動作するマシンの IP アドレス
    (OPRO X Serverと同一コンピューター上に CGI がある場合は、「127.0.0.1」としてください)
    ODCAW_PORTOPRO X Server のポート番号
    (ODCAW.xml の ODCAW/COMMON/PORT で設定されている番号)
    LOG_FILEYES(ログファイルを出力する)または NO(ログファイルを出力しない)を指定
    LOG_PATHログファイルの出力先

サーブレットを使用する場合

関連項目: Tomcat で OXS サーブレットを配備する手順例

  1. [OXS_HOME]/tools/servlet/webディレクトリーを適当な場所へコピーします。
  2. コピーしたwebディレクトリー内の、/WEB-INF/classes/odcaw2_servlet.properties をテキストエディタ等で開き、設定を確認してください。
    # Servlet Interface Program  for OPRO X Server - Configuration File 
    
    # ODCAW_HOST: IP address or host name of OPRO X Server.
    # ODCAW_PORT: Port number of OPRO X Server: /ODCAW/COMMON/PORT in 'ODCAW.xml'.
    ODCAW_HOST=127.0.0.1
    ODCAW_PORT=6001
    
    # LOG_FILE: Set YES if you need to keep log files.
    # LOG_PATH: Two back-slashes are required in Windows platforms.
    LOG_FILE=NO
    LOG_PATH=C:\\log
    
    ODCAW_HOSTOPRO X Server が動作するマシンの IP アドレス
    (OPRO X Serverと同一コンピューター上にサーブレットがある場合は、「127.0.0.1」としてください)
    ODCAW_PORTOPRO X Server のポート番号
    (ODCAW.xml の ODCAW/COMMON/PORT で設定されている番号)
    LOG_FILEYES(ログファイルを出力する)または NO(ログファイルを出力しない)を指定
    LOG_PATHログファイルの出力先(Windows では、ディレクトリーの区切り文字を「\\」としてください)
  3. コピーしたwebディレクトリーをアプリケーションサーバーに配備してください。

CGI / サーブレットの動作確認

ウェブブラウザから CGI またはサーブレットの URL にアクセスし、OXS-99998 がレスポンスされれば、正常に動作しています。
(OXS-99998 は、何もパラメータを渡さなかった場合のメッセージですので、この動きは正常です。)

CGI / サーブレットを動作させるためのアプリケーションサーバーの設定方法については、弊社製品サポートの対象外となります。予めご了承ください。

ページの先頭 ページの先頭

ODCAW.xml の設定

OPRO X Server の設定ファイル「ODCAW.xml」を、環境や用途に応じて編集します。
ここでは、OPRO X Server の基本的な機能(ドキュメントのダウンロード、OPRO X Designer からのプレビュー等)を使用するための設定例について、簡易的な手順を紹介します。

テキストエディタ等で [OXS_HOME]/conf/ODCAW.xml を開き、下記の赤い字の箇所を編集後、上書き保存してください。

初期状態の ODCAW.xml は、ODCAW.xml.win として保存されています。
ディレクトリーの区切り文字は「/」としてください。

<?xml version="1.0" encoding="Shift_JIS"?>
<ODCAW>
 <COMMON>
  <SERIAL>Fv8AFDIyMpFPmODge/BkFwG8p+CSAA==</SERIAL>
<!--
製品 CD にある serial.txt に記載されているシリアルキーに書き換える
-->

〜中略〜


  <FONT>
   <EMBED_FONT_LIST>C:/Program Files/OPRO/OPRO X Server 2.7.4/works/fonts/embed_fonts.txt</EMBED_FONT_LIST>
   <LOCAL_PATH>C:/Program Files/OPRO/OPRO X Server 2.7.4/works/fonts/</LOCAL_PATH>
   <SYSTEM_PATH>C:/WINDOWS/Fonts/</SYSTEM_PATH>
<!--
フォントの実体(*.ttc、*.ttf)があるディレクトリーのパスを指定
-->
   <DEFAULT allow="YES">Arial</DEFAULT>
   <FIXEDPITCH_WIDTH type="XP"/>
<!--
この設定は、PDF には影響しません。OPR、サーバー印刷等を使用する場合に設定してください。
 ・type="XP" とした場合は、Windows XP の文字幅で文字の位置を計算します。
 ・type="" とした場合は、Windows 2000 の文字幅で文字の位置を計算します。
type="XP" で作成したドキュメント(OPR 等)を、Windows 2000 等で表示した場合は、同じドキュメントを Windows XP で表示した場合に比べて余白が多くなることがありますが、文字がはみ出ることはありません。
一方、type="" で作成したドキュメントを Windows XP で表示した場合、文字がコンポーネントからはみ出ることがあります。
-->
   <USE_JIS2004>YES</USE_JIS2004>
  </FONT>

〜中略〜

  <ODCAW_CGI>http://127.0.0.1/scripts/odcaw2_cgi.exe</ODCAW_CGI>
<!--
CGI(もしくはサーブレット)の URL を指定
-->

〜中略〜

 <ODDS>

〜中略〜

  <PRINTFORM_MARGIN adjust="YES"/>
<!--
OXBでの印刷、クライアント直接印刷、サーバー印刷を行う場合で、カスタム用紙サイズ(OXDで用紙サイズが「Custom」になっているもの)を使用する場合の、用紙情報の取得方法を設定します。
新規でOPRO X Serverをセットアップする場合は、「YES」に設定してください。
アップデート等、既に稼働しているOPRO X Serverの設定を引き継ぐ必要がある場合は、既存の設定に従ってください。
-->
  <PATH>
   <IN_FILE>
    <LOCAL>C:/Program Files/OPRO/Templates/</LOCAL>
<!--
IN_FILEディレクトリーの作成 で作成したディレクトリーのローカルパスを指定
-->
   </IN_FILE>
   <OUT_FILE delete="NO" ttl="15" unit="mins">
<!--
ウェブサーバー上に作成したドキュメント(OPR、PDF等)を自動削除する設定です。
例えば、delete="YES" ttl="24" unit="hrs" とすると、24時間で削除されます。
unit には、secs(秒)、mins(分)、hrs(時間)を設定できます。
-->
    <LOCAL>C:/Inetpub/wwwroot/odcaw2/odds_out/</LOCAL>
<!--
OUT_FILEディレクトリーの作成 でコピーした odcaw2 ディレクトリー以下「odds_out」フォルダーのローカルパスを指定
-->
    <URL>http://172.16.200.83/odcaw2/odds_out/</URL>
<!--
OUT_FILEディレクトリーの作成 でコピーした odcaw2 ディレクトリー以下「odds_out」の URL を指定
外部のアプリケーションやクライアントからのリクエストを受け付ける場合は、「127.0.0.1」や「localhost」ではなく、外部から参照できるURLで必要があります。
-->
   </OUT_FILE>

〜中略〜

 <ODTS>
  <PATH>
   <IN_FILE>
    <LOCAL>C:/Program Files/OPRO/Templates/</LOCAL>
<!--
IN_FILEディレクトリーの作成 で作成したディレクトリーのローカルパスを指定
-->
   </IN_FILE>
   <OUT_FILE delete="NO" ttl="15" unit="mins">
<!--
ウェブサーバー上に作成した CSV 等を自動削除する設定です。
例えば、delete="YES" ttl="24" unit="hrs" とすると、24時間で削除されます。
unit には、secs(秒)、mins(分)、hrs(時間)を設定できます。
-->
    <LOCAL>C:/Inetpub/wwwroot/odcaw2/odts_out/</LOCAL>
<!--
OUT_FILEディレクトリーの作成 でコピーした odcaw2 ディレクトリー以下「odts_out」フォルダーのローカルパスを指定
-->
    <URL>http://172.16.200.83/odcaw2/odts_out/</URL>
<!--
OUT_FILEディレクトリーの作成 でコピーした odcaw2 ディレクトリー以下「odts_out」の URL を指定
外部のアプリケーションやクライアントからリクエストを受け付ける場合は、「127.0.0.1」や「localhost」ではなく、外部から参照できるURLで必要があります。
-->
   </OUT_FILE>
  </PATH>
 </ODTS>

〜中略〜

 <ODCS>
<!--
データベースへの接続設定は、ODCS要素以下で行います。以下のように、<DATABASE> 〜 </DATABASE> で囲まれた範囲を一つのデータベース定義として設定します。
データベースとの接続についてをご覧ください。
-->
  <DATABASES>
   <DATABASE>
    <Name>SAMPLE_OR</Name>
    <Type>Oracle</Type>
    <URL>jdbc:oracle:thin:@192.168.100.41:1521:db816</URL>
    <Driver>oracle.jdbc.driver.OracleDriver</Driver>
    <UserID>scott</UserID>
    <Password>tiger</Password>
    <Connections>3</Connections>
   </DATABASE>

〜中略〜

</ODCAW>

ページの先頭 ページの先頭

フォントの確認

OPRO X Designer で作成したテンプレート上で使用されているフォントが、OPRO X Server が稼働するコンピューターにインストールされていることを確認してください。

Windows の「リモート デスクトップ」を使用してフォントのインストールを行わないでください。過去に、OPRO X Server 起動ユーザーからフォントを参照できないという事例が報告されております。

フォント

ページの先頭 ページの先頭

起動と停止

コンソール起動、またはサービス起動いずれかの方法で OPRO X Server を起動します。

コンソール起動

起動
スタートメニュー → OPRO X Server 2.7.4 → Run OXS as a Java Application を実行すると、コマンド プロンプトが立ち上がり、OPRO X Server が起動します。
停止
キーボードの [Ctrl] + [C] で OPRO X Server を停止します。

サービス起動

サービス登録・起動
以下の手順でサービスに登録し、起動します。
  1. スタートメニュー → OPRO X Server 2.7.4 → Install OXS Windows Service を実行
  2. スタートメニュー → コントロールパネル → 管理ツール → サービス で、「OPRO X Server」を開始
停止
スタートメニュー → コントロールパネル → 管理ツール → サービス で、「OPRO X Server」を停止
サービスの削除
以下の手順で OPRO X Server サービスを削除します。
  1. サービスコンソール(スタートメニュー → コントロールパネル → 管理ツール → サービス で起動するコンソール)が開いている場合は、閉じる。
  2. スタートメニュー → OPRO X Server 2.7.4 → Un-install OXS Windows Service を実行

ページの先頭 ページの先頭

Copyright: © 2014 OPRO Japan Co., Ltd. - 日本オプロ株式会社 https://www.opro.net/