プレイブックの操作

プレイブック操作は、グラフィック・プレイブック設計者で使用されるスクリプトにのみ適用されます。 「スクリプト」 タブでスクリプトを作成する場合、プレイブック操作は使用できません。

プレイブック・キーワードを使用すると、関数の結果にアクセスし、任意のプロパティー値を保管および取得できます。

プレイブック・キーワードは、プレイブックの現在のインスタンスのデータにのみアクセスでき、通常はローカル・スクリプトで使用されます。 概要については、 グローバル・スクリプトとローカル・スクリプトを参照してください。

スクリプト行に playbook. と入力して、使用可能な操作を表示します。

操作 説明 
inputs.<field_name>
 手動でアクティブ化されたプレイブックまたはサブプレイブックの入力にアクセスします。

入力は読み取り専用であり、変更できません。 ただし、表の最後に説明されているように、この値を取得して、スクリプトで使用するために変更することができます。

 
functions
 プレイブックで以前に実行された関数の結果にアクセスします。 結果は、関数出力名でアクセスできます。 以下の属性参照を使用します。ここで、output_nameは関数の保存済み出力の名前です。
playbook.functions.results.<output_name>

関数の結果は読み取り専用であり、変更できません。 ただし、表の最後に説明されているように、この値を取得して、スクリプトで使用するために変更することができます。

 
subplaybooks.results.<output_name>
 親プレイブックで使用するためにサブプレイブックの結果にアクセスします。 結果は読み取り専用であり、変更できません。 ただし、表の最後に説明されているように、この値を取得して、スクリプトで使用するために変更することができます。 
properties
 playbook.addPropertyによって以前に入力されたデータにアクセスします。 以下の属性参照を使用します。ここで、propertyNameは既存のプレイブック属性名です。
playbook.properties.<propertyName>

属性参照は、workflow.properties.<propertyName>と同じように使用できます。

 
addProperty
 プレイブックのプロパティーを追加または更新します。 プレイブック内で再使用する必要がある任意の値を指定できます。 次のコマンドを使用します。ここで、propertyNameは選ばれた任意名ですが、固有でなければなりません。 <propertyValue>はPython辞書でなければなりません。
playbook.addProperty(<propertyName>, <propertyValue>)

このコマンドは、workflow.addProperty()と同じように使用できます。

 
results
 サブプレイブックの結果を保管します。 これは、サブプレイブックのエンドポイントで使用されます。 結果は、以下の例に示すように辞書に保管されます。
playbook.results = {dictionary}

サブプレイブックの結果は、サブプレイブックのエンドポイントの必須フィールドになります。 サブプレイブックに結果がない場合は、 playbook.results = Noneを使用します。
results および properties は辞書であるため、辞書を使用する任意の Python 方式で使用できます。 例えば、playbook.properties.foobar['result1'] は playbook.properties.foobar.result1 と同じです。 また、次のように使用することもできます。
str(playbook.properties) 
str(playbook.properties.foobar)
inputs、 functions、および subplaybook.results の値は読み取り専用であり、変更できません。 ただし、この値を取得して、スクリプトで使用するために変更することができます。 次のコマンドは、 inputsの値を変更する方法を示しています。 新しい値はスクリプト内でのみ使用され、そのノードでスクリプトの実行が完了した後は使用できません。 プレイブック内の後続のスクリプトには、元の値が表示されます。
playbook.inputs.number=playbook.inputs.number+1,