カスタムプレイブックアクション

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

概要

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

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

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

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

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

デフォルトのアクション

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

アクション名	説明
スキップ 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_experience.admin

このタスクについて

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

手順

1. アクションを作成し、詳細を指定します。
   1. 次のように移動する。 プレイブックエクスペリエンス > アクション プレイブックアクション、 ステージアクション、または アクティビティアクション。
   2. アクションのアサインを選択するか、[ 新規 ] をクリックして新しいアクションアサインを作成します。
      注:

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

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

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

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

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

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

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

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

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

プレイブックアクションをプレイブックエクスペリエンスに適用する

デフォルトまたはカスタムのプレイブックアクションをプレイブックエクスペリエンスに適用します。

始める前に

必要なロール:playbook_experience_admin

手順

1. 次のように移動する。 All (すべて) > プレイブックエクスペリエンス > プレイブックエクスペリエンス.
2. [プレイブックエクスペリエンス] を選択します。
3. [アクションマッピング] 関連リストをクリックします。
4. [New] をクリックします。
5. フォームのフィールドに入力します。

   表 : 3. プレイブックエクスペリエンスアクション割り当てマップ

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

6. [Submit (送信)] を選択します。
7. 関連リンクセクションで、[ プレイブックエクスペリエンスマッピング ] タブを選択します。
8. プレイブックエクスペリエンスがテーブルに追加されたことを確認します。

次のタスク

プレイブックエクスペリエンスを ワークスペース と統合します。