OXS ユーザーガイド

OPRO X Server のセットアップ(Linux / UNIX)

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

目次

Linux / UNIX 環境での留意点

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

用語解説

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

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

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

準備

ユーザーの権限

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

OPRO X Server インストーラー、パッチ

インストーラーは、製品 CD の OPRO X Server/Linux/install/ ディレクトリー以下、またはサポートページから取得することができます。
パッチは、製品 CD の OPRO X Server/patch ディレクトリー以下、またはサポートページから取得することができます。
インストーラー、パッチともに ZIP で圧縮されておりますので、展開してください。

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

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 インストール

インストーラーの実行

oxs274NNx64_linux.binを実行すると、画面上に「License Agreement」の文面が表示されます。画面の指示に従い、yesとタイプすると「server」ディレクトリー以下に OPRO X Server がインストールされます。

インストーラーに対する実行権限が必要です。

$ ./oxs274NNx64_linux.bin
==================================================================
OPRO X Server 2.7.4
Copyright (C) 2001-2014 OPRO Japan Co., Ltd. All rights reserved.

******* * * * License Agreement * * * *******

Please read carefully the following terms and conditions before using
this software. Unless you have entered into a separate license agreement
with OPRO Japan Co., Ltd. ("OPRO") (signed by OPRO), your use of this
software will be deemed to be your agreement to this License Agreement.

〜中略〜

OPRO reserves all rights not specifically granted in this Agreement.

For further information, please contact OPRO Japan Co., Ltd.

********************** * * * * * * ***********************************
Do you agree to the above license terms? [yes or no]
yes
unpacking...
extracting...

〜中略〜

creating: server/works/texts/
creating: server/works/xslt/
inflating: server/works/xslt/au.xsl
inflating: server/works/xslt/DoCoMo.xsl
inflating: server/works/xslt/j_phone.xsl
inflating: server/works/xslt/mozilla.xsl
inflating: server/works/xslt/sharp_pda_browser.xsl
creating: server/works/attachments/
inflating: server/works/attachments/default.oxt
creating: server/works/datasources/
inflating: server/OXS-Readme.txt
inflating: server/OXS-License.txt
inflating: server/License.txt
Done.

************ OPRO X Server (OXS) installation completed. *************
**********************************************************************

パッチの適用

[OXS_HOME] 以下に、パッチの内容を上書きしてください。
詳細はパッチ付属の readme.txt をご参照ください。

尚、パッチは、パッチ番号部分の更新時のみ適用することができます。
異なるマイナーバージョン、リビジョンの場合は、パッチを上書きして適用することはできませんので、ご注意ください。

OPRO X Server のバージョンは例えば「OXS 2.7.4.1」のように表記され、「2.7.4.1」の部分はそれぞれ「メジャーバージョン.マイナーバージョン.リビジョン.ビルド」を表します。

例えば、2.7.4.m というバージョンに対しては、2.7.4.n というバージョンのパッチのみ適用することができます。

2.7.4.m に対して 2.7.4.n パッチ → ○ パッチレベルの更新なので適用可
2.7.0.m に対して 2.7.4.n パッチ → × パッチレベルの更新ではないので適用不可

インストールされている OPRO X Server のバージョンは、 [OXS_HOME]/bin/version.sh を実行することにより、確認できます。

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

IN_FILE ディレクトリーの作成

IN_FILE ディレクトリーは、OPRO X Designer で作成したテンプレートファイル(.oxt)を格納するためのディレクトリーです。
Linux / UNIX 版インストーラーでは、インストール時に [OXS_HOME]/templates/ が作成されますので、特に新規作成する必要はありません。

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

OUT_FILE ディレクトリーの作成

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

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

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

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 を使用する場合

Windows 版のセットアップ方法の「CGI を使用する場合」を参照してください。

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

関連項目: 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 / サーブレットを動作させるためのアプリケーションサーバーの設定方法については、弊社製品サポートの対象外となります。予めご了承ください。

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

ODCAW2.properties の設定

[OXS_HOME]/bin/ODCAW2.properties をテキストエディタ等で開き、「ODCAW xml path」の項目に、ODCAW.xml のパスを記述します。
ODCAW.xml は、デフォルトでは [OXS_HOME]/conf/ にあります。

# ODCAW xml path
ODCAW_XML_FILE=/home/odcaw2/server/conf/ODCAW.xml

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

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 に記載されているシリアルキーに書き換える
-->
  <PORT>6001</PORT>
  <LOG>
   <ERROR enabled="YES">
    <FILE delete="NO" ttl="240" unit="hrs">/home/odcaw2/server/logs/Error.log</FILE>
    <MSG_FILE>/home/odcaw2/server/conf/Error_description.err</MSG_FILE>
   </ERROR>
   <ACCESS enabled="YES">
    <FILE delete="YES" ttl="240" unit="hrs">/home/odcaw2/server/logs/Access.log</FILE>
   </ACCESS>
   <QUERY enabled="YES">
    <FILE delete="YES" ttl="240" unit="hrs">/home/odcaw2/server/logs/Query.log</FILE>
   </QUERY>
  </LOG>
<!--
ODCAW.xml 内にある「/home/odcaw2/server/」を全て、OPRO X Server インストールディレクトリーのパスに書き換える
-->
  <FONT>
   <EMBED_FONT_LIST>/home/odcaw2/server/works/fonts/embed_fonts.txt</EMBED_FONT_LIST>
   <LOCAL_PATH>/home/odcaw2/server/works/fonts/</LOCAL_PATH>
   <SYSTEM_PATH>/usr/openwin/lib/X11/fonts/TrueType/</SYSTEM_PATH>
<!--
フォント情報ファイル(後述)のパスを指定
-->
   <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/cgi-bin/opro/odcaw2/odcaw2_cgi.cgi</ODCAW_CGI>
<!--
CGI(もしくはサーブレット)の URL を指定
-->

〜中略〜

 <ODDS>

〜中略〜

  <PRINTFORM_MARGIN adjust="YES"/>
<!--
OXBでの印刷、クライアント直接印刷を行う場合で、カスタム用紙サイズ(OXDで用紙サイズが「Custom」になっているもの)を使用する場合の、用紙情報の取得方法を設定します。
新規でOPRO X Serverをセットアップする場合は、「YES」に設定してください。
アップデート等、既に稼働しているOPRO X Serverの設定を引き継ぐ必要がある場合は、既存の設定に従ってください。
-->
  <PATH>
   <IN_FILE>
    <LOCAL>/home/odcaw2/server/templates/</LOCAL>
<!--
テンプレート(OPRO X Designer で作成する .oxt ファイル)を格納するパスを指定
-->
   </IN_FILE>
   <OUT_FILE delete="NO" ttl="15" unit="mins">
<!--
ウェブサーバー上に作成したドキュメント(OPR、PDF等)を自動削除する設定です。
例えば、delete="YES" ttl="24" unit="hrs" とすると、24時間で削除されます。
unit には、secs(秒)、mins(分)、hrs(時間)を設定できます。
-->
    <LOCAL>/usr/local/apache2/htdocs/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>/home/odcaw2/server/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>/usr/local/apache2/htdocs/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 Server がドキュメントを生成する際に必要となります。
フォント情報ファイルは、OPRO X Server に付属している Windows アプリケーション([OXS_HOME]/tools/font/OPROFontGenerator.exe)で作成することができる、拡張子 ofi のファイルです。
(OPROFontGenerator.exe は こちら からダウンロードすることも可能です)

テンプレートで使用するフォントのフォント情報ファイルを作成し、「ODCAW.xml の設定」の ODCAW/COMMON/FONT/LOCAL_PATH 要素で設定したディレクトリーに保存してください。

OPROFontGenerator.exe の詳しい操作方法については、フォント情報ファイルについて の「フォント情報ファイル作成手順」をご覧ください。

PDF へのフォントの埋め込みを行う場合は、フォント情報ファイルを使用することはできません。フォントの実体(*.ttc、*.ttf)を、ODCAW.xml の ODCAW/COMMON/FONT/SYSTEM_PATH 要素で設定したディレクトリーに配置する必要があります。

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

起動と停止

コンソールモードまたはバックグラウンドモードの、いずれかの方法で OPRO X Server を起動します。

コンソールモード

コンソールモードでは、コンソールに標準出力が表示されます。

起動
[OXS_HOME]/bin/server.sh に、run オプションを付加して実行します。
$ ./server.sh run
停止
キーボードの [Ctrl] + [C] で OPRO X Server を停止します。

バックグラウンドモード

バックグラウンドモードでは、標準出力・標準エラー出力が、bin ディレクトリーにそれぞれ oxs.out.N.log、oxs.err.N.log (N=0...4) という名前で出力されます。(OXS を起動するごと、あるいは、ファイルサイズが 5 MB を超えるたびに N の値が 0 から順送りになります。標準エラー出力には、OXS の起動時の Java システムプロパティも出力されます。)

起動
[OXS_HOME]/bin/server.sh に、start オプションを付加して実行します。
$ ./server.sh start
または、[OXS_HOME]/bin/startup.sh を実行します。
$ ./startup.sh
停止
[OXS_HOME]/bin/server.sh に、stop オプションを付加して実行します。
$ ./server.sh stop
または、[OXS_HOME]/bin/shutdown.sh を実行します。
$ ./shutdown.sh

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

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