start-job

概要

ジョブを開始します。
ジョブを開始させるために必ずジョブ名(--jobname)を指定します。
バッチアプリケーション名(--batchap)が指定されない場合、既定値の default が暗黙的に指定されます。
バッチアプリケーショングループ名(--batchapgroup)が指定されない場合、既定値の default が暗黙的に指定されます。

ジョブ再実行(--restart指定)時には、アカウント名、ジョブ名、ジョブパラメータから、ジョブ再実行の際にやり直す必要がある前回のジョブ実行を特定します。
ジョブの実行を特定する為に使用するジョブパラメータには、--parametersfileオプションで指定したファイルに含まれる全てのプロパティ、コマンド引数のjobParameters、および、--reqidオプションの値が含まれます。
ジョブを再実行する(--restartを指定する)際は、ジョブ実行を開始した際と同一のジョブパラメータを指定してください。
ジョブの開始(start)時に--reqidオプションを指定している場合は、ジョブの再実行時にも--reqidを指定して再実行を行ってください。
また、ジョブ再実行時にはジョブを再開する方法(--type)を選択することができます。

パス

${BS_HOME}/bin

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

• Administrator
• JobExecutor

書式

start-job <接続オプション> <コマンドオプション>

接続オプション

WebOTX Batch Serverのコマンドは、バッチドメインエージェントを経由して各バッチコンテナへ指示を行います。
そのため、WebOTX Batch Serverが提供する主なコマンドはバッチドメインエージェントへの接続オプションの指定が必要です。

{--user <user> --password <password> [--host <host>] [--port <port> [--responseTimeout <responseTimeout>]
 [--responseRetry <responseRetry>]}

コマンドオプション

{--jobname <jobname> [--alerttime <alerttime>] [--priority <priority>] [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>] [--exitcodemapping <exitcodeMappingFile>] [--silent]
 [--parametersfile <parametersFile>] [jobParameters]
 [--serverResponseTimeoutRatio <serverResponseTimeoutRatio>] | --version | --help}

{--restart [--type {JOB | STEP | CHECKPOINT}]
 --jobname <jobname> [--alerttime <alerttime>] [--priority <priority>] [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>] [--exitcodemapping <exitcodeMappingFile>] [--silent]
 [--parametersfile <parametersFile>] [jobParameters]
 [--serverResponseTimeoutRatio <serverResponseTimeoutRatio>] | --version | --help}

restartオプションに関する補足

再実行処理では、コマンドで指定したパラメータ情報を基に前回実行したジョブの情報を取得し、前回の実行状態(Status)を確認し、正常な停止状態であると判断した場合のみ再実行処理を行います。ジョブの開始コマンドは、--restartオプションの有無により下記のような動作となります。

戻り値

下表の戻り値は、jobctlコマンドのstart , result、および、start-jobコマンド、result-jobコマンド特有の戻り値です。これらのコマンドの戻り値は、ExitStatus との対応関係によって決まります。これらの戻り値は、戻り値定義ファイル の設定により変更可能です。
戻り値 と ExitStatus との対応関係については、ExitCodeMapping機能 を参照してください。

コマンド共通の戻り値は、ExitCodeマッピング機能では変更できません。

実行例

[root@localhost bin]# ./start-job --user user --password pass --batchapgroup default1 --batchap default1 --jobname hello --reqid 15 jobParam1=value1 jobParam2=value2

 INFO - Command start processing (start-job)
 INFO - start job request.
 INFO - end job request.
 INFO - waiting to job is started.
 INFO - Job process is started. DomainName = batchDomain1, ContainerName = container1-1, JobInstanceId = 24, JobExecutionId = 24

 INFO - Start Job Execution Log :-

<ジョブ実行時のログが表示されます>

 INFO - Command is done. (start-job)
Exit Code = 0

関連

• コマンドリファレンス
  • stop-job
    
  • result-job
    
  • status-job
    
  • jobctl start
    
• 運用・利用ガイド
  • バッチアプリケーションの運用・利用ガイド
    • ジョブの実行
      • ジョブを実行する
      • ジョブを再実行する
      • ジョブ終了時のコマンド戻り値を設定する
• 機能ガイド
  • ジョブ実行制御
    • ジョブの開始
  • ExitCodeMapping機能
• 定義ファイルリファレンス
  • DOMAIN_HOME/config/batch/exitcode/
    • mapping.properties