9 パラメータとシステム・プロパティの使用

この章では、Oracle Enterprise Schedulerメタデータおよびジョブ・リクエストで発行するランタイム・サービスで、パラメータと値を定義する方法について説明します。特定のパラメータが、Oracle Enterprise Schedulerシステム・プロパティの値またはアプリケーション定義のプロパティの値を表すことがあります。

この章の内容は次のとおりです。

9.1 パラメータとシステム・プロパティの使用の概要

Oracle Enterprise Schedulerシステム・プロパティは、Oracle Enterprise Schedulerによって予約された名前を持つパラメータです。一部のシステム・プロパティについては、ユーザーが値を指定しなかった場合の値が定義されているか、デフォルト値が提供されます。

Oracle Enterprise Schedulerパラメータは次のように定義できます。

  • ジョブ定義、ジョブ・タイプまたはジョブ・セットに関連付けられているメタデータで。

  • ジョブ・リクエストの発行時に、リクエスト・パラメータで。リクエスト・パラメータでは、メタデータで指定されているパラメータをオーバーライドしたり、ジョブ・リクエストに関連付けられているメタデータで事前に定義されていないパラメータの値を指定できます(一定の制約が適用されます)。また、ジョブ・リクエストが発行された後に、新しいパラメータを追加したり、パラメータ値を更新することもできます(一定の制約が適用されます)。

Oracle Enterprise Schedulerシステム・プロパティの詳細は、「システム・プロパティの使用」を参照してください。

9.1.1 アプリケーション定義のプロパティおよびシステム・プロパティのネーミングに関する必知事項

Oracle Enterprise Schedulerアプリケーション定義のプロパティおよびシステム・プロパティでは、大文字と小文字が区別されます。たとえば、アプリケーション定義のプロパティ名USER_PARAおよびuser_paraは、Oracle Enterprise Schedulerでは異なるパラメータを表します。

アプリケーション定義のプロパティを使用する場合、Oracle Enterprise Schedulerでは、Oracle Enterprise Scheduler定義のシステム・プロパティ用に、"SYS_"で始まる名前(大文字と小文字を区別しません)が予約されていることに注意してください。このため、"SYS_"で始まる名前(大文字と小文字を区別しません)を持つアプリケーション定義のプロパティは使用できません。

9.1.2 パラメータの競合解決方法およびパラメータのマテリアライズに関する必知事項

Oracle Enterprise Schedulerでは、ジョブ・リクエストを発行するときに、ジョブ・メタデータで指定されたパラメータとすべての発行パラメータを組み合せて、ランタイム・リクエスト・パラメータを作成します。ランタイム・パラメータはデータベース・ランタイム・ストアに保存され、リクエストの後続処理で使用されます。メタデータ・パラメータは、発行時におけるメタデータ・リポジトリでの定義に従い、ジョブ定義、ジョブ・タイプ、および該当する場合はジョブ・セットから取得されます。その後、リクエストが処理されるときに、メタデータに変更が加えられたり、使用されることは通常ありません。Oracle Enterprise Schedulerにより、ジョブ・メタデータまたは発行パラメータに関連付けられている名前と同じ名前を持つパラメータの競合が解決されます。

パラメータの競合は、次の場合に発生することがあります。

  • パラメータが異なる値で繰り返し定義される場合。たとえば、リクエストに関連付けられているジョブ・タイプとジョブ定義とで、SystemProperty.PRIORITYプロパティが異なる値で設定される場合です。

  • パラメータが繰り返し定義され、少なくとも1つの定義でParameterInfo readonlyフラグがtrueに設定されて読取り専用として指定されている場合。

パラメータの競合を解決するために、Oracle Enterprise Schedulerでは次のいずれかの競合解決モデルおよび表9-1に示されているパラメータ値継承階層を使用します。

  • 最後の定義優先: 同じパラメータが、すべてのケースでreadonlyフラグがfalseに設定されて繰り返し定義されている場合に使用されます。最後の定義優先モデルでは、最上位レベル(最後の定義)が優先されるという優先順位ルールに従って競合が解決されます。たとえば、ジョブ・リクエスト・レベルで指定されたプロパティは、ジョブ定義レベルで指定された同じプロパティより優先されます。

  • 最初の読取り専用定義優先: 同じパラメータが繰り返し定義され、少なくとも1つの定義が読取り専用である(ParameterInfo readonlyフラグがtrueに設定されている)場合に使用されます。最初の読取り専用定義優先モデルでは、表9-1に示されている優先順位ルールに従ってパラメータの競合が解決され、最下位レベルが優先されます。たとえば、ジョブ・タイプ定義レベルで指定された読取り専用パラメータは、ジョブ定義レベルで指定された同じプロパティよりも、それが読取り専用かどうかに関係なく優先されます。

表9-1 パラメータの優先順位レベル

オブジェクト レベル

JobType

1 - 最下位レベル

JobDefinition

2

Job set step

3

job set

4

ジョブ・リクエスト(submitRequest()に渡されるRequestParametersを使用)

5 - 最上位レベル

9.1.2.1 ジョブ定義パラメータのマテリアライズに関する必知事項

図9-1に、様々なコンポーネントで定義されるパラメータによって採用される、優先順位の順序を示します。

図9-1 パラメータの優先順位

パラメータの優先順位

ジョブ・リクエストの場合は、ジョブ・タイプによって定義されるパラメータの優先順位が最も高く、その次がジョブ定義で定義されるパラメータとなります。ジョブ・リクエストとともに発行されるパラメータが最も低い優先順位を取ります。ジョブ・セット・リクエストの場合は、ジョブ・セットによって定義されるパラメータの優先順位が最も高く、その次がジョブ・セットの子として実行されるジョブ・リクエストによって定義されるパラメータとなります。

9.1.2.2 ジョブ・セット・レベル・パラメータのマテリアライズに関する必知事項

ジョブ・セット・ステップ・パラメータがマテリアライズされるとき、ジョブ・セットで次のいずれかのシステム・プロパティが読取り専用として定義されており、かつ、それらのプロパティが最上位のジョブ・セット、つまり絶対親のジョブ・セットの定義内で定義されている場合は、ジョブ・セット・ステップ・レベルで設定された値が、ジョブ・セット値によってオーバーライドされます。これにより、特定のジョブ・セットのコンテキスト内で実行されるすべての定義、ジョブ定義またはジョブ・セット定義が、同じ値を使用して実行されるようになります。

PRIORITY

REQUEST_EXPIRATION

RETRIES。ステップ定義値が0より大きい場合のみ。

0の値はジョブを再起動できないことを意味する場合があるため、RETRIESには例外があります。つまり、ステップがRETRIES = 0と定義されている場合、これはオーバーライドされず、ステップがRETRIES > 0と定義される場合には、ジョブ・セット値によってオーバーライドされます。

ジョブ・セット・ステップ・リクエストのプロパティのマテリアライズは、ジョブ・セットの処理中に、そのステップに到達したときに実行されます。ジョブ・ステップ・リクエストのプロパティは、次の順序でマテリアライズされます。

  1. ジョブ・タイプおよびジョブ定義(ステップがジョブ定義の場合)またはジョブ・セット(ステップがジョブ・セットの場合)

  2. ジョブ・セット・ステップ。

  3. 親リクエスト・プロパティおよびシステム・プロパティ(親はステップの親ジョブ・セット)

  4. 有効範囲のあるリクエスト・プロパティ。

例9-2に、ジョブ・セット・ステップのパラメータの優先順位を示します。

図9-2 ジョブ・セット・ステップのパラメータの優先順位

ジョブ・セット・ステップのパラメータの優先順位

ジョブ・セットにジョブ・セットであるステップが含まれる場合、これはネストされたジョブ・セットです。ネストされたジョブ・セットには、表9-1に示されている優先順位が適用されます。ネストされたジョブ・セットに到達すると、Oracle Enterprise Schedulerにより親リクエストのパラメータが適用され、親リクエストのパラメータは同じ優先順位に従います。これにより、親リクエスト、ジョブ・セットおよびジョブ・セット・ステップのパラメータが、ネストされたジョブ・セットによって継承されます。

9.2 メタデータ・サービスでのパラメータの使用

Oracle Enterprise Schedulerメタデータには、メタデータ・オブジェクトに関連付けることができるパラメータが含まれます。パラメータには、アプリケーション定義のプロパティと特定の定義(メタデータ・オブジェクト)のシステム・プロパティの両方を含めることができます。

ParameterListクラスのインスタンスによって、特定のジョブ定義、ジョブ・タイプまたはジョブ・セットのパラメータが宣言されます。特定のジョブ定義、ジョブ・タイプまたはジョブ・セット定義のパラメータを設定するには、ParameterListオブジェクトをメタデータ・オブジェクトのsetParameters()メソッドとともに使用するか、コンストラクタを使用してParameterListを提供します。パラメータ・リストにパラメータ情報を提供するために、各ParameterListオブジェクトには、パラメータを表すParameterInfoオブジェクトが含まれています。各パラメータは、表9-2に示されているプロパティを使用して定義されます。

表9-2 ParameterInfoパラメータ・プロパティ

パラメータ・プロパティ 説明

名前

パラメータ名を指定します。

パラメータ値を指定します。

Readonly

このブール・フラグは各パラメータに設定できます。このフラグは、パラメータが読取り専用であるかどうかを示します。

trueの場合、パラメータの優先順位階層内にある後続オブジェクト(リクエスト発行パラメータなど)で、パラメータ値を変更できません。通常、読取り専用パラメータには、後続オブジェクトで変更できないデフォルト値が設定されます。

読取り専用パラメータの値は、このパラメータが定義されているオブジェクト自体では変更できます。たとえば、このパラメータがジョブ・タイプ内で読取り専用パラメータとして定義されている場合、その値はジョブ・タイプ定義自体では変更できますが、そのジョブ・タイプを使用するジョブ定義やリクエスト発行パラメータで値をオーバーライドすることはできず、パラメータ値に指定された競合解決ルールが適用されます。詳細は、「パラメータの競合解決方法およびパラメータのマテリアライズに関する必知事項」を参照してください。

Legacy

GUIで使用される場合にパラメータを表示するかどうかを指定するブール値。

DataType

値には、サポートされているいずれかの型(Boolean、Integer、Long、Stringおよび日付をjava.util.Calendarオブジェクトとして表すDATETIME)のみを指定できます。

ジョブ・リクエストのパラメータの優先順位に適した異なるレベルでパラメータを設定できます。たとえば、ジョブ・タイプ、ジョブ定義、ジョブ・セット、ジョブ・セット・ステップまたはリクエスト発行パラメータに適用されるパラメータを設定できます。優先順位ルールの詳細は、「パラメータの競合解決方法およびパラメータのマテリアライズに関する必知事項」を参照してください。

9.2.1 メタデータ・オブジェクトでのパラメータとシステム・プロパティの使用方法

例9-1に、ParameterListを使用して、メタデータ・オブジェクトでパラメータとシステム・プロパティの値を設定するコードを示します。

例9-1には、メタデータ・オブジェクトでパラメータを使用するための次の重要なステップが示されています。

  • パラメータを追加するメタデータ・オブジェクトを作成するには、メタデータ・サービス・ハンドルへの参照が必要です。

  • パラメータ情報を追加するには、ParameterList add()メソッドを使用する必要があります。

  • SystemPropertyをパラメータの名前として使用して、システム・プロパティの値を指定できます。

  • ParameterListのパラメータ情報で定義した名前を使用して、アプリケーション定義のプロパティを指定できます。

  • ParameterListで指定されたパラメータをメタデータ・オブジェクトに適用するには、メタデータ・オブジェクトのsetParameters()メソッドを使用する必要があります。この場合、ジョブ定義のsetParameters()メソッドを使用します。

例9-1 メタデータ・オブジェクトでのパラメータおよびシステム・プロパティの追加

String name = "JobDescription_name";
MetadataObjectId jobtype;
.
.
.
JobDefinition jd = new JobDefinition(name, jobtype);
ParameterList parlist = new ParameterList();
parlist.add(SystemProperty.APPLICATION, "METADATA_UNITTEST_APP", false);
parlist.add(SystemProperty.PRODUCT, "METADATA_UNITTEST_PROD", false);
parlist.add(SystemProperty.CLASS_NAME, "oracle.as.scheduler.myself", false);
parlist.add(SystemProperty.RETRIES, "2", false);
parlist.add(SystemProperty.REQUEST_EXPIRATION, "60", false);
parlist.add("MyProp", "Value", false);
parlist.add("MyReadOnlyProp", "readyOnlyValue", true);
jd.setParameters(parlist);

9.3 ランタイム・サービスでのパラメータの使用

RequestParametersオブジェクトをsubmitRequest()とともに指定して、ジョブ・リクエストを発行するときのパラメータを指定できます。リクエスト・パラメータでは、メタデータで指定されているパラメータをオーバーライドしたり、ジョブ・リクエストに関連付けられているメタデータで事前に定義されていないパラメータの値を指定できます(一定の制約が適用されます)。

ランタイム・サービスのsetRequestParameter()メソッドを使用して、リクエストが発行された後にリクエスト・パラメータを設定または変更することもできます(一定の制約が適用されます)。

submitRequest()メソッドでは、メタデータ内にリクエスト・パラメータの定義が存在する場合に、各リクエスト・パラメータをその定義に対して検証します。このような検証には、メタデータで指定されたデータ型に対するパラメータのデータ型の検証、パラメータの読取り専用制約の検証などがあります。指定されたリクエスト・パラメータが対応するメタデータ内に存在しない場合、そのパラメータのデータ型は、パラメータ値にinstanceofを適用することによって決定されます。リクエスト・パラメータ値のデータ型は、ParameterInfo.DataTypeで指定されている、サポートされているいずれかの型である必要があります。

リクエスト・パラメータの値がNULLであり、メタデータ内でプロパティが割り当てられていない場合は、submitRequest()のコール時にデフォルトでSTRINGデータ型に設定されます。Oracle Enterprise Schedulerにより、パラメータにnull値が割り当てられます。そのため、メタデータ内でパラメータを割り当てる必要はありません。

RuntimeService setRequestParameter()メソッドは、事前に定義されていないリクエスト・パラメータをジョブにより実行中に設定できるようにします。

9.3.1 ランタイム・サービスでのパラメータの使用方法

ジョブ・リクエストを発行するとき、RequestParametersオブジェクトでパラメータを設定します。このパラメータは、Oracle Enterprise Schedulerシステム・プロパティまたはアプリケーション定義のプロパティを表すことがあります。RequestParametersパラメータ値を使用して、メタデータで指定されているパラメータをオーバーライドするか、ジョブ・リクエストに関連付けられているメタデータで事前に定義されていないパラメータの値を指定できます。

例9-2に、RequestParametersオブジェクトをadd()メソッドとともに使用して、システム・プロパティ値を設定するコードを示します。

この例では、rs_handleという名前でユーザーが作成したruntimeServiceHandleがあることを前提としています。

例9-2 PRIORITYシステム・プロパティとリクエスト・パラメータの使用

import oracle.as.scheduler.RequestParameters;
import oracle.as.scheduler.MetadataObjectId;
import oracle.as.scheduler.RuntimeService;
import oracle.as.scheduler.RuntimeServiceHandle;
import oracle.as.scheduler.SystemProperty;

RuntimeService runtime;
RuntimeServiceHandle rs_handle;
MetadataObjectId jobSetId;
int startsIn;
long requestID = 0L;
 
RequestParameters req_par = new RequestParameters();
 
req_par.add(SystemProperty.PRIORITY, new Integer(7));
 
Calendar start = Calendar.getInstance();
start.add(Calendar.SECOND, startsIn);
 
requestID =
     runtime.submitRequest(rs_handle,"My job set", jobSetId, start, req_par);
.
.
.

9.3.2 ジョブ・セット・ステップのステップIDを含むパラメータの使用方法

RequestParametersオブジェクトは、リクエストのすべてのパラメータのコンテナです。一部のRequestParametersメソッドでは、引数としてステップIDを使用します。このようなメソッドを使用すると、リクエストを発行するときにジョブ・セットのパラメータを指定でき、パラメータは、ジョブ・セット・リクエストに関連付けられている個別のステップに指定またはスコープできます。このようなメソッドでは、ステップID引数によって、特定のパラメータが適用される、ジョブ・セット内のステップが識別されます。ジョブ・セット以外のリクエストでは、ステップIDは適用されませんが、アプリケーションの要件に応じてパラメータを使用できます。

add()などのRequestParametersメソッド内でステップIDを指定する場合は、次の形式でステップIDを指定する必要があります。

id1.id2.id3...

ここでは、完全修飾ステップIDによって、ジョブ・セット階層(ツリー)内の一意のステップ(ノード)が示されます。

ジョブ・セット・リクエスト内のステップIDを持たないパラメータはグローバル・パラメータとして処理され、ジョブ・セット・リクエストのそれぞれのステップに適用されます。RequestParametersのステップID引数により、共有パラメータがサポートされます。このパラメータは、ジョブ・セットと、ジョブ定義またはジョブ・タイプのいずれかの両方に適用できます。

Oracle Enterprise Schedulerにより、セパレータとしてコロンが使用されたstepId:nameという形式でステップIDが名前の前に付加され、一意の識別子が生成されます。

例9-3に、RequestParametersオブジェクトをadd()メソッドで指定されるステップIDとともに使用して、ジョブ・セット内のステップにシステム・プロパティ値を設定するコードを示します。

この例では、rs_handleという名前でユーザーが作成したruntimeServiceHandleがあることを前提としています。

例9-3 CLASS_NAMEシステム・プロパティとジョブ・セット・リクエスト・パラメータの使用

import oracle.as.scheduler.RequestParameters;
import oracle.as.scheduler.MetadataObjectId;
import oracle.as.scheduler.RuntimeService;
import oracle.as.scheduler.RuntimeServiceHandle;
import oracle.as.scheduler.SystemProperty;

RuntimeService runtime;
RuntimeServiceHandle rs_handle;
MetadataObjectId jobSetId;
int startsIn;
long requestID = 0L;
 
RequestParameters req_par = new RequestParameters();
 
req_par.add(SystemProperty.PRIORITY, "stepId-1", new Integer(8));
req_par.add(SystemProperty.PRIORITY, "stepId-2.stepId-1", new Integer(6));
 
Calendar start = Calendar.getInstance();
start.add(Calendar.SECOND, startsIn);
 
requestID =
     runtime.submitRequest(rs_handle,"My job set", jobSetId, start, req_par);
.
.
.

9.4 システム・プロパティの使用

Oracle Enterprise Schedulerでは、SystemPropertyクラスで、システムによって認識され使用されるパラメータ名を表します。システム・プロパティは、アプリケーション・メタデータ内でパラメータ名として指定したり、リクエストを発行するときにリクエスト・パラメータを使用して指定できます。Oracle Enterprise Schedulerでは、リクエストが発行されたとき、またはリクエストのライフ・サイクルにおけるいずれかの時点で、特定のシステム・プロパティを設定します。

表9-3に、oracle.as.scheduler.SystemPropertyで定義される、使用可能なシステム・プロパティのリストを示します。ほとんどのシステム・プロパティはすべてのジョブ・タイプで共通ですが、表9-3の説明に示されているように、特定のジョブ・タイプに固有のシステム・プロパティもあります。

パラメータを使用する場合、Oracle Enterprise Schedulerでは、Oracle Enterprise Scheduler定義のプロパティ用に、"SYS_"で始まるパラメータ名(大文字と小文字を区別しません)が予約されていることに注意してください。

表9-3 システム・プロパティ

名前 説明

ALLOW_MULT_PENDING

同じジョブ定義の複数のリクエストの保留を許可するかどうかを指定します。このプロパティはジョブ・セット・ステップには影響しません。

タイプ: BOOLEAN

APPLICATION

リクエストの処理に使用されるJava EEアプリケーションの論理名を指定します。このプロパティは、リクエスト送信時にOracle Enterprise Schedulerによって自動的に設定されます。

タイプ: STRING

ASYNC_REQUEST_TIMEOUT

プロセッサが実行を開始した後に、非同期リクエストを待機する時間を分数で指定します。この期間が経過すると、リクエストはタイムアウトしたとみなされます。

タイプ: LONG

BIZ_ERROR_EXIT_CODE

実行ビジネス・エラーを表す、プロセス・ジョブ・リクエストのプロセス終了コードを指定します。このプロパティが指定されていない場合、プロセス終了コード4は実行ビジネス・エラーとして処理されます。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

CLASS_NAME

Javaジョブ・リクエストのJava実行可能ファイルを指定します。これは、oracle.as.scheduler.Executableインタフェースを実装するJavaクラスの名前である必要があります。このプロパティはJavaジョブ・タイプで必須です。他のジョブ・タイプでは使用されません。

タイプ: STRING

CMDLINE

プロセス・ジョブ・リクエストに対して外部プログラムを起動するために使用されるコマンド行を指定します。

このプロパティはプロセス・ジョブ・タイプの必須プロパティです。他のジョブ・タイプでは使用されません。

タイプ: STRING

CMDLINE_UNIX

UNIXまたはUNIXに類似したオペレーティング・システムでプロセス・タイプ・リクエスト実行可能ファイルを実行するための完全なコマンド行を指定します。一般的に、このプロパティはジョブ・タイプ内で指定され、実行可能ファイルの名前、パスおよび引数により、実行時に置換される値が指定されます。

次のプロパティEXECUTABLE_NAMEEXECUTABLE_DIR_UNIXEXECUTABLE_SUFFIX_UNIXPROCESS_ARGUMENTSを参照してください。

タイプ: STRING

CMDLINE_WINDOWS

Windowsオペレーティング・システムでプロセス・タイプ・リクエスト実行可能ファイルを実行するための完全なコマンド行を指定します。一般的に、このプロパティはジョブ・タイプ内で指定され、実行可能ファイルの名前、パスおよび引数により、実行時に置換される値が指定されます。

プロパティEXECUTABLE_NAMEEXECUTABLE_DIR_WINDOWSEXECUTABLE_SUFFIX_WINDOWSPROCESS_ARGUMENTSを参照してください。

タイプ: STRING

EFFECTIVE_APPLICATION

リクエストを処理するために使用される有効なアプリケーションであるJava EEアプリケーションの論理名を指定します。EFFECTIVE_APPLICATIONシステム・プロパティを定義して、ジョブ定義、ジョブ・タイプまたはジョブ・セット・ステップを異なるアプリケーションに関連付けることができます。このプロパティはメタデータでのみ指定できます。送信パラメータでは指定できません。

タイプ: STRING

EJB_OPERATION_NAME

EJBの操作名を指定します。これは、適切なビジネス・メソッドに分岐するBean実装によって使用可能です。このプロパティは、EJBジョブ・タイプに使用されます。

タイプ: STRING

ENVIRONMENT_VARIABLES

プロセス・ジョブ・リクエストの生成されたプロセスに対して設定する環境変数を指定します。プロパティ値は、設定される環境変数を表す名前/値ペア(name=value)のカンマ区切りリストである必要があります。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME

Oracle Enterprise SchedulerサーバーのJNDIにバインドされる、Oracle Enterprise SchedulerのAsyncRequest EJBのマップされた名前を指定します。

タイプ: STRING

ESS_JNDI_CSF_KEY_NAME

基礎となるOracle Enterprise SchedulerサーバーのJNDIプロバイダのCSF KEY名を示す名前を指定します。このプロパティは、ホスティング・アプリケーションのEssConfig内で設定できます。

タイプ: STRING

ESS_RUNTIME_JNDI_MAPPED_NAME

Oracle Enterprise SchedulerサーバーのJNDIにバインドされる、Oracle Enterprise SchedulerのRuntimeService EJBのマップされた名前を指定します。このプロパティは、EJBジョブ・タイプに使用されます。

タイプ: STRING

ESS_METADATA_JNDI_MAPPED_NAME

Oracle Enterprise SchedulerサーバーのJNDIにバインドされる、Oracle Enterprise SchedulerのMetadataService EJBのマップされた名前を指定します。

タイプ: STRING

EXECUTABLE_NAME

プロセス・タイプ・リクエストの実行可能ファイルの名前を指定します。値には、実行可能ファイルのパスを含めないでください。

プロパティEXECUTABLE_DIR_UNIXEXECUTABLE_DIR_WINDOWSを参照してください。

タイプ: STRING

EXECUTABLE_DIR_UNIX

UNIXまたはUNIXに類似したオペレーティング・システムでのプロセス・タイプ・リクエスト用の実行可能ファイルが存在するディレクトリを指定します。

タイプ: STRING

EXECUTABLE_DIR_WINDOWS

Windowsオペレーティング・システムでのプロセス・タイプ・リクエスト用の実行可能ファイルが存在するディレクトリを指定します。

タイプ: STRING

EXECUTABLE_SUFFIX_UNIX

プロセス・タイプ・リクエスト用の実行可能ファイルのファイル拡張子を指定します(汎用のUNIXまたはUNIXに類似したオペレーティング・システムで実行される場合)。デフォルトは拡張子なしです。

タイプ: STRING

EXECUTABLE_SUFFIX_WINDOWS

プロセス・タイプ・リクエスト用の実行可能ファイルのファイル拡張子を指定します(Windowsオペレーティング・システムで実行される場合)。デフォルトは拡張子なしです。

型: STRING

EXECUTE_AUTO_EXPORT

ジョブの実行ステージの実行前に、以前にインポート済のリクエストの出力コンテンツをリクエストの出力ディレクトリに自動的にエクスポートするかどうかを指定します。このプロパティは、プロセス、同期Javaおよび非同期Javaジョブ・タイプの実行ステージに適用できます。非同期Javaジョブ・タイプまたはPL/SQLジョブ・タイプの更新ステージには適用されません。

有効な値は次のとおりです。

  • true: ジョブの実行ステージの前に、以前にインポート済のすべての出力コンテンツがリクエストの出力ディレクトリ内のファイルにエクスポートされます。

  • false: 出力コンテンツは自動的にエクスポートされません。ジョブによって、出力コンテンツを手動でエクスポートすることが選択される場合があります。

このプロパティが指定されていない場合、システムのデフォルトであるfalseが使用されます。

タイプ: BOOLEAN

EXECUTE_PAST

実行時間が過去である繰返しリクエストのインスタンスを生成するかどうかを指定します。インスタンスは、リクエスト開始時間の前およびリクエスト終了時間の後には生成されません。過去のインスタンスが生成されるようにするには、このプロパティをTRUEに設定し、リクエスト開始時間をインスタンス生成を開始する最初の時間として指定する必要があります。リクエスト開始時間がnullである場合、現在の時間にデフォルト設定されます。

このプロパティの有効な値は次のとおりです。

  • TRUE: スケジュールによって指定されたすべてのインスタンスが、生成時間に関係なく生成されます。

  • FALSE: スケジュールされた実行時間が過去の時間(つまり、生成時間より前)であるインスタンスは生成されません。

このプロパティが指定されない場合は、デフォルトでTRUEに設定されます。

タイプ: BOOLEAN

EXTERNAL_ID

非同期Javaジョブの外部部分の識別子を指定します。たとえば、非同期Javaジョブでは通常リモート・プロセスを起動してから、Oracle Enterprise Schedulerに制御を戻します。このプロパティはリモート・プロセスの識別に使用されます。このプロパティは、識別子の判明時に非同期Javaジョブのジョブ実装によって設定されます。Oracle Enterprise Schedulerによっては設定されません。

タイプ: STRING

EXTERNAL_JOB_TYPE

ジョブのリモート・コンポーネントのタイプのインジケータを指定します。非同期Javaジョブ、WebServiceジョブまたはEJBジョブなどのリモート・コンポーネントを含むリクエストの場合、このプロパティはリモート・ジョブの性質を指定します。現在サポートされている外部ジョブ・タイプは、SystemProperty.ExternalJobTypeプロパティ内の要素の名前です。

サポートされている値はSOAOSBADFBCです。

このプロパティは省略可能です。指定されていない場合、ジョブの実装方法にかかわらず、Oracle Enterprise Schedulerによってリクエストが外部ジョブ・タイプに関連付けられません。

タイプ: STRING

GROUP_NAME

このリクエストがバインドされるOracle Enterprise Scheduler分離グループの名前を指定します。このプロパティは、リクエスト送信時にOracle Enterprise Schedulerによって自動的に設定されます。

タイプ: STRING

INPUT_LIST

リクエストに対する入力を指定します。シリアル・ジョブ・セットへの入力は、最初のステップのみへの入力として転送されます。パラレル・ジョブ・セットへの入力は、すべてのパラレル・ステップへの入力として転送されます。

Oracle Enterprise Schedulerによって、このプロパティの値に指定される形式はありません。

タイプ: STRING

INVOKE_MESSAGE

リモートWebサービスを起動するための入力として使用されるXMLメッセージ・ペイロードを指定します。このプロパティは、EJBジョブ・タイプおよびWebServiceジョブ・タイプに使用されます。このプロパティは、EJBジョブ・タイプのパススルー・パラメータです。

タイプ: STRING

JNDI_CSF_KEY

キーストア内のユーザー名およびパスワードにマップされるCSF別名を指定します。この特定のユーザー名/パスワードは、JndiMappedName参照で保護されたJNDIにアクセスするために必要な資格証明です。このプロパティは、JNDIツリーが保護されている場合のみ必須です。このプロパティは、EJBジョブ・タイプに使用されます。

タイプ: STRING

JNDI_MAPPED_NAME

ローカル/リモート・サーバーのJNDIにバインドされるEJBのマップされた名前を指定します。このプロパティは、EJBジョブ・タイプに使用されます。

タイプ: STRING

JNDI_PROVIDER_URL

リモート・サーバーに関連するJNDIプロバイダのURLを指定します。このプロパティはオプションであり、EJBおよびOracle Enterprise Schedulerがリモートに配置されている場合のみ必要です。このプロパティが指定されていない場合、ジョブはローカル・サーバーで実行されます。このプロパティは、EJBジョブ・タイプに使用されます。

タイプ: STRING

LISTENER

リクエストに関連付けられるイベント・リスナー・クラスを指定します。これは、oracle.as.scheduler.EventListenerインタフェースを実装するJavaクラスの名前である必要があります。

タイプ: STRING

LOCALE

リクエストに関連付けられるロケールを指定します。

タイプ: STRING

LOGICAL_CLUSTER_NAME

論理クラスタの名前を指定します。論理クラスタは物理クラスタに関連する情報で構成され、通常、ホスティング・アプリケーションの構成内に格納されます。論理クラスタ名は、アプリケーションの構成内の物理クラスタ情報セットへの参照です。プロパティが指定されていない場合、論理クラスタはリクエストに関連付けられません。

タイプ: STRING

OUTPUT_LIST

リクエストからの出力を指定します。

シリアル・ジョブ・セットの出力は、最後のステップのOUTPUT_LISTです。パラレル・ジョブ・セットの出力は、すべてのステップのOUTPUT_LISTの連結です。oracle.as.scheduler.SystemProperty.OUTPUT_LIST_DELIMITERがセパレータとして使用され、保証されている順序はありません。

タイプ: STRING

POST_PROCESS

後処理コールアウト・ハンドラ・クラスを指定します。これは、oracle.as.scheduler.PostProcessHandlerインタフェースを実装するJavaクラスの名前である必要があります。

タイプ: STRING

PRE_PROCESS

前処理コールアウト・ハンドラ・クラスを指定します。これは、oracle.as.scheduler.PreProcessHandlerインタフェースを実装するJavaクラスの名前である必要があります。

タイプ: STRING

PRIORITY

リクエスト処理の優先度を指定します。優先度の範囲は[0..9]であり、0が最下位の優先度を、9が最上位の優先度を示します。

デフォルト: このプロパティが指定されていない場合、システムのデフォルト値は4です。

タイプ: INTEGER

PROCEDURE_NAME

SQLジョブ・リクエストでコールされるPL/SQLストアド・プロシージャの名前を指定します。ストアド・プロシージャは、schema.nameの形式で指定する必要があります。

このプロパティはSQLジョブ・タイプの必須プロパティです。他のジョブ・タイプでは使用されません。

タイプ: STRING

PRODUCT

リクエストを送信したアプリケーション内の製品を指定します。

タイプ: STRING

PROCESS_ARGUMENTS

プロセス・タイプ生成プロセスの実行可能ファイルに渡される引数を指定します。

タイプ: STRING

REDIRECTED_OUTPUT_FILE

プロセス・ジョブ・リクエストに対して標準出力およびエラー・ストリームがリダイレクトされるファイルを指定します。これは、リクエストが実行されたときに、生成されたプロセスに対して標準出力およびエラー・ストリームがリダイレクトされるログ・ファイルのフルパスを表します。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

REPROCESS_DELAY

コールアウト・ハンドラの処理遅延時間を指定します。コールバック・ハンドラによって遅延がリクエストされたときに、リクエスト処理を遅延させる時間を分単位で示します。

デフォルト: このプロパティが指定されていない場合、使用されるシステムのデフォルトは5です。

タイプ: INTEGER

REQUEST_CATEGORY

リクエストのアプリケーション固有ラベルを指定します。アプリケーションまたはシステムの管理者が定義したラベルを指定することで、管理者は独自の要件に応じてジョブ・リクエストをグループ化できます。

タイプ: STRING

REQUEST_EFFECTIVE_ENCODING

プロセス・ジョブ・リクエストに関連付けられている有効なエンコーディングを指定します。

SpawnLauncherにより、次の優先順序で、生成されたジョブ・リクエストのロケール設定が決定されます。

  1. リクエストの環境プロパティ(SystemProperty.ENVIRONMENT_VARIABLES)で指定されるLC_ALL/LANG

  2. ホスティング・アプリケーションess-config.xmlファイルで指定されているLC_ALL/LANG

  3. Weblogic Server LC_ALL/LANG

有効なエンコーディングは、プロセスが生成される前に計算され、このプロパティに格納されます。これは、リクエストのログおよび出力に使用するエンコーディングの決定に後で使用されます。

タイプ: STRING

REQUEST_EXPIRATION

リクエストの有効期限を指定します。これは、リクエストの有効期限が切れる時間を、スケジュールされた実行時間からの分数で表します。有効期限値のゼロ(0)は、リクエストが有効期限切れにならないことを意味します。このプロパティが指定されていない場合、システムのデフォルト値は0です。

リクエストの有効期限は実行待機中のリクエストにのみ適用されます。指定された有効期限よりも待機時間が長いリクエストは実行されません。リクエストの実行が開始された後は、リクエストの有効期限は適用されません。

タイプ: INTEGER

REQUEST_LOG_LEVEL

リクエスト・ロギングのログ・レベルを指定します。ログ・レベルの有効値は、java.util.loggingで定義されているレベルの文字表現です。レベルは、Level.getName()を使用して取得します。デフォルトのログ・レベルはINFOです。

タイプ: STRING

REQUESTED_PROCESSOR

リクエストを処理するリクエスト・プロセッサ・ノードを指定します。これにより、リクエストにプロセッサ・アフィニティを指定できるようになります。このプロパティが指定されていない場合、使用可能な任意のリクエスト・プロセッサ・ノードでリクエストを実行できます。通常、このプロパティは指定しません。

このプロパティをリクエストに指定した場合、リクエスト・プロセッサの作業割当てoracle.as.scheduler.WorkAssignment(特殊化)でこのようなリクエストの実行を許可する必要があります。許可しなかった場合、そのリクエストは実行されません。指定されたノードが実行されていない場合、リクエストはREADY状態のままとなり、ノードが再起動されるまで実行されません。

タイプ: STRING

RESOLVED_CMDLINE

プロセス・タイプ・ジョブ・リクエストに使用されるコマンド行を指定します。このプロパティは、Oracle Enterprise Schedulerによってのみ設定されます。これは、診断のみを目的としています。

タイプ: STRING

RETRIES

失敗したリクエストの再試行上限を指定します。リクエストの実行が失敗した場合、リクエストが成功するまで、このプロパティにより指定された回数までリクエストが再試行されます。再試行制限がゼロ(0)の場合、失敗したリクエストは再試行されません。

デフォルト: このプロパティが指定されない場合に使用されるシステムのデフォルトは0です。

タイプ: INTEGER

RUNAS_APPLICATIONID

リクエストを実行するために使用する必要があるrunAs識別子を指定します。通常、リクエストは発行元ユーザーとして実行されます。ただし、このプロパティがリクエストに関連付けられているジョブのメタデータで設定されている場合、リクエストはこのプロパティで指定されるユーザーとして実行されます。このプロパティはメタデータでのみ指定できます。送信パラメータでは指定できません。

タイプ: STRING

SELECT_STATE

ジョブ・セット・ステップの結果状態がその親ジョブ・セットの最終的な状態に影響するかどうかを指定します。ジョブ・セットの状態を決定するときにジョブ・セット・ステップの状態が考慮されるようにするには、SELECT_STATEtrueに設定する必要があります。ジョブ・セット・ステップにSELECT_STATEが指定されていない場合、ステップの状態はジョブ・セットの状態を決定するときに考慮されます。

タイプ: BOOLEAN

SQL_JOB_CLASS

SQLジョブ・リクエストの実行に使用されるOracle Enterprise Schedulerジョブに割り当てる、Oracle Enterprise Schedulerジョブ・クラスを指定します。ジョブ・リクエストに使用されるジョブが特定のOracle Databaseリソース・コンシューマ・グループに関連付けられている、またはデータベース・サービスへの親和性があるという場合は、このプロパティは指定する必要がありません。

このプロパティが指定されていない場合、SQLリクエストを実行するジョブにデフォルトのOracle Enterprise Schedulerジョブ・クラスが使用されます。そのジョブ・クラスはデフォルトのリソース・コンシューマ・グループに関連付けられます。これはデフォルト・サービスに属し、サービス・アフィニティがなく、Oracle RAC環境内で、クラスタ内のデータベース・インスタンスのいずれかがジョブを実行します。Oracle Enterprise Scheduler SQLジョブ・リクエストがそのデフォルト・ジョブ・クラスを使用するのに、追加の権限は要求されません。

このプロパティはSQLジョブ・タイプのオプションのプロパティです。他のジョブ・タイプでは使用されません。

タイプ: STRING

SUBMITTING_APPLICATION

発行された(絶対親)リクエストに対してJava EEアプリケーションの論理名を指定します。このプロパティは、リクエスト送信時にOracle Enterprise Schedulerによって自動的に設定されます。

タイプ: STRING

SUCCESS_EXIT_CODE

実行の成功を示すプロセス・ジョブ・リクエストのプロセス終了コードを指定します。このプロパティが指定されていない場合、システムは、プロセス終了コード0を実行の成功と見なして処理します。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

SUPPORT_OUTPUT_FILES

リクエストで一時ファイルまたは出力ファイルを作成するかどうかを指定します。このプロパティは、前処理、実行、非同期更新および後処理の各ステージで適用されます。リクエストでは、APIを使用してコンテンツ・ストア内に出力コンテンツを常に直接作成できます。

プロパティ値によって、実行するアクションが指定されます。このプロパティが指定されていない場合、ディレクトリは作成されません。有効ではない値は、プロパティが指定されていない場合と同じように処理されます。

有効な値は次のとおりです。

  • SystemProperty.SUPPORT_OUTPUT_FILES_NONE

  • SystemProperty.SUPPORT_OUTPUT_FILES_WORK

  • SystemProperty.SUPPORT_OUTPUT_FILES_OUTPUT

タイプ: STRING

UPLOAD_CONTENT_TO_REPOSITORY

リクエストの実行が完了したときに、リクエスト・ログおよび出力ファイルを、内部リポジトリからUniversal Content Management (UCM)などの個別のリポジトリにアップロードするかどうかを指定します。

プロパティ値によって、実行するアクションが指定されます。このプロパティが指定されていない場合、コンテンツはアップロードされません。有効ではない値は、プロパティが指定されなかった場合と同じように処理されます。

次の値が有効です。

SystemProperty.UPLOAD_CONTENT_TO_REPOSITORY_COPY

タイプ: STRING

USE_ALTERNATE_ENV

通常のアプリケーション環境ではなくコールアウトから代替環境を使用するかどうかを指定します。このプロパティが指定されていない場合、通常のアプリケーション環境が使用されます。

タイプ: BOOLEAN

USE_EXTENDED_SETUP

ジョブの起動関連のコード(ジョブの実行可能ファイルまたは前処理ハンドラ、後処理ハンドラなど)の前にApplSessionsなどの機能を開始するかどうかを指定します。拡張機能は、それが使用可能な環境内でのみ起動されます。このプロパティが指定されていない場合、ジョブの実行前に拡張機能は設定されません。

タイプ: BOOLEAN

USER_FILE_DIR

入力ファイルや出力ファイルなどリクエストの実行可能ファイルで使用されるファイルが保存される、ファイル・システム上のベース・ディレクトリを指定します。

Oracle Enterprise Schedulerでは、リクエストによりファイルを保存できるファイル・ディレクトリを指定する構成パラメータがサポートされます。構成パラメータが現在設定されており、USER_FILE_DIRプロパティがリクエストに対して指定されていない場合、リクエストが発行されるときに、USER_FILE_DIRプロパティがリクエストに自動的に追加されます。追加されたプロパティは、構成パラメータの値に初期化されます。リクエスト送信時に構成パラメータが設定されていなかった場合、このプロパティは追加されません。

タイプ: STRING

USER_FILE_DIR_SHARED

リクエストのUSER_FILE_DIR (構成済RequestFileDir)ディレクトリが共有されているかどうかを指定します。このプロパティは、RequestFileDirSharedの値を表します。このプロパティは、標準または拡張リクエスト・モードでのリクエストに有効です。

有効な値は次のとおりです。

  • true: USER_FILE_DIRは共有ディレクトリです。

  • false: USER_FILE_DIRは、ローカル・ディレクトリです。

このプロパティが指定されていない場合、システムのデフォルトであるfalseが使用されます。

タイプ: BOOLEAN

USER_NAME

リクエストを実行するために使用されるユーザーの名前を指定します。ジョブ・メタデータでRUNAS_APPLICATIONIDプロパティが設定されている場合を除き、通常、これは発行元ユーザーとなります。このプロパティは、リクエスト送信時にOracle Enterprise Schedulerによって自動的に設定されます。

タイプ: STRING

WARNING_EXIT_CODE

実行に関する警告を示すプロセス・ジョブ・リクエストのプロセス終了コードを指定します。このプロパティが指定されていない場合、システムは、プロセス終了コード3を実行の警告と見なして処理します。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

WORK_DIR_ROOT

プロセス・ジョブ・リクエストの、生成されたプロセスのための作業ディレクトリを指定します。

このプロパティはプロセス・ジョブ・タイプではオプションです。他のジョブ・タイプでは使用されません。

タイプ: STRING

WS_WSDL_URL

WebサービスWSDLの相対URLを指定します。ベースURLは、WS_WSDL_BASE_URLシステム・プロパティによって指定されます。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_WSDL_BASE_URL

WebサービスWSDLの完全URLを提供するためにWS_WSDL_URLシステム・プロパティを組み合せて使用できるベースURLを指定します。通常、このプロパティは、LOGICAL_CLUSTER_NAMEシステム・プロパティと組み合せて使用されます。これは、クラスタ内のすべてのWebサービスWSDLに共通する汎用ベースURLとなるものです。このプロパティは、WebServiceジョブ・タイプに使用されます。

このプロパティは省略可能です。指定されていない場合、リクエストのLOGICAL_CLUSTER_NAMEシステム・プロパティがホスティング・アプリケーションの構成内で構成されていれば、これに関連付けられている情報から同等の情報を取得できます。

タイプ: STRING

WS_TARGET_NS

Webサービスに対してターゲットのネームスペースを指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_ENDPOINT_URL

Webサービス・エンドポイントの相対URLを指定します。ベースURLは、WS_ENDPOINT_BASE_URLシステム・プロパティによって指定されます。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_ENDPOINT_BASE_URL

Webサービス・エンドポイントの完全URLを提供するためにWS_ENDPOINT_URLシステム・プロパティを組み合せて使用できるベースURLを指定します。通常、このプロパティは、LOGICAL_CLUSTER_NAMEシステム・プロパティと組み合せて使用されます。これは、クラスタ内のすべてのWebサービスのエンドポイントに共通する汎用ベースURLとなるものです。このプロパティは、WebServiceジョブ・タイプに使用されます。

このプロパティは省略可能です。指定されていない場合、リクエストのLOGICAL_CLUSTER_NAMEシステム・プロパティがホスティング・アプリケーションの構成内で構成されていれば、これに関連付けられている情報から同等の情報を取得できます。

タイプ: STRING

WS_SERVICE_NAME

Webサービス操作のWSDLサービス名を指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_PORT_NAME

Webサービス操作のWSDLポート名を指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_OPERATION_NAME

Webサービス操作のWSDL操作名を指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_CANCEL_OPERATION_NAME

Webサービスの取消し操作のWSDL操作名を指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING

WS_CANCEL_MESSAGE

リモートWebサービスで取消しを起動するための入力として使用されるXMLメッセージ・ペイロードを指定します。このプロパティは、WebServiceジョブ・タイプに使用されます。

タイプ: STRING