ドメインセットアップ

概要

バッチドメインのセットアップを行うためのsetupDomainコマンドを提供しています。 ドメインセットアップ機能とは以下の機能で構成されます。

関連

1. ドメインの作成

1.1. ドメインの作成

バッチドメイン名を指定してドメイン作成コマンド(setupDomain create)を 実行することで、バッチドメインの作成を行うことができます。 バッチドメインの設定を記述したsetupDomainコンフィグファイル (<domainName>.properties) の設定内容を反映したバッチドメインの作成を行います。 setupDomainコンフィグファイルはsetupDomainコマンドと同じフォルダに存在する必要があります。

また、このとき、setupDomainコンフィグファイルに記述された情報から、自動でデータベース接続情報を記述したファイルを ${DOMAIN_HOME}/config/batch/databases配下に作成します。 このファイルは、ジョブリポジトリのセットアップを行う、repoadminコマンド実行時に、データベースの接続情報として使用することができます。
setupDomainコンフィグファイル内には複数のデータベース接続情報を記述することができますが、1つの接続情報ごとに1ファイルを、 <DB情報識別名>.propertiesという名前で作成します。 setupDomainコンフィグファイル記述する内容の詳細や、<DB情報識別名>.propertiesの詳細に関しては 定義ファイルリファレンスをご参照下さい。

1.2. ドメインのエディション

登録しているライセンスに応じて、Standard Editionのドメイン、Express Editionのドメインという2種類のドメインを作成できます。 詳しくは以下を参照してください。

1.3.ドメインの設定

setupDomain create コマンドを実行することで、ドメインの作成に加えて

を行うことが可能です。 これらはドメイン作成時 (setupDomainコマンド実行時) に行わなくても、ドメイン作成後に別途行うことも可能です。
以下でそれぞれについて説明します。

ドメインへのデータソース登録

データソースをドメインに登録するために、setupDomain create コマンドの内部で otxadmin create-jdbc-datasource コマンドが実行されます。 otxadmin create-jdbc-datasource コマンドの実行時に <バッチドメイン名>.properties の database.<DB情報識別名>.XXXで定義されるパラメータがオプションとして渡され、 database.<DB情報識別名>.jndiName に指定したJNDI名でドメインに登録されます。
なお、DB情報識別名とは、<バッチドメイン名>.properties で定義を行う、データベースの情報を識別する名前です。例えばDB情報識別名がSampleDBの場合、 <バッチドメイン名>.properties 上にdatabase.SampleDB.XXXという形で定義されたデータベースの情報が使用されます。

デフォルトで用意されている batchsv1.properties ではDB情報識別名としてsampleDBという値が使われ、以下のパラメータが定義されています。 database.sampleDB.jndiName に設定されている jdbc/default というJNDI名でドメインに登録されます。

database.sampleDB.dataSourceType=JDBCEX_Derby
database.sampleDB.jdbcMajorVersion=4
database.sampleDB.dataSourceName=REPO
database.sampleDB.jdbcUserName=bsadmin
database.sampleDB.jdbcPassword=bsadmin
database.sampleDB.serverName=127.0.0.1
database.sampleDB.portNumber=1527
database.sampleDB.jndiName=jdbc/default
database.sampleDB.useJTA=true
otxadmin create-jdbc-datasource実行時に与えるオプションを追加する場合は、 batchsv1.properties の記入方法に従ってパラメータを追加してください。
otxadmin create-jdbc-datasourceコマンドの詳細については、WebOTX Application Serverの運用管理コマンドリファレンスをご確認ください。

ジョブリポジトリのセットアップ

ジョブリポジトリのセットアップを行う場合は、ジョブリポジトリのセットアップの有無を表すパラメータの値をtrueとし、ジョブリポジトリをセットアップする対象のデータベース情報を指定する必要があります。 対象のデータベース情報の指定は、DB情報識別名を指定することで行います。

Derbyのセットアップ

derbyのセットアップを行う場合は、Derbyのセットアップの有無を表すパラメータの値をtrueとし、 セットアップするDerbyを表すデータベース情報を指定する必要があります。Derbyを表すデータベース情報の指定は、DB情報識別名を指定することで行います。

1.4.ドメインの作成例

以下で、ジョブリポジトリのセットアップと、Derbyのセットアップの有無の組み合わせによるバッチドメイン作成例と、 それぞれの場合に設定する<バッチドメイン名>.propertiesファイルのパラメータを示します。

バッチドメイン作成例 ジョブリポジトリをセットアップする Derbyセットアップの有無 Derby上にジョブリポジトリをセットアップする 説明
a
×
×
ユーザが用意したデータベースにジョブリポジトリのセットアップを行い、Derbyのセットアップは行わない場合の例です。
b
Derbyをセットアップし、その上にジョブリポジトリをセットアップする場合の例です。 webotx.batch.setup.derby.startup=true とすることで、ドメインの起動/停止とDerbyの起動/停止を同期させることが可能です。
c
×
×
×
ジョブリポジトリのセットアップを行わない場合の例です。
ジョブを実行するためには、repoadmin コマンドを別途実行して、ジョブリポジトリを作成する必要があります。

(a). ユーザのデータベースにジョブリポジトリのセットアップを行う (Derbyのセットアップは行わない)

上記に加えて、webotx.batch.database.<DB情報識別名1>.XXX=YYY には、セットアップを行うデータベースの設定を記述しておく必要があります。
なお、この例の場合、以下の3点にご注意ください。

(b). Derbyのセットアップを行い、そのDerby上にジョブリポジトリのセットアップを行う (既定値)

上記に加えて、webotx.batch.database.<DB情報識別名1>.XXX=YYY には、セットアップを行うDerbyの設定を記述しておく必要があります。 また、webotx.batch.database.<DB情報識別名1>.dbType=derby と設定してください。
このように設定されていない場合、ドメインの作成に失敗しますのでご注意ください。

(c). ジョブリポジトリのセットアップ、Derbyのセットアップともに行わない

上記のように設定した場合、ジョブリポジトリのセットアップ、Derbyのセットアップは行われません。
ジョブを実行するためには、repoadmin コマンドを別途実行して、ジョブリポジトリのセットアップを行う必要があります。

2. ドメインの削除

バッチドメイン名を指定してドメイン削除コマンド(setupDomain delete)を実行することで、指定したバッチドメインを削除することができます。

3. ドメインのアップグレード

Upgrade License、もしくはStandard EditionのLicenseが登録されている場合、ドメインアップグレードコマンド(setupDomain upgrade)を実行することで、 バッチドメインの設定内容を保持したまま、Express EditionのバッチドメインをStandard Editionのバッチドメインへとアップグレードすることが可能です。