カスタム Playbook アクション

ボタン、ドロップダウン、リストアイテム、クリック可能なアイコンを追加する条件を設定して、Playbook インタラクションをカスタマイズします。このカスタマイズにより、すべての Playbook Experience でフォームを送信し、レコードを開き、アクティビティを完了およびスキップできます。

概要

Playbook アクションは、トリガーされたときにサーバースクリプトを実行したり、クライアントアクションをディスパッチしたり、UI コンポーネントをレンダリングしたりできます。サーバー スクリプトを実行すると、現在の変数はアクティビティの関連レコードに関連付けられます。内の UI ビルダーイベントをトリガするクライアント・アクションを使用する場合は、を参照してください Playbook の UXF クライアントアクションの構成。

フローデータレコード (sys_flow_data) は、アクションサーバースクリプトを介してフローの構成を制御するための関連レコードとしてよく使用されます。これらのサーバースクリプトは、フローのステータスを完了またはスキップに設定できるため、エージェントはフロー内のロジックに直接影響を与えることができます。

フローデータレコードは、エージェントからユーザーデータを収集してフロー内で使用することもできます。

関連レコードは任意のテーブルに関連付けることができます。これらのデフォルトアクション以外にも独自のアクションを定義して、必要なビジネスプロセスワークフローロジックを実現できます。

[ フォームフィールドが必要 (Requires form fields )] チェックボックスをオンにすると、サーバー以外のスクリプトアクションで保存してから続行機能を有効にすることができます。保存してから次に機能を持つアクションは、フォームを送信し、クライアントスクリプトとビジネスルールの検証を実行し、レコードが正常に保存された後にアクションを実行します。検証ルールまたはビジネスルールによってレコードが保存できない場合、アクションは実行されません。デフォルトでは、これによりフォームを送信する sysverb_ws_save UI アクションがトリガーされますが、クライアントアクションペイロードの uiActionName プロパティに別の UI アクションを指定することで上書きできます。

デフォルトアクション

Playbook では、次のデフォルトのアクションがサポートされています。

アクション名	説明
スキップ skip_instructional	説明プロセスのステップをスキップします
スキップ skip_email	メールの送信をスキップします
スキップ skip_knowledge	ナレッジプロセスステップをスキップします
スキップ skip_update	レコード更新プロセスステップをスキップします
スキップ skip_list	リストプロセスステップをスキップします
スキップ skip_create	レコード作成プロセスステップをスキップします
完了としてマーク complete_activity	アクティビティを完了としてマーク
レコードを作成 create_record	新しいレコードフォームから新しいレコードを作成する
メール送信 send_email	メールを送信するようにプロセスの自動化を通知します
再起動 restart_activity	アクティビティを再開します
スキップ skip_activity	エクスペリエンスステータスレコードを使用してアクティビティをスキップ済みとしてマークします。
レコードの表示 レコードの表示	現在のレコードを表示する
保存 save_record	現在のレコードを保存
承認者の表示 プレイブックビュー承認者	このレコードの承認者を表示
完了としてマーク mark_complete_knowledge	ナレッジプロセスステップを完了としてマーク
完了としてマーク mark_complete_instructional	説明プロセスステップを完了としてマークします
完了としてマーク mark_complete_list	リストプロセスステップを完了としてマーク
完了としてマーク mark_complete	現在のプロセスを完了としてマークします
完了としてマーク save_and_complete_activity	現在のレコードを保存し、プロセスを完了としてマーク

Playbook アクションのカスタマイズ

フォーム、条件、スクリプト、コンポーネント、またはクライアントアクションを使用して、Playbook アクションをカスタマイズします。このカスタマイズにより、ユーザーはフォームを送信したり、レコードを開いたり、アクティビティを完了しスキップしたりできます。

始める前に

必要なロール：playbook_experience.admin

このタスクについて

• デフォルトのアクションは編集できません。これらのアクションは読み取り専用として表示されます。
• アクションは 1 つのレコードに対してのみ操作できます。

手順

1. アクションを作成し、詳細を指定します。
   1. 移動先 Playbook Experience > アクション Playbook アクション、 ステージアクション、または アクティビティアクション。
   2. アクションの割り当てを選択するか、[ 新規 ] をクリックして新しい割り当てを作成します。
      注:

      デフォルトアクションのリストについては、「 Playbook アクション」を参照してください。
   3. フォームのフィールドに入力します。

      表 : 1. アクションのアサインフォーム

      フィールド	説明
      アクションラベル	アクションによって作成されたボタンに表示されるラベル。
      アクション名	アクションのアサインリストに表示されるアクションの名前。アクションのアサインは、同じ名前の他のアクションを上書きします。
      実装方法	実装されるアクションのタイプ。たとえば、UI コンポーネントです。
      UI コンポーネントを指定	[実装方法] フィールドが [UI コンポーネント] に設定されている場合、このフィールドはアクションがトリガーされたときに表示される UI コンポーネントを指定します。
      ツールヒント	エージェントがボタンまたはアイコンにカーソルを合わせたときに表示されるテキスト。
      アイコン	アクティビティカードに表示されるアイコン。
      レンダリングモード	Playbook カードのレンダリングモード。Playbook カードでのアクションのレンダリング方法を指定します。ボタン、 ヘッダードロップダウン、または ヘッダーアイコンを選択します。
      ボタンタイプ	Playbook UI に表示されるボタンタイプ。[プライマリ]、[セカンダリ]、または [ターシャリ] を選択します。
      フォームフィールドが必要	続行するためにユーザーからのデータが必要なアクションを伝えるオプション。 このフィールドは、Playbook Experience UI で次のように使用されます。 アクティビティに含まれているフォームが大きすぎてカードに収まらない場合、フォームはモーダルで非表示になります。 アクティビティにフォームが含まれていても、フォームフィールドを必要とするアクションがない場合、フォームは表示されません。代わりに、フォーム上のフィールドは、ラベルと値のペアの積み重ねられたコレクションとしてレンダリングされます。 このフィールドは、カスタムアクティビティレンダラーを作成することで上書きできます。
      説明	[アクションのアサイン] リストに表示されるアクションの説明。
      アプリケーション	アクションのアサインのアプリケーション。
      ワークスペース	Playbook アクションが関連付けられているワークスペース。たとえば、 ServiceNow® ITSM 人事などです。 注: このフィールドは必須ではありません。
      テーブル	このアクションをこの関連テーブルを持つアクティビティに制限するフィールド。
      表示	このアクションをこのフォームビューのアクティビティに制限するフィールド。
      アクティブ	アクションを有効にするオプション。
      順序	同じ名前の一致するアクションに関連して、このアクションの優先順位を決定する整数。 数値が小さいほど、他のアクションよりも選択される可能性が高くなります。この順序付けにより、他のアクションを独自のアクションで上書きできます。一般的には百ごとの数を使用します。例：100、200、300、400。

2. アクションの条件を設定します。
   1. [条件] タブをクリックします。
   2. フォームのフィールドに入力します。

      表 : 2. [条件] フォーム

      フィールド	説明
      スクリプト条件	アクションのアサインのスクリプト条件。「sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current)」と入力します。このスクリプトを使用すると、レコードがプロセスの実行をトリガーした場合にのみ Playbook を表示できます。 注: 複数の結合を含むクエリを追加すると、パフォーマンスが低下する可能性があります。
      クライアント条件	ユースケースに基づいて競合を制限する条件を選択します。
      レコード条件	ユースケースに基づいて競合を制限する条件を選択します。
      必要なロール	Playbook へのアクセスを制限するロール。
      作成アクセス権が必要	作成アクセス権を要求するオプション。
      読み取りアクセス権が必要	読み取りアクセス権を要求するオプション。
      書き込みアクセスが必要	書き込みアクセス権を要求するオプション。
      削除アクセス権が必要	削除アクセス権を要求するオプション。

3. [実装方法] フィールドで [サーバースクリプト] が選択されている場合は、アクションのスクリプトを入力します。
   • サーバー スクリプトは、変数を使用して Current アクティビティの関連レコードを参照できます。
   • 呼び出しにより current.update() 、ユーザーが Playbook カードの埋め込みフォームから指定した値で関連レコードが更新されます。
4. [実装方法] フィールドで [クライアントアクション] を選択した場合は、オプションで [アクション属性] タブでペイロードマッピングを指定します。

   ペイロードマッピングを使用すると、クライアントアクションによってディスパッチされるペイロードの一部を上書きできます。たとえば、[レコードのプレビュー] クライアントアクションを使用すると、新しい ワークスペース タブでレコードを開くことができます。ペイロードマッピングを使用すると、フォームが開いたときに表示される関連アイテムタブを指定できます。これを行うには、 defaultTab を設定します。

5. [実装方法] フィールドで [UI コンポーネント] が選択されている場合は、オプションで [コンポーネント属性] タブでコンポーネントの属性を指定します。
6. [送信] をクリックします。

Playbook アクションの Playbook Experience への適用

デフォルトまたはカスタムの Playbook アクションを Playbook Experience に適用します。

始める前に

必要なロール:playbook_experience_admin

手順

1. 移動先 すべて > Playbook Experience > Playbook Experience.
2. [プレイブックエクスペリエンス] を選択します。
3. [アクションマッピング] 関連リストをクリックします。
4. [新規] をクリックします。
5. フォームのフィールドに入力します。

   表 : 3. Playbook Experience アクション割り当てマップ

   フィールド	説明
   アクションのアサイン	宣言アクションのアサインを選択
   Playbook Experience	アクションを適用するプレイブックエクスペリエンスを選択
   アプリケーション	アクションが適用されるアプリケーション
   アクティビティ定義	アクションを適用するアクティビティ定義を選択します

6. [送信] をクリックします。
7. [関連リンク] セクションで、[ Playbook Experience マッピング ] タブを選択します。
8. Playbook Experience がテーブルに追加されていることを確認します。

次のタスク

Playbook Experience を と統合 します ワークスペース。