WebOTX Manual V10.3 (第4版) 目次を表示

---

10. バッチサービス

バッチサービスに関する運用操作について説明します。

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

バッチサービスは、バッチジョブの実行時に、そのジョブの実行情報をデータベースに書き込みます。 このデータベースのことをバッチサービスではジョブリポジトリと呼びます。バッチサービスではジョブリポジトリとして使用するDBとして以下のデータベースをサポートします。

• Oracle Database 19c
• Oracle Database 18c
• Oracle Database 12c
• PostgreSQL 11
• PostgreSQL 12.1

バッチサービスを利用してジョブを実行するには、ジョブリポジトリがセットアップされている必要があります。
以下でジョブリポジトリのセットアップ手順を説明します。

1. データベースの起動
   ジョブリポジトリとして使用するデータベースを起動します。
2. テーブル作成
   データベースに対して以下のSQLを実行することで、ジョブ情報を格納するためのテーブルを作成します。

また、WebOTXからDBに接続するため、以下のフォルダ配下にJDBCドライバを格納してください。

• JDK 8を使用する場合 ： [DOMAIN_HOME]/lib/ext
• JDK 11を使用する場合 ： [DOMAIN_HOME]/lib

10.2. バッチサービスが使用するリソースの設定

バッチサービスを利用するためには、以下の設定を行う必要があります。

• ジョブリポジトリとして使用するデータベース
  ジョブリポジトリとしてセットアップしたデータベースについてのデータソースのJNDI名を指定します。 なお、指定するデータソースの設定は、データベースに応じて以下を満たす必要があります。
  • Oracle Databaseの場合
    「データソースの種別」属性に「OracleのJDBC Optional Package API」が設定されている。
  • PostgreSQLの場合
    「データソースの種別」属性に「JDBC API」が設定されており、 「JDBC URLまたはデータベース名、データソース名」属性で指定するJDBC URLに、 キー名 currentSchema のパラメータでスキーマ名が指定されている。(例) jdbc:postgresql://localhost:5432/postgres?currentSchema=postgres
• ExecutorService
  バッチサービスがジョブを実行するためのスレッドを供給するExecutorServiceのJNDI名を指定します。

以降でそれぞれの設定手順を説明します。

10.2.1. 運用管理コマンド(otxadmin)での手順

10.2.1.1. ジョブリポジトリとして使用するデータベース

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、データソースを作成します。すでに作成済みのデータソースを利用する場合は、コマンドを実行せずに手順3に進みます。

Oracle Databaseの場合

otxadmin> create-jdbc-datasource --dataSourceType JDBCEX_Oracle --useJTA=true --jdbcUserName <jdbc_user_name> --jdbcPassword <jdbc_password> --dataSourceName <jdbc_url> jdbc/sampleDB

PostgreSQLの場合

<jdbc_url>には、キー名 currentSchema のパラメータでスキーマ名を指定します

otxadmin> create-jdbc-datasource --dataSourceType JDBC --useJTA=true --jdbcUserName <jdbc_user_name> --jdbcPassword <jdbc_password> --dataSourceName <jdbc_url> jdbc/sampleDB

3.  次のコマンドを実行して、ジョブリポジトリとして使用するデータソースを指定します。

otxadmin> set-batch-runtime-configuration --dataSourceLookupName jdbc/sampleDB

4.  次のコマンドを実行して、ドメインを再起動します。

> otxadmin stop-domain <ドメイン名>
> otxadmin start-domain <ドメイン名>

10.2.1.2. ExecutorService

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ExecutorServiceの作成と設定変更を行います。すでに作成済みのExecutorServiceを利用する場合は、コマンドを実行せずに手順3に進みます。

otxadmin> create-managed-executor-service concurrent/sampleExecutor
otxadmin> set server.resources.managed-executor-service.concurrent/sampleExecutor.long-running-tasks=true

3.  次のコマンドを実行して、使用するExecutorServiceを指定します。

otxadmin> set-batch-runtime-configuration --executorServiceLookupName concurrent/sampleExecutor

4.  次のコマンドを実行して、ドメインを再起動します。

> otxadmin stop-domain <ドメイン名>
> otxadmin start-domain <ドメイン名>

10.2.2. 統合運用管理ツールでの手順

以下で手順を説明します。

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「リソース」-「JDBCデータソース」を選択します。

3.  右クリックメニューから「JDBCデータソースの登録」を選択します。

4.  「一般」タブの「JNDIサーバへの登録名」に「jdbc/sampleDB」を入力します。

5.  利用するデータベースにより、「一般」タブで以下を設定します。

6.  ツリービューより「<ドメイン名>」-「リソース」-「Concurrency Resources」-「ManagedExecutorService」を選択します。

7.  右クリックメニューから「ManagedExecutorServiceの登録」を選択します。

8.  「ManagedExecutorServiceの登録」画面で、「JNDI名」に「concurrent/sampleExecutor」を入力し、「実行」をクリックします。

9.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

10.  画面の右側の「データソースのJNDI名」に「jdbc/sampleDB」を、「ExecutorServiceのJNDI名」に「concurrent/sampleExecutor」を入力し、「更新」ボタンをクリックします。

11.  設定反映のためドメインを再起動します。

図10.2.2-1

10.2.3. 運用管理コンソールでの手順

以下で手順を説明します。

1.  運用管理コンソールよりよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「リソース」-「JDBCデータソース」を選択します。

3.  右側の操作リストから「JDBCデータソースの登録」を選択します。

4.  「JDBCデータソースの登録」画面で、[ 統合運用管理ツールでの手順 ] と同様の設定を入力し、「実行」をクリックします。

5.  ツリービューより「<ドメイン名>」-「リソース」-「Concurrency Resources」-「ManagedExecutorService」を選択します。

6.  右側の操作リストから「ManagedExecutorServiceの登録」を選択します。

7.  「ManagedExecutorServiceの登録」画面で、[ 統合運用管理ツールでの手順 ] と同様の設定を入力し、「実行」をクリックします。

8.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

9.  画面の右側の「データソースのJNDI名」に「jdbc/sampleDB」を、「ExecutorServiceのJNDI名」に「concurrent/sampleExecutor」を入力し、「更新」ボタンをクリックします。

10.  設定反映のためドメインを再起動します。

10.3. バッチアプリケーションの配備・配備解除

10.3.1. 配備

バッチジョブを含むアプリケーションを配備すると、配備するバッチジョブに対応するバッチジョブノードが生成されます。なお、WebOTXのバッチサービスとしてサポートするアプリケーション種別は以下となります。

• Webアプリケーション(warファイル)
• Java EEアプリケーション(earファイル)内のWebアプリケーション

図10.2.3-1

生成されたバッチジョブノードの操作としてジョブを実行することができます。バッチジョブノードの属性と操作についての詳細は [ リファレンス > MBean定義 > バッチジョブノード ] を参照してください。

アプリケーション配備の詳細については [ 配備 > アプリケーション配備 > 4. 配備・再配備・置換 > 4.4. 配備・再配備 ] を参照してください。

10.3.2. 配備解除

バッチジョブを含むアプリケーションを配備解除すると、配備解除するバッチジョブに対応するバッチジョブノードが削除されます。 また、バッチサービスノードの「バッチアプリケーション配備解除時におけるジョブ実行履歴自動削除の有効化」属性を有効化している場合、 配備解除したジョブの実行履歴が削除されます。

アプリケーション配備解除の詳細については [ 配備 > アプリケーション配備 > 5. 配備解除 ] を参照してください。

10.4. ジョブの実行制御

バッチサービスでは、下記の種別のアプリケーションに含まれるバッチジョブについて、ジョブの起動、停止、再起動の操作が可能です。

• Webアプリケーション(warファイル)
• Java EEアプリケーション(earファイル)内のWebアプリケーション

実行制御が可能な条件について

ジョブの実行・停止・再実行は、以下の条件で実行できます。

• ジョブ実行
  
  • ジョブが配備されている
• ジョブ停止
  
  • ジョブが配備されている
  • 停止対象のジョブ実行のバッチステータスがSTARTEDである。
• ジョブ再実行
  
  • ジョブが配備されている
  • 再実行対象のジョブ実行がジョブインスタンスに対して最新である。
  • 停止対象のジョブ実行のバッチステータスがSTOPPEDあるいはFAILEDである。

実行制御のために送信するHTTPリクエストの送信先について

バッチサービスはジョブ制御操作を受けると、内部的に、バッチジョブが含まれるWebアプリケーションへのHTTPリクエストを送信します。 このHTTPリクエストの送信先として、ポート番号を指定することができます。以下の属性で設定が可能です。

• バッチサービスノードの [ジョブ操作HTTPリクエスト送信ポート] 属性
• バッチジョブノードの [ジョブ操作HTTPリクエスト送信ポート] 属性

以下の表で、各属性の設定状況の組み合わせと、リクエスト送信先ポートとして採用される値について説明します。
なお、リクエスト送信先ポートとしては、バッチジョブが含まれるWebアプリケーションが リクエストを受信できるポート番号を設定する必要があることに注意してください。

(※1)設定によってはポート番号が取得できずジョブ実行制御に失敗する場合があります。 その場合はバッチサービスノードあるいはバッチジョブノードの [ ジョブ操作HTTPリクエスト送信ポート ] 属性への設定を行ってください。

以降で、コマンド、統合運用管理ツール/運用管理コンソール、プログラム、それぞれのジョブ実行制御の手順を説明します。

10.4.1. 運用管理コマンド(otxadmin)での実行制御

ジョブの実行制御を行うためのコマンドを提供しています。各コマンドの詳細についてはコマンドリファレンスを参照してください。

以下で、それぞれのコマンドを使用したジョブ実行制御について説明します。

10.4.1.1. ジョブの実行

実行するジョブはオペランドで指定します。ジョブ名として、実行対象ジョブのジョブ定義XMLファイル名(拡張子は除く)を指定します。 他にジョブ名が重複するジョブが配備されている場合は、 --modulename オプションでモジュール名を指定することでジョブを特定します。 また、ジョブ実行時にジョブパラメータを渡す場合は --jobparameters オプションでプロパティファイルを指定します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを実行します。

otxadmin> start-batch-job [ --modulename <モジュール名> ] [ --jobparameters <プロパティファイルの絶対パス> ] <ジョブ名>

10.4.1.2. ジョブの停止

停止するジョブ実行についてのジョブ実行IDをオペランドで指定します。ジョブ実行IDは list-batch-job-executions コマンド、 あるいは統合運用管理ツール / 運用管理コンソールのジョブ実行履歴から取得します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを停止します。

otxadmin> stop-batch-job <ジョブ実行ID>

10.4.1.3. ジョブの再実行

再実行するジョブ実行についてのジョブ実行IDをオペランドで指定します。ジョブ実行IDは list-batch-job-executions コマンド、 あるいは統合運用管理ツール / 運用管理コンソールのジョブ実行履歴から取得します。 また、ジョブ再実行時にジョブパラメータを渡す場合は --jobparameters オプションでプロパティファイルを指定します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを再実行します。

otxadmin> restart-batch-job [ --jobparameters <プロパティファイルの絶対パス> ] <ジョブ実行ID>

10.4.2. 統合運用管理ツール/運用管理コンソールからの実行制御

10.4.2.1. ジョブの実行

統合運用管理ツールからの操作

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」-「バッチジョブ」-「<ジョブ名>」を選択します。

3.  右クリックメニューより「ジョブ起動」を選択します。

4.  必要に応じてパラメータファイルの絶対パスを指定し、「実行」ボタンをクリックします。

図10.4.2-1

運用管理コンソールからの操作

1.  運用管理コンソールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」-「バッチジョブ」-「<ジョブ名>」を選択します。

3.  右画面の「操作」タブから「ジョブ起動」を選択します。

4.  必要に応じてパラメータファイルの絶対パスを指定し、「実行」ボタンをクリックします。

図10.4.2-2

10.4.2.2. ジョブの停止・再実行

統合運用管理ツールからの操作

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右クリックメニューより「ジョブ実行履歴」を選択し、「ジョブ実行履歴」画面を表示します。

4.  対象ジョブの「停止」ボタンまたは「再実行」ボタンをクリックします。

図10.4.2-3

運用管理コンソールからの操作

1.  運用管理コンソールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右画面で「ジョブ実行履歴」タブを表示します。

4.  対象ジョブの「停止」ボタンまたは「再実行」ボタンをクリックします。

図10.4.2-4

10.4.3. プログラムからの実行制御

JSR-352ではジョブを操作するためのAPIを提供しています。Javaのプログラムから javax.batch.operations.JobOperator クラスの startメソッド、stopメソッド、restartメソッドを呼び出すことで、ジョブの実行、停止、再実行が可能です。

10.4.3.1. ジョブの実行

以下のように、javax.batch.operations.JobOperatorクラスのstartメソッドを使用して、ジョブを実行します。
startメソッドの戻り値はJobExecutionIDという、ジョブ実行を一意にあらわすlong値です。 ジョブの停止や再起動は、このJobExecutionIDを指定して行います。

JobOperator operator = BatchRuntime.getJobOperator();

// ジョブパラメータの指定は省略してジョブを実行
long executionId = operator.start("sample-job", null);

10.4.3.2. ジョブの停止

以下のように、javax.batch.operations.JobOperatorクラスのstopメソッドを使用して、ジョブを停止します。
停止するジョブの指定は、startメソッドの戻り値で取得したJobExecutionIDで行います。

JobOperator operator = BatchRuntime.getJobOperator();

long executionId = operator.start("sample-job", null);
// 実行中のジョブを停止
operator.stop(executionId);
		

10.4.3.3. ジョブの再実行

以下のように、javax.batch.operations.JobOperatorクラスのrestartメソッドを使用して、ジョブを再実行します。
再実行するジョブの指定は、startメソッドの戻り値で取得したJobExecutionIDで行います。

JobOperator operator = BatchRuntime.getJobOperator();

long executionId = operator.start("sample-job", null);
operator.stop(executionId);

// 停止したジョブを再実行
operator.restart(executionId, null);
		

10.4.3.4. ジョブに親子関係を持たせる場合

WebOTXのバッチサービスで独自に提供しているAPIを使用してジョブを実行・再実行することで 2つのジョブ間に親子関係を持たせることができます。com.ibm.jbatch.container.jar に含まれる com.ibm.jbatch.container.api.impl.JobOperatorImpl クラスの以下のメソッドを使用します。

• start(String, Properties, long) メソッド
• restart(String, Properties, long) メソッド

上記メソッドのlong型の第3引数に、自ジョブのジョブ実行IDを渡して呼び出すことで、 呼び出したジョブを親ジョブ、メソッド呼び出しによって実行されたジョブを子ジョブとしてジョブが実行・再実行されます。 この時、ジョブリポジトリの子ジョブ側のジョブ実行履歴に親ジョブのジョブ実行IDが記録されます。
下記に、Batchletから子ジョブとしてジョブを実行する例を記載しています。まずJobContext経由で自ジョブの ジョブ実行IDを取得し、そのジョブ実行IDを引数に渡してstartメソッドを実行しています。

public class SimpleBatchlet implements Batchlet{
  @Inject
  JobContext context;

  public String process() throws Exception {
  // 自ジョブ(親側)のジョブ実行IDの取得
  String myJobExecutionId = String.valueOf(context.getExecutionId());

  //ジョブを子ジョブとして実行
  JobOperatorImpl jobOperator = nwe JobOperatorImpl();
  jobOperator.start("child-job", jobParameter, myJobExecutionId);
  }
}

10.5. ジョブ実行履歴の参照

ジョブ実行履歴画面・ステップ実行履歴画面の参照および検索手順について説明します。

10.5.1. ジョブ実行履歴画面

10.5.1.1. 統合運用管理ツールからの操作

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右クリックメニューより「ジョブ実行履歴」を選択し、「ジョブ実行履歴」画面を表示します。

4.  「ジョブ実行履歴」を参照する場合は「ジョブ」タブを、「ステップ実行履歴」を参照する場合は「ステップ」タブを選択します。

5.  「ジョブ」タブでジョブを検索する場合は、次の検索項目に値を設定し、「検索」ボタンをクリックします。

図10.5.1-1

6.  「ステップ」タブでステップを検索する場合は、次の検索項目に値を設定し、「検索」ボタンをクリックします。

図10.5.1-2

10.5.1.2. 運用管理コンソールからの操作

1.  運用管理コンソールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右画面で「ジョブ実行履歴」タブを表示します。

4.  「ジョブ実行履歴」を参照する場合は「ジョブ実行履歴リスト」で「ジョブ」を、「ステップ実行履歴」を参照する場合は「ステップ」を選択します。

5.  「ジョブ実行履歴リスト」の「ジョブ」でジョブを検索する場合は、次の検索項目に値を設定し、「検索」ボタンをクリックします。

図10.5.1-2

6.  「ジョブ実行履歴リスト」の「ステップ」でステップを検索する場合は、次の検索項目に値を設定し、「検索」ボタンをクリックします。

10.5.2. ジョブフロー画面

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右クリックメニューより「ジョブ実行履歴」を選択し、「ジョブ実行履歴」画面を表示し。「ジョブ」タブを選択します。

4.  ジョブの「詳細」ボタンをクリックすると、ジョブフロー画面が表示されます。

図10.5.1-3

10.5.3. 運用管理コマンド(otxadmin)

ジョブ実行履歴を参照するためのコマンドを提供しています。各コマンドの詳細についてはコマンドリファレンスを参照してください。

10.5.3.1. list-batch-jobs

オペランドで指定したジョブIDに関する情報を表示します。ジョブIDはジョブ定義XMLファイルのjob要素のid属性に指定された値です。 なお、オペランドを指定しなければすべてのジョブに関する情報を表示します。 また、表示内容をファイル出力する場合は --outputfile オプションで出力ファイルを指定します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを実行します。

otxadmin> list-batch-jobs [ --outputfile <結果を出力するファイルの絶対パス> ] [<ジョブID>]

以下のような結果が出力されます。

JOBNAME                    INSTANCECOUNT
job1                       1
job2                       10

10.5.3.2. list-batch-job-executions

オペランドで指定したジョブインスタンスID、オプションで指定したジョブ実行IDに関するジョブ実行履歴を表示します。 表示内容をファイル出力する場合は --outputfile オプションで出力ファイルを指定します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを実行します。

otxadmin> list-batch-job-executions [ --executionid <ジョブ実行ID> ] [ --outputfile <結果を出力するファイルの絶対パス> ] [<ジョブインスタンスID>]

以下のような結果が出力されます。

JOBNAME                    EXECUTIONID  STARTTIME                     ENDTIME                       BATCHSTATUS  EXITSTATUS
job1                       2            Mon Jan 21 12:49:15 JST 2019  Mon Jan 21 12:49:15 JST 2019  COMPLETED    COMPLETED
job1                       1            Mon Jan 21 12:47:17 JST 2019  Mon Jan 21 12:47:19 JST 2019  COMPLETED    COMPLETED

10.5.3.3. list-batch-job-steps

オペランドで指定したジョブ実行IDに関するステップ実行履歴を表示します。 表示内容をファイル出力する場合は --outputfile オプションで出力ファイルを指定します。

1.  otxadmin コマンドを起動し、ドメインにログインします。

2.  次のコマンドを実行して、ジョブを実行します。

otxadmin> list-batch-job-steps [ --outputfile <結果を出力するファイルの絶対パス> ] <ジョブ実行ID>

以下のような結果が出力されます。

STEPNAME  STEPID  STARTTIME                     ENDTIME                       BATCHSTATUS  EXITSTATUS
step1     1       Thu Jan 24 17:33:28 JST 2019  Thu Jan 24 17:33:42 JST 2019  COMPLETED    COMPLETED

10.6. ジョブリポジトリ管理

ジョブリポジトリ管理機能として、ジョブリポジトリに保管されているジョブ実行履歴の削除機能と、 ジョブリポジトリのメンテナンス機能を提供しています。

10.6.1. ジョブ実行履歴の削除

ジョブ実行履歴の削除は、統合運用管理ツールによる手動削除と、指定した保存期間を過ぎた履歴を自動で削除する機能を利用できます。

10.6.1.1. 保存期間を過ぎたジョブ実行履歴の自動削除

バッチサービスノードの [保存期間を過ぎたジョブ実行履歴の自動削除の有効化] 属性が有効化されている場合、毎日0:00頃に [ジョブ実行履歴の保存期間] に設定された日数より古いジョブ実行履歴を自動的に削除します。自動削除はデフォルトでは無効化されています。

10.6.1.2. 統合運用管理ツールからの手動削除

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右クリックメニューより「ジョブ実行履歴」を選択し、「ジョブ実行履歴」画面を表示します。

4.  ジョブ実行履歴を削除する場合は、「ジョブ」タブを選択します。

5.  「選択」列で削除するジョブをチェックし、「チェックしたレコード」ボタンをクリックすると、チェックしたジョブを実行履歴から削除します。検索項目に検索する値を設定し、「条件に一致する全レコード」ボタンをクリックすると、検索項目に一致するジョブを実行履歴およびジョブリポジトリから削除します。

図10.6.1-1

10.6.2. ジョブリポジトリのメンテナンス

ジョブ実行中のデータベースダウンなどでバッチステータスとジョブの実行結果の矛盾を解決したい場合に、 本機能を利用してジョブリポジトリのメンテナンスを行うことができます。

10.6.2.1. 統合運用管理ツールからの操作

1.  統合運用管理ツールよりドメインと接続します。

2.  ツリービューより「<ドメイン名>」-「アプリケーションサーバ」-「バッチサービス」を選択します。

3.  右クリックメニューより「ジョブ実行履歴」を選択し、「ジョブ実行履歴」画面を表示します。

4.  「ジョブ」タブまたは「ステップ」タブを選択します。

5.  「ステータス強制変更」の「強制変更モードへ移行」ボタンをクリックしますと、「バッチステータス」および「終了ステータス」を変更することができます。

6.  「バッチステータス」および「終了ステータス」のステータスをクリックし、ステータスを変更して、「更新」ボタンをクリックしてください。

図10.5.1-2