ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Identity Manager開発者ガイド
11g リリース1(11.1.1)
B66705-01
  目次へ移動
目次		 索引へ移動
索引
前
前 		 次
次		  

A スケジュール済タスクの構成ファイル

この付録では、スケジューラ・タスクの定義を含むXMLファイルの構造および構成要素について説明します。

A.1 スケジューラXMLファイルの構造

次に、構成XMLファイル内の要素のリストを示します。

<scheduledTasks xmlns="http://xmlns.oracle.com/oim/scheduler">
    <task>
        <name>
        <class>
        <description>
        <retry>
        <parameters>
            <string-param>
            .....
            </string-param>
            
            <number-param>
            .......
            </number-param>
            
            <boolean-param>
            .......
            </boolean-param>
        </parameters>
    </task>
</scheduledTasks>

A.2 scheduledTasks要素

scheduledTasks要素は、スケジュール済タスクの定義に使用されるXMLのルート要素です。

表A-1に、scheduledTasks要素のプロパティの概要を示します。

表A-1 scheduledTasks要素のプロパティ

プロパティ 値

親要素

該当なし

属性

次のように、XML名前空間をscheduledTasks要素の属性として指定します。

<scheduledTasks xmlns="http://xmlns.oracle.com/oim/scheduler">

注意: xmlnsパラメータは必須です。

子要素

task

出現回数

作成するスケジュール済タスクXMLファイルごとに1つ

要素値

該当なし

必須かオプションか

必須

A.3 task要素

task要素は、scheduledTasks要素の子要素です。

task要素は、スケジュール済タスクを定義するために使用します。task要素には、スケジュール済タスクの名前、クラス、説明、再試行回数などの情報が含まれます。

表A-2に、task要素のプロパティの概要を示します。

表A-2 task要素のプロパティ

プロパティ 値

親要素

scheduledTasks

属性

なし

子要素

name、class、description、retryおよびparameters

出現回数

作成するタスクごとに1つ

注意: 単一のスケジュール済タスクXMLファイルに複数のタスクを定義する場合は、定義するスケジュール済タスクごとに1つのtask要素を使用する必要があります。

要素値

該当なし

必須かオプションか

必須

A.4 name要素

name要素は、task要素の子要素です。name要素は、作成するスケジュール済タスクの名前を指定するために使用します。

表A-3に、name要素のプロパティの概要を示します。

表A-3 name要素のプロパティ

プロパティ 値

親要素

task

属性

なし

子要素

なし

出現回数

1つ

要素値

作成するスケジュール済タスクの名前。

注意: スケジュール済タスクの名前は一意にする必要があります。

必須かオプションか

必須

A.5 class要素

class要素(必須)は、task要素の子要素です。class要素は、スケジュール済タスクを実行するJavaクラスの名前を指定するために使用します。

表A-4に、class要素のプロパティの概要を示します。

表A-4 class要素のプロパティ

プロパティ 値

親要素

task

属性

なし

子要素

なし

出現回数

1つ

要素値

スケジュール済タスクを実行するJavaクラスの名前。スケジュール済タスクのクラスを開発する方法の詳細は、第6.4項「スケジュール済タスクのクラスの開発」を参照してください。

必須かオプションか

必須

A.6 description要素

description要素(必須)は、task要素の子要素です。description要素は、作成するタスクの説明を追加するために使用します。

表A-5に、description要素のプロパティの概要を示します。

表A-5 description要素のプロパティ

プロパティ 値

親要素

task

属性

なし

子要素

なし

出現回数

1つ

要素値

作成するタスクの説明

必須かオプションか

必須

A.7 retry要素

表A-6に、retry要素のプロパティの概要を示します。

表A-6 retry要素のプロパティ

プロパティ 値

親要素

task

属性

なし

子要素

なし

出現回数

1つ

要素値

スケジューラによってタスクが再スケジュールされるまでの待機時間(秒数)

必須かオプションか

必須

A.8 parameters要素

スケジュール済タスクでジョブを正常に実行するために必要なパラメータを実行時に指定する場合は、parameters要素を使用する必要があります。たとえば、取得するレコードの数を実行時にユーザーに指定させるスケジュール済タスクを作成できます。

この要素の中で指定するパラメータは、「ジョブの作成」ページの「パラメータ」セクションに表示されます。

表A-7に、parameters要素のプロパティの概要を示します。

表A-7 parameters要素のプロパティ

プロパティ 値

親要素

task

属性

なし

子要素

string-param、number-param、boolean-param

出現回数

1つ

要素値

該当なし

必須かオプションか

オプション

A.9 string-param要素

string-param要素は、文字列データ型の値をとるフィールドの名前を指定するために使用します。言い換えると、string-param要素では、文字列データ型の値を保持できるフィールドのラベルを指定します。

表A-8に、string-param要素のプロパティの概要を示します。

表A-8 string-param要素のプロパティ

プロパティ 値

親要素

parameters

属性

required、helpText、encrypted

子要素

なし

出現回数

Stringデータ型のパラメータごとに1つ

要素値

文字列パラメータの名前

必須かオプションか

オプション

表A-8に示すように、string-param要素には次の属性が含まれています。

A.10 number-param要素

number-param要素は、longデータ型の値をとるフィールドの名前を指定するために使用します。

表A-9に、number-param要素のプロパティの概要を示します。

表A-9 number-param要素のプロパティ

プロパティ 値

親要素

parameters

属性

required、helpText

子要素

なし

出現回数

longデータ型のパラメータごとに1つ

要素値

longデータ型を保持できるフィールドの名前

必須かオプションか

オプション

require属性とhelpText属性の動作および説明は、number-param要素とstring-param要素で同じです。require属性とhelpText属性の詳細は、「string-param要素」を参照してください。

A.11 boolean-param要素

boolean-param要素は、ブール・データ型の値をとるフィールドの名前を指定するために使用します。

表A-10に、boolean-param要素のプロパティの概要を示します。

表A-10 boolean-param要素のプロパティ

プロパティ 値

親要素

parameters

属性

required、helpText

子要素

なし

出現回数

ブール・データ型のパラメータごとに1つ

要素値

ブール・データ型を保持できるフィールドの名前

必須かオプションか

オプション

required属性とhelpText属性の動作および説明は、boolean-param要素とstring-param要素で同じです。required属性とhelpText属性の詳細は、第A.9項「string-param要素」を参照してください。

  前
前 		 次
次
  目次へ移動
目次		 索引へ移動
索引