XPLATFORM HTML5のインストール

XPLATFORM HTML5を使う場合、XPLATFORM HTML5 サーバーをインストールしなければなりません。このインストールは一般的なウェブアプリケーションインストール方法と同じです。インストール方法は、warファイルを利用して新しいContextにインストールする方法と、jarファイルを利用して既存のContextにインストールする方法の、 大きく 2種類に分けられます。

システム要求事項

XPLATFORM HTML5サーバーを実行するためには次のようなシステムが必要です。

項目

要求事項

Java

1.4 以上

Memory

制限なし。1G以上推奨

Web Application Server

J2EE ContainerをサポートするWAS

OS

制限なし。テストはWindows、Linuxにて

Warファイルを利用した新規Contextのインストール

XPLATFORM HTML5のwarファイルを利用してインストールする方法を説明します。次の説明はApache Tomcatを基準にした説明です。他のWeb Application Serverは該当WASのマニュアルを参照してください。

Context設定ファイルを作成してインストールする方法は、Tomcatバージョンによってサポートされないことがあります。Tomcat 7.2以上のバージョンでは、通常の配布ができません。

ステップ1 : XPLATFORM HTML5の warファイルコピー

XPLATFORM HTML5のwarファイルを適当なディレクトリにコピーします。Warファイルは XPLATFORM HTML5配布版に含まれたxplatform9-ajax.warです。

ステップ2 : Tomcatの Context 設定ファイルの作成

<Tomcat Home>/conf/Catalina/localhost/xplatform9-ajax.xmlファイルを次のような内容で作成します。

例えば1段階のWarファイルを“C:\XAE\xplatform9-ajax.war”にコピーしたならば、

<?xml version="1.0" encoding="UTF-8"?>
	<Context path="/xplatform9-ajax" docBase="C:/XAE/xplatform9-ajax.war">
</Context>

ステップ3: Tomcat 再起動

Tomcatを再起動します。

上の方法より簡潔にしたいならwarファイルを<Tomcat Home>/webapps ディレクトリにコピーすると、同じ結果が得られます。

Jarファイルを利用した既存Contextのインストー ル

XPLATFORM HTML5のjarファイルを利用してインストールする方法を説明します。既存Contextを維持したままXPLATFORM HTML5サーバーをインストールするためには、jarファイルをコピーしてインストールすることができます。

例えば、便宜上すでにインストールされたウェブアプリケーションの名前を“myajax” にし、インストールパスを“<Tomcat Home>/webapps/myajax”にします。

ステップ1 : XPLATFORM HTML5の jarファイルをコピー

XPLATFORM HTML5のjarファイルを、既存Contextのライブラリディレクトリにコピーします。例題のプロジェクトでは、<Tomcat Home>/webapps/myajax/WEB-INF/lib ディレクトリにXPLATFORM HTML5 jarファイルをコピーします。Jarファイルリストは“3.6 インストール用ファイル”を参照してください。

ステップ2 : 外部依存ライブラリコピー

XPLATFORMHTML5の外部依存ライブラリを既存Contextのライブラリディレクトリにコピーします。例題のプロジェクトでは<Tomcat Home>/webapps/myajax/WEB-INF/lib ディレクトリにXPLATFORM HTML5の外部依存ライブラリをコピーします。外部ライブラリリストは“インストール用ファイル”を参照してください。

ステップ3 : web.xml 変更

Web.xmlの内容に次のような Servlet設定を追加します。

例題のプロジェクトでは<Tomcat Home>/webapps/myajax/WEB-INF/web.xmlパスにあります。

<servlet>
<init-param>
<!-- StreamLog を出力するかどうか指定 -->
<param-name>streamLog</param-name> 
<param-value>false</param-value> 
</init-param>
<init-param>
<!—サービスの実行時間を出力するかどうかを指定 -->
<param-name>elapsedTime</param-name> 
<param-value>false</param-value> 
</init-param>
</servlet> 

<! -- 要求されたデータを他のサービス(url)に転送し、他のサービス(url)から
受信されたデータに応答する中間伝達者の役割のHttpServletです -- >
<servlet>
<servlet-name>ForwardRequest</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.ForwardRequestServlet</servlet-class>
</servlet>

<!—システムファイル(イメージ、環境ファイルなど)を検索して返します -->
<servlet>
<servlet-name>LoadResource</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.LoadResourceServlet</servlet-class>
</servlet>

<!-- イメージを加工して新しいイメージとして返します(Stretch対応) xplatform9- ajax- imagefilterインストールが必要です-->
<servlet>
<servlet-name>ImageFilter</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.imagefilter.ImageFilterServlet</servlet-class>
<init-param>
<param-name>cacheDir</param-name>
<param-value>cache/images</param-value>
</init-param>
<init-param>
<param-name>useCache</param-name>
<param-value>true</param-value>
</init-param> 
</servlet>

<!-- Excelのエクスポート要求を処理します。 xplatform- ajax- exportexcelインストールが必要です -->
<servlet>
<servlet-name>ExportExcel</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.exportexcel.ExportExcelServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>ForwardRequest</servlet-name>
<url-pattern>/services/ForwardRequest</url-pattern>
</servlet-mapping> 
<servlet-mapping>
<servlet-name>ImageFilter</servlet-name>
<url-pattern>/services/ImageFilter</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>LoadResource</servlet-name>
<url-pattern>/resources/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>ExportExcel</servlet-name>
<url-pattern>/services/ExportExcel</url-pattern>
</servlet-mapping>

ステップ4: Tomcat 再起動

Tomcatを再起動します。

ライセンス

XPLATFORM HTML5は二つのライセンスを必要とします。一つはUX-Studioの使用に対するライセンスで、もう一つはX-API使用に対するライセンスです。二つのライセンスをともに適用してこそ XPLATFORM HTML5を正常に利用できます。

UX-Studio 使用に対するライセンス

ライセンスを登録するとHTML5バージョン開発のためのUX-Studioの使用権限を取得することができます。発行されたライセンスキーを画面のように入力してください。

ライセンスの入力画面はメニューの“Help > About UX-Studio… > Enter New License”ボタンをクリックすると表示されます。

Licenseファイル

次はLicenseファイルの種類です。

ファイル名

内容

XPLATFORM_Server_License.xml

XML形式のファイルで提供します。

X-API jarファイルと同じ位置またはclassesフォルダにあります。

X-API、HTML5 実行の時チェックします。

XPLATFORM_Client_License.xml

XML形式のファイルで提供します。

Webにアクセス可能なパスにあります。

ADLのlicense urlに、該当ファイルへのパスとファイル名を設定します。

Runtime、Widget 実行の時チェックします。

Tool License

Product Keyを文書で提供

UX-StudioのHelpAboutUX-Studioで登録します。

X-API 使用に対するライセンス

ライセンスを登録すれば、サーバーとの連動のためのモジュールであるX-APIの使用権利を取得することができます。(プロジェクトコンパイルと配布の時に必要です。)

X-APIのライセンスファイル名は“XPLATFORM_Server_License.xml”です。

X-API使用に対するライセンスの適用は、二つの方法があります。

  1. ライセンスファイルをjarファイルと同じ位置に置きます。

  2. ライセンスファイルをクラスパスに含まれる位置に置きます。

もし上記二つの位置に同時にライセンスファイルが存在する場合、 1) にあるライセンスが先に適用されます。jarファイルと同じ位置に含める場合、一般的にWeb Applicationの/WEB-INF/lib になります。クラスパスに含める場合、一般的にはWeb Applicationの/WEB-INF/classesになります。

アップグレード

XPLATFORM HTML5の一部jarファイルバージョンがアップグレードされた場合にインストールする方法を説明します。場合によっては、既存の生成ファイルを全部削除して、リコンパイルしてから、ファイルを作成しなければならないこともあります。

ステップ1 : アップグレードされた XPLATFORM HTML5の jar ファイルコピー

バージョンがアップグレードされたXPLATFORM HTML5のjarファイルを既存jarファイル位置と同じディレクトリにコピーします。例えば <Tomcat Home>/webapps/myajax/WEB-INF/libにバージョンがアップグレードされた xplatform9-ajax-x.x.jarをコピーします。

ステップ2 : 以前 XPLATFORM HTML5の jar ファイル削除

バージョンがアップグレードされた以前のjarファイルを削除します。バージョンの。違う同じjarが同じ位置にある場合、エラーの原因にもなります。

ステップ3 : 必要によって既存ファイルの削除

Jarファイルのアップグレードによって生成ファイルの内容が変わる場合、それ以前に生成された生成ファイルを削除しなければならない場合も発生します。一般的に生成ファイルの位置は、Context ディレクトリ下のUX-Studioで作成したXPLATFORMのプロジェクト名を持ったディレクトリです。例えば“sample”プロジェクトの場合、<Tomcat Home>/webapps/myajax/sample ディレクトリが “sample”プロジェクトの生成ファイルの位置です。

ステップ4 : Tomcat 再起動

Tomcatを再起動後にプロジェクトページの動作をテストします。3段階目によって既存生成ファイルを削除した場合、5段階目を経た後にテストを行います。

ステップ5 : 既存生成ファイルを削除した場合再コンパイル

3段階によって既存、生成ファイルを削除した場合、UX-Studioを利用して該当プロジェクトの再コンパイルを行います。

インストール用ファイル

XPLATFORM HTML5 サーバーインストールのためのファイルは次の通りです。

XPLATFORM HTML5

次は XPLATFORM HTML5のインストールファイルです。

ファイル名

必須

主要機能

Xplatform-xapi-x.x.jar

必須

XPlatform X-API

Xplatform9-ajax-x.x.jar

必須

XPlatform HTML5

次はXPLATFORM HTML5の外部依存ライブラリです。

モジュール名

必須

主要機能

Commons-logging-x.x.jar

必須


Commons-collections-x.x.jar

必須


Commons-beanutils-x.x.jar

必須


Commons-digester-x.x.jar

必須


Commons-codec-x.x.jar

必須


xpp3_min-1.1.4c.jar

必須


xstream-1.3.1.jar

必須


XPLATFORM HTML5 Imagefilter

次は XPLATFORM HTML5 Imagefilterのインストールファイルです。

ファイル名

必須

主要機能

Xplatform9-imagefilter-x.x.jar

必須

Image Filtering

次はXPLATFORM HTML5の外部依存ライブラリです。

モジュール名

必須

主要機能

com.springsource.org.apache.batik.ext.awt-x.x.x.jar

必須


commons-logging -x.x.x.jar

必須


Commons-codec-x.x.jar

必須


gif4j_pro_x.x.jar

必須


imagefilter-x.x.jar

必須


XPLATFORM HTML5 Exportexcel

次は XPLATFORM HTML5 Exportexcelのインストールファイルです。

ファイル名

必須

主要機能

xplatform9-exportexcel-x.x.jar

必須

Export Excel

xplatform-xapi-x.x.jar

必須


次はXPLATFORM HTML5 Exportexcelの外部依存ライブラリです。

モジュール名

必須

主要機能

commons-beanutils-x.x.x.jar

必須


commons-logging -x.x.x.jar

必須


Commons-collections-x.x.x.jar

必須


Commons-digester-x.x.x.jar

必須


Poi-x.x.jar

必須


外部オプションライブラリ

次はXPLATFORM HTML5の外部オプションライブラリです。

モジュール名

必須

主要機能

Log4j-x.x.jar

選択


必須でインストールする必要があるjarは開発及び運用時に必ず必要となります。