ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker

3.14.4 スケジュール定義を登録

機能説明

自動運用プロセスを起動するスケジュール定義を登録します。本部品で登録したスケジュール定義は、スケジュール定義画面より確認・変更することができます。また、プロセス状況画面から、実行状況の予実管理が可能です。本部品を使用して登録したスケジュール定義の所有者は、プロセスインスタンスの起動ユーザーになります。

オプション

基本オプション

(1) process_definition

起動する自動運用プロセス名です。64文字以内で指定してください。同一プロセスグループ内の自動運用プロセスのみ設定できます。

以下の場合は、エラーとなります。

  • 自動運用プロセス名を省略した場合

  • 指定した自動運用プロセスの起動権限がない場合

  • 存在しない自動運用プロセスを指定した場合

(2) schedule_definition_name

スケジュール定義名です。50バイト以内で指定します。

以下の文字、空白、半角カナ、およびユーザー定義文字を含むことはできません。また、1文字目に # は指定できません。

? \ * " < > | / : ; , ' .

以下の場合は、エラーとなります。

  • 指定したスケジュール定義名と同じスケジュール定義またはスケジュールパターンがプロセスグループ内にすでに存在する場合

  • 使用できない文字を設定した場合

  • 50バイトを超えるスケジュール定義名を設定した場合

(3) startup_day

起動日を指定します。yyyymmddの形式で指定してください。指定できる日付はプロセスインスタンス起動日から3年先までになります。

以下の場合はエラーとなります。

  • 起動日を省略した場合

  • 不正な形式で設定した場合

  • 不正な日付を設定した場合

(4) startup_time

起動する時刻です。hhmmの形式で指定してください。0000~2359 まで指定可能です。(3)で設定した日付の(4)の時刻に起動されます。不正な形式で指定した場合はエラーとなります。

拡張オプション

(1) param

自動運用プロセスの起動時にUDAに設定する値です。uda名=value形式で設定してください。複数設定を行う場合は、CSV形式で設定します。入力形式および注意事項については“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。

(2) memo

スケジュール定義の説明を指定します。128バイト以内で指定します。128バイトを超えた場合はエラーとなります。

(3) estimatedtime

実行予測時間です。1~9999(分)の間で設定します。省略した場合は15(分)が設定されます。1~9999以外の値を設定した場合はエラーとなります。

(4) timeout

運用操作部品の実行の完了待ち合わせ時間(秒)です。

300~86,400(1日)の範囲で指定が可能です。

(例) 完了待ち合わせを10分間行う場合:600

指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値:201で中断します。

(5) retry

運用操作部品の実行の起動リトライ回数です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行う回数を指定します。0~5の範囲で指定が可能です。

起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。

(例) 起動リトライを2回行う場合:2

(6) retry_interval

運用操作部品のリトライ間隔(秒)です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行うまでの間隔を指定します。1~14400の範囲で指定が可能です。

(例) 300秒間隔でリトライを行う場合:300


timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

スケジュール定義の登録に成功しました。

失敗

161

スケジュール定義の登録に失敗しました。リトライ回数を指定した場合、リトライします。

171

指定したプロセス定義を起動する権限がありません。

172

すでに同じ名前のスケジュール定義またはスケジュールパターンが存在します。

173

指定したプロセス定義は存在しないか、公開状態ではありません。

197

オプションの内容に誤りがありました。

200

スケジュール定義の登録に失敗しました。

201

運用操作部品の実行がタイムアウトしました。

202

運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。

203

運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。

205

運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。

206

運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。

207

運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。

208

運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。

出力情報

変数

意味

message

スケジュール定義の登録に成功した場合、以下のメッセージを設定します。

The operation component was successful.

スケジュール定義の登録に失敗した場合、エラー内容を文字列として設定します。

result

登録結果としてスケジュール定義ID、スケジュール定義名を設定します。

出力例:

schedule_definition_id:1 schedule_definition_name:schedule_def_name

scheduledef_id

登録したスケジュール定義IDを設定します。

scheduledef_name

登録したスケジュール定義名を設定します。

returnCode

復帰値を設定します。

注意事項