主要モジュールの実行方法

XPLAFORMが提供する3つのモジュールは、使用者がXPLATFORM以外の他のプログラムで実行します。この中の2つ(XPLATFORMAX, XPLauncher)はウェブブラウザにより実行され、残りの1つ(XPLATFORM.exe)はOSのコマンドプロンプトで実行されます。

XPLATFORMAX

XPLATFORMAXは、XPLATFORMエンジンをウェブブラウザ上で実行させるためのActiveXモジュールです。

このモジュールは、以下のセットアップファイルに含まれています。

XPLATFORMAXは、ウェブブラウザ上のオブジェクトであるため element(プロパティ、メソッド、イベント)を持ちます。

ここではelementの概略的な説明のみをします。

詳細な説明は“XPLATFORM Reference Guide”を参照してください。

クラスID

AcitveXのためのクラスID“43C5FE00-DD32-4792-83DB-19AE4F88F2A6”です。

以下は、このモジュールを活性化するためのHTMLコードです。

<SCRIPT LANGUAGE="javascript">
document.write('<OBJECT ID="XPlatformAXCtrl" CLASSID="CLSID: 43C5FE00-DD32-4792-83DB-19AE4F88F2A6"'
+'"CODEBASE="http://127.0.0.1/XPLATFORM9_XPLauncher.cab#VERSION=2011,10,4,1"  onError="fn_onError()" >'
+ '<PARAM NAME="key" VALUE=" XP_Sample ">'
+ '<PARAM NAME="xadl" VALUE="http://127.0.0.1/XP_Service/ SampleADL.xadl">'
+ '</OBJECT>');

プロパティ

XPLATFORMAXのプロパティを整理すると、以下の通りです。必須項目された値を指定すればXPLATFORMエンジンを起動することができます。

プロパティ名

必須

説明

基本値

key

O

サービスのキー値を設定します。

同一ADL上で唯一な値でなければなりません。

基本値なし

xadl

O

サービスのADLパスを指定します。

基本値なし

componentpath

X

使用者のPC上にコンポーネントが保存されるパスを指定します。一般的には、この値は指定しません。

基本値 ="%USERAPP%\TobeSoft\XPLATFORM9\Component\"

%USERAPP%の値は“エイリアスパス”を参照してください。

autosize

X

XPLATFORMのサイズがウェブブラウザのサイズの影響を受けて動的に変わるのか否かを指定します。

falseの場合には、ウェブブラウザのPlugin WidthとHeight値が適用されます。

基本値=true

commthreadcount

X

XPLATFORMエンジンが使用する通信スレッドの個数を指定します。

使用者の端末機にCPUコアが複数ある時には、値を大きく指定してください。

この機能は通信処理にのみ使用するため、いくつかの通信を同時に使用したい場合には、値を大きくすればスピーディーな応答結果が得られます。

しかし、ネットワーク自体が遅い場合には、値を大きくしてもあまり効果がありません。

基本値=5

errorfile

X

XPLATORMエンジンが表示するエラー情報が定義されたファイルパスです。

指定しない場合には、XPLATFORMエンジンの基本エラー情報が表示されます。一般的には指定しません。

基本値なし

handleflag

X

XPLATFORM応用プログラムが終了してから、exit()イベントを発生させるか否かを指定します。

指定しない場合にはtrueとなりexit()が発生します。

基本値=true

commthreadwaittime


XPLATFORM応用プログラムが使用するスレッドが何もしない場合には、該当のスレッドが終了します。この時の終了前の待ち時間(秒)を設定するプロパティです。

usewininet

X

サーバーとの通信方法を指定するプロパティとして、WININET通信ライブラリを使用して通信をするかを設定するプロパティです。

基本値=false

autostart

X

AX コントロールが作成される時に自動的にrun()を

実行するかどうかを決定するプロパティです。

基本値=false

メソッド

XPLATFORMAXを実行することができるメソッドを概略的に整理すると、以下の通りです。

イベント名

説明

callscript()

XPLATFORMAXで起動中のXPLATFORMエンジンのスクリプトメソッドを実行するためのメソッドです。

getvariablevalue()

XPLATFORMAXでXPLATFORMエンジンのグローバル変数の変数値を得るメソッドです。

run()

XPLATFORMAXがXPLATFORMエンジンを実行するメソッドです。

setvariablevalue()

XPLATFORMAXでXPLATFORMエンジンのグローバル変数の変数値を設定するメソッドです。

stop()

PlugInがXPLATFORMの全てのマネージャを中止させるメソッドです。

quit()

PlugInがXPLATFORMを終了するメソッドです。

addWebInfo()

現在のブラウザのクッキーの情報を自動的にglobalvariableのcookie変数に追加するメソッドです。

イベント

XPLATFORMAXで発生するイベントを整理すると、以下の通りです。

イベント名

説明

addlog()

  • XPLATFORMスクリプトでtrace()関数を実行した時に発生するイベントです。

  • XPLATFORMスクリプトでtrace()関数引数値がそのままイベントの引数値として適用されます。

beforeexit()

  • XPLATFORMエンジンの終了直前に発生するイベントです。

  • Beforeexitイベント後にexitイベントが発生します。

  • Beforeexitイベントでhandledflag値をfalseで設定すると、exitイベントが発生しません。即ち、終了しません。

  • XPLATFORMスクリプトでexit関数を呼び出した時に発生し、アプリケーションのonbeforeexitイベントの発生後にXPLATFORMAXでbeforeexitが発生します。

communication()

  • XPLATFORMの通信を開始する時と終了する時に発生するイベントです。

error()

  • XPLATFORMAXのロード中またはXPLATFORMエンジンの実行中にエラーが生じると発生するイベントです。

exit()

  • XPLATFORMエンジンが終了する時に発生するイベントです。

  • beforeexit()イベントの影響を受けます。

load()

  • XPLATFORMエンジンの初期のロードが完了してから発生するイベントです。

  • XPLATFORMスクリプトではonloadイベントが発生します。

  • loadtypedefinition loadingglobalvariables ロードの順にイベントが発生します。

loadingglobalvariables()

  • グローバル変数のオブジェクトが生成されてから発生するイベントです。

  • データセットとフォームのURLはロード前であるため、イベント内でロードに必要な情報を追加・修正すれば変更された値でロードされます。

  • XPLATFORMスクリプトでもアプリケーションのonloadingglobalvariablesイベントが発生します。

loadtypedefinition()

  • TypeDefinitionに登録されたコンポーネントのロードを完了してから発生するイベントです。

  • コンポーネントの配布も完了したことを意味します。

  • XPLATFORMスクリプトでもアプリケーションのonloadtypedefinitionイベントが発生します。

usernotify()

  • XPLATFORMスクリプトでuserNotify()関数を呼び出す場合にPlugInで発生するイベントです。

  • XPLATFORMスクリプトでのuserNotify()関数の引数値がそのままイベントの引数値として適用されます。

XPLauncher

XPLauncherは、XPLATFORMエンジンを専用ブラウザに実行するためのActiveXモジュールです。

このモジュールは、以下のセットアップファイルに含まれています。

XPLauncherは、ウェブブラウザ上のオブジェクトであるためelement(プロパティ、メソッド、イベント)を持ちます。

ここではelementの概略的な説明のみをします。

詳細な説明は“XPLATFORM Reference Guide”を参照してください。

クラスID

AcitveXのためのクラスIDは“A30D5481-7381-4dd9-B0F4-0D1D37449E97”です。

以下は、このモジュールを活性化するためのHTMLコードです。

<SCRIPT LANGUAGE="javascript">
document.write('<OBJECT ID="XPlatformAXCtrl" CLASSID="CLSID: A30D5481-7381-4dd9-B0F4-0D1D37449E97"'
+'"CODEBASE="http://127.0.0.1/XPLATFORM9_XPLauncher.cab#VERSION=2011,10,28,1"  onError="fn_onError()" >'
+ '<PARAM NAME="key" VALUE=" XP_Sample ">'
+ '<PARAM NAME="xadl" VALUE="http://127.0.0.1/XP_Service/ SampleADL.xadl">'
+ '</OBJECT>');

プロパティ

XPLauncherのプロパティを整理すると、以下の通りです。必須項目を指定すればXPLATFORMエンジンを起動させることができます。

プロパティ名

必須

説明

基本値

Key

O

サービスのキー値を設定します。

同一ADL上で唯一な値でなければなりません。

基本値なし

Xadl

O

サービスのADLパスを指定します。

基本値なし

Commthreadcountあ

X

XPLATFORMエンジンが使用する通信スレッドの個数を指定します。

使用者の端末機にCPUコアがいくつかある時には、値を大きく指定してください。

この機能は通信処理にのみ使用するため、いくつかの通信を同時に使用したい場合には、値を大きくすればスピーディーな応答結果が得られます。しかし、ネットワーク自体が遅い場合には、値を大きくしてもあまり効果がありません。

基本値=5

componentpath

X

使用者のPC上にコンポーネントが保存されるパスを指定します。

一般的には、この値は指定しません。

基本値

="%USERAPP%\TobeSoft\XPLATFORM\9.2\Component\"

%USERAPP%の値は“エイリアスパス”を参照してください。

errorfile

X

XPLATFORMエンジンが表示するエラー情報が定義されたファイルパスです。指定しない場合には、XPLATFORMエンジンの基本エラー情報が表示されます。

一般的には指定しません。

基本値なし

globalvalue

X

XPLATFORMエンジンが駆動する時にグローバル変数に追加される変数を設定するプロパティです。

基本値なし

loadingimage

X

XPLATFORMエンジンが画面やデータのロード時に表示するイメージを設定するプロパティです。

サーバーパスが入力される場合には、直接にダウンロードしてから、設定されたコンポーネントパスの下に保存します。

基本値なし

splashimage

X

XPLATFORMエンジンがロードされるまで表示するスプラッシュイメージのパスを指定します。

指定しない場合には、XPLATFORMの基本イメージが表示されます。

このイメージは画面の中央に表示されます。

このイメージは、XPLATFORMエンジンがロードされる間のみ表示されます。

基本値なし

onlyone


キーとXADLの値を、同一インスタンス1つだけ使用するかどうかを設定するプロパティです。

commthreadwaittime


XPLATFORM応用プログラムが使用するスレッドが何もしない場合には、該当のスレッドが終了します。この時の終了前の待ち時間(秒)を設定するプロパティです。

enginesetupkey


実行パスとして使用する特定バージョンのXPLATFORM ProductKeyの値を指定するプロパティです。

サイトで別途作成したSetup Moduleを使用する時、このプロパティに Setupを生成する時に与えられる Product Keyを設定すれば固定されたパスにより、LauncherでRuntimeの実行が不可だった問題を解決することができます。

メソッド

XPLauncherを実行することができるメソッドを概略的に整理すると、以下の通りです。

イベント名

説明

launch()

XPLATFORMエンジンを専用のブラウザで実行させます。

makeshortcut()

ショートカットを生成します。

isexistshortcut

入力された引数に対応するショートカットアイコンがあるかどうかを確認するメソッドです。

getEngineVersion

システムにインストールされたエンジンキーに対応するエンジンインストールバージョンをインポートするメソッドです。

download

アプリケーション実行時に使用されるリソースをダウンロードするメソッドです。

deleteshortcut

ショートカットアイコンを削除するメソッドです。

addWebInfo

現在のブラウザのクッキーの情報を自動的にglobalvariableのcookie変数に追加するメソッドです。

イベント

XPLauncherで発生するイベントを整理すると、以下の通りです。

イベント名

説明

error()

XPLauncherの実行中にエラーが発生すると、実行されるイベントです。

XPLATFORM.exe(V9.2変更事項含め)

XPLATFORMのエンジンは、MS Windows上のコマンドプロンプトで直接に実行することができます。主にショートカットを使用しますが、実行ファイルのXPLATFORM.exeを様々なオプションにより実行することができます。

実行Syntax

以下はオプションを使用した実行例です。

XPLATFORM.exe –option1 option1_value –option2 option2_value … -optionN –optionN_value

実行オプション

以下はオプションの説明です。

実行

オプション

説明

X

(必須)

パス名(string)

ADLファイルへのパスを指定します。

K

(必須)

キー名(string)

サービスのキーを設定します。

URL上のサービスの中で唯一の値でなければなりません。

C

パス名(string)

使用者の端末機にコンポーネントが設置されるパスを指定します。

指定しなければ、

"%USERAPP%\TobeSoft\XPLATFORM9\9.2\Component\"が指定されます。

%USERAPP%の値は“エイリアスパス”を参照してください。

SP

パス名(string)

スプラッシュイメージのパスを指定します。

指定しない場合には、XPLATFORMの基本イメージが表示されます。

このイメージは画面の中央に表示されます。

このイメージは、XPLATFORMエンジンがロードされる間のみ表示されます。

LF

位置値(int)

アプリケーションの初期実行の左位置を指定します。

最初の画面のメインフレームフレームに適用されます。

TP

位置値(int)

アプリケーションの初期実行の上部位置を指定します。

最初の画面のメインフレームフレームに適用されます。

WD

サイズ(int)

アプリケーションの初期実行の幅を指定します。

最初の画面のメインフレームフレームに適用されます。

HT

サイズ(int)

アプリケーションの初期実行の高さを指定します。

最初の画面のメインフレームフレームに適用されます。

ERR

パス名

(string)

エラーコード値を定義した“errordefine.xml”ファイルのパスを指定します。

XPLATFORMエンジンが表示するエラー情報を変更する時に使用します。

指定しない場合には、XPLATFORMエンジンの基本エラー情報が表示されます。

THR

個数(int)

エンジン内部の通信及びその他のマネージャのスレッド数を指定します。

指定しない場合には5となります。

使用者の端末機が旧仕様の場合には、値を大きく指定してください。

TW

時間(int)

XPLATFORMランタイムの通信スレッドの待ち時間を指定します。

LG

パス名

(string)

LoadingImageを設定することができるパスを指定します。

OO

多重起動

(bool)

同一なキー、XADLとしてXREを起動させる時、XREを多重起動させるかどうかを指定します。

GF

ファイル名

(string)

XPLauncherからグローバル変数を設定した場合、XPLATFORMエンジンに値を渡すために使用するTempファイル名です。

XPLATFORMが立ち上がる時、読まれて削除します。

XPLauncherを使用せず直接入力する場合には正常に動作しない場合があります。

V

Variable

文字列

(string)

XREを開く時グローバル変数に追加する変数リストを設定します。

変数名:タイプ=値  変数名:タイプ=値 の形式に入力します。区切りはスペースです。

つまり、"A:s=b C:g=d E=f"の形式になります。

通信時、クッキーとして使用する変数はタイプに s、通常の変数は型を入力しないか、または gで表記します。

SIE

可否 (bool)

Adlのロード時にエラーが発生する場合、エラーメッセージボックスを表示させて終了するかどうかを指定します。

CT

時間秒(int)

最初のネットワークが接続されているかチェックするTimeoutを設定します。ネットワークが接続されているかどうかをApplicationが起動される前にチェックします。Timeout時間の間にネットワークが接続されていない場合、自動的に終了します。

SCR

(V9.2追加)

スクリーン ID 文字列(string)

LayoutManagerで使用するための ScreenIDを設定します。

XPLATFORM.exeファイルのパス

XPLATFORM.exeファイルは、“XPLATFORM9_SetupEngine.cab”または

“XPLATFORM9_SetupEngine.exe”で設置されます。

設置パスは、MS Windowsの場合には以下の通りです。

\Program Files\TOBESOFT\XPLATFORM\9.2\XPLATFORM.exe