3.6.8 予約プロパティ一覧
予約プロパティとは,JP1/AOがプロパティキーの定義や用途を規定している特殊なサービスプロパティです。プロパティキーは「reserved.」で始まります。このプロパティは,[入力プロパティマッピング]ダイアログボックスまたは[出力プロパティマッピング]ダイアログボックスで,ステッププロパティにマッピングして使用します。ユーザーが,プロパティの定義や値を設定する必要はありません。
入力プロパティとして予約プロパティをマッピングすると,部品実行時に予約プロパティの値が部品プロパティの値に反映されます。
予約プロパティを使用するには,[入力プロパティマッピング]ダイアログボックスで[プロパティ参照]ラジオボタンを選択します。
または,[直接入力]を選択し,[プロパティ挿入]ボタンをクリックします。[参照プロパティ選択]ダイアログボックス※で予約プロパティを選択すると,[値]テキストボックスに「?dna_予約プロパティキー?」の形式で,予約プロパティを指定できます。この場合,部品実行時に部品プロパティの一部として値が反映されます。
- 注※
- [ステップツリー]エリアで繰り返し実行部品のステップを選択した場合だけ,[予約プロパティ]ダイアログが表示され,繰り返し実行部品に関連する予約プロパティが表示されます。
出力プロパティとして予約プロパティを使用すると,任意の部品プロパティの値が予約プロパティに格納されます。[出力プロパティマッピング]ダイアログボックスで,[プロパティ参照]ラジオボタンを選択すると,出力プロパティに対して,値を反映する先のサービスプロパティとして指定できます。
予約プロパティキー |
説明 |
---|---|
reserved.external.hcmds.dir |
JP1/AOのインストールディレクトリと同階層に作成される内部ディレクトリ(HiCommand)を参照するためのプロパティです。外部リソースプロバイダ機能の外部リソースプロバイダ作成で使用します。 例:C:\\Program Files\\Hitachi\\HiCommand |
reserved.external.path |
[追加パス]に指定した,REST APIの追加パスを参照するためのプロパティです。外部リソースプロバイダ機能の外部リソースプロバイダ作成で使用します。 |
reserved.external.query |
[クエリパラメタ]に指定した,REST APIに渡されるクエリパラメタを参照するためのプロパティです。外部リソースプロバイダ機能の外部リソースプロバイダ作成で使用します。 |
reserved.external.resource.dir |
外部リソースのリソースディレクトリを参照するためのプロパティです。外部リソースプロバイダ機能の外部リソースプロバイダ作成で使用します。 例:C:\\Program Files\\Hitachi\\JP1AO\\contents\\ExternalResources\\6e29b455-90ef-45d7-b973-458f5ba5320d |
reserved.external.userName |
REST APIからJP1/AOにログインしているユーザーを参照するためのプロパティです。外部リソースプロバイダ機能の外部リソースプロバイダ作成で使用します。 |
reserved.loop.index※1 |
選択している部品から見て,1個上位の繰り返し実行部品の繰り返し実行の回次を表す1~99の数値を参照するためのプロパティです。 繰り返し実行の回次とは,繰り返し実行部品のプロパティ「inputProperties」に指定された「,」区切りのデータのうち,何番目のパラメータに対応する実行かを表しています。繰り返し実行方式が「parallel」の場合でも回次を参照できます。この予約プロパティを参照指定で使う場合は?dna_reserved.loop.index?と記述します。 このプロパティは,reserved.loop.inputと同じように,繰り返し実行部品の配下のフロー内で,かつ,サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.loop.indexN※1 |
選択している部品から見て,N個上位の繰り返し実行部品の繰り返し実行の回次を表す1~99の数値を参照するためのプロパティです。 繰り返し実行の回次とは,繰り返し実行部品のプロパティ「inputProperties」に指定された「,」区切りのデータのうち,何番目のパラメータに対応する実行かを表しています。繰り返し実行方式が「parallel」の場合でも回次を参照できます。この予約プロパティを参照指定で使う場合は?dna_reserved.loop.indexN?と記述します。 このプロパティは,reserved.loop.inputと同じように,繰り返し実行部品の配下のフロー内で,かつ,サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 N:2または3の整数値 |
reserved.loop.input※1 |
選択している部品から見て,1個上位の繰り返し実行部品の入力プロパティ「inputProperties」の値を参照するための予約プロパティです。 繰り返し実行部品の入力プロパティで指定したコンマ区切りの値のうち,フローの繰り返し回数に対応した項目の値が入力されます。例えば,入力プロパティが「A,B,C」だった場合,繰り返しの回次に応じて「A」,「B」,「C」が順に入力されます。繰り返しは99回まで実行できます。この予約プロパティを参照指定で使う場合は?dna_reserved.loop.input?と記述します。 |
reserved.loop.inputN※1 |
選択している部品から見て,N個上位の繰り返し実行部品の入力プロパティ「inputProperties」の値を参照するための予約プロパティです。 繰り返し実行部品の入力プロパティで指定したコンマ区切りの値のうち,フローの繰り返し回数に対応した項目の値が入力されます。例えば,入力プロパティが「A,B,C」だった場合,繰り返しの回次に応じて「A」,「B」,「C」が順に入力されます。繰り返しは99回まで実行できます。この予約プロパティを参照指定で使う場合は?dna_reserved.loop.inputN?と記述します。 N:2または3の整数値 |
reserved.loop.output |
繰り返し実行部品の出力プロパティ「outputProperties」に値を代入するための予約プロパティです。 このプロパティに出力された値が,コンマ区切りで出力プロパティに反映されます。例えば,部品の出力プロパティの値がフローの繰り返し回数に対応して「X」,「Y」,「Z」となった場合,出力プロパティには「X,Y,Z」という結果が反映されます。 |
reserved.service.name |
タスクの生成元となったサービスの名称を参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.service.name?と記述します。サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.step.path |
実行中のステップのIDを参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.step.path?と記述します。タスクログに出力される部品実行開始および終了時のメッセージの埋め字と同じ値です。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.service.serviceGroupName |
タスクの生成元となったサービスが登録されているサービスグループを参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.service.serviceGroupName?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.step.prevReturnCode |
先行のステップ(接続された関連線の接続元となるステップ)の戻り値を参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.step.prevReturnCode?と記述します。 先行のステップが複数ある場合は,すべての戻り値の論理和が設定されます。先行のステップがない場合は0が設定されます。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 タスクをリトライする場合に,先行のステップを実行しないで,この予約プロパティを参照するステップから実行するときは,先行ステップの戻り値として前回ステップを実行したときの戻り値が設定されます。※ |
reserved.task.description |
タスクの説明を参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.description?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.task.dir |
タスク実行時に一時的に作成される,データフォルダのパスを参照するための予約プロパティです。 このプロパティは,タスク実行時にタスクごとの一意のフォルダパスに展開されます。 このフォルダは,タスクを実行するときJP1/AOサーバ上に作成され,タスクのアーカイブ時に削除されます。 なお,名称が「task」で始まるファイルやフォルダは,JP1/AOで予約されているため,ユーザーは作成しないでください。 |
reserved.task.id |
タスクIDを参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.id?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.task.name |
タスク名を参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.name?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.task.submitter |
タスクの実行者のユーザーIDを参照するためのプロパティです。 タスクをリトライした場合でも,リトライしたときのユーザーではなく,タスクを実行したときのユーザーのユーザーIDを参照します。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.submitter?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.task.tags |
タスクに設定されているタグを参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.tags?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.task.url |
[タスク詳細]画面へのURLを参照するためのプロパティです。 この予約プロパティを参照指定で使う場合は?dna_reserved.task.url?と記述します。 サービスプロパティをマッピングできる部品であればどの部品でも使用できます。 |
reserved.terminal.account |
ターミナル接続部品で使用されたユーザーIDを参照するための予約プロパティです。 ターミナルコマンド実行部品の入力プロパティ「commandLine」で使用します。 接続に使用するユーザーアカウントが入力されます。 |
reserved.terminal.password |
ターミナル接続部品で使用されたパスワードを参照するための予約プロパティです。 ターミナルコマンド実行部品の入力プロパティ「commandLine」で使用します。 接続に使用するユーザーアカウントのパスワードが入力されます。 |
reserved.terminal.suPassword |
ターミナル接続部品で使用された管理者のパスワードを参照するための予約プロパティです。 ターミナルコマンド実行部品の入力プロパティ「commandLine」で使用します。 接続で使用するスーパーユーザーのパスワードが入力されます。 |
- 注※1
- 繰り返し実行部品を入れ子で定義している場合,繰り返し実行入力値(reserved.loop.input,reserved.loop.inputN),および繰り返し実行回次(reserved.loop.index,reserved.loop.indexN)は,プルダウンメニューにまとめて表示されます。その場合,対応する繰り返し実行部品のステップ名が括弧内に表示されます。詳細を次の図に示します。
- 注※2
タスクをリトライした場合,予約プロパティに設定される値の例を次に示します。
フローにstep1,step2,step3というステップがあり,step2とstep3にはそれぞれ「reserved.step.prevReturnCode」が定義されています。step1の戻り値は0,step2の戻り値は63で失敗,step3は未実行という状態でタスクが失敗したとします。
この状態で[失敗したステップからリトライ]を実行する場合,step2から見た「reserved.step.prevReturnCode(step1の戻り値)」は0になります。また,[失敗した次のステップからリトライ]を実行する場合,step3から見た「reserved.step.prevReturnCode(step2の戻り値)」は63になります。