カスタムプレイブックアクティビティ UI の作成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:7分
  • プレイブックアクティビティのカスタムアクティビティ UI を構築します。

    プレイブックアクティビティのデフォルトのユーザーエクスペリエンスを上書きする UI ビルダー を使用して、独自のアクティビティ UI を作成します。 UI ビルダー は、カスタムアクティビティ UI をビルドおよび更新するためのローコード環境を提供します。複数の UI ビルダー コンポーネントを 1 つのプレイブックアクティビティに結合できます。 UI ビルダー では、カスタマイズ可能なテンプレートとしてすぐに利用可能なアクティビティ UI を使用します。

    UI ビルダーを使用して、プレイブックエクスペリエンス内のアクティビティのユーザーエクスペリエンスをカスタマイズします。UI ビルダー では次の操作を実行できます。
    • カードのシェルを含む空の UI テンプレートから新しいアクティビティを構築します。
    • カードのシェル内のコンテンツを含む既存の UI テンプレートから新しいアクティビティをビルドします。
    • プレイブックアクティビティエクスペリエンスプロパティをデータバインディングを使用してコンポーネントにマッピングします。
    • どのアクティビティ UI をどのアクティビティで使用するかを指定するためのルールを定義します。
    • 基になるプロセスの実行時に、アクティビティエクスペリエンスプロパティへのリアルタイムの変更を反映します。

    プレイブックのカスタムアクティビティ UI を作成する

    プレイブックアクティビティのカスタムアクティビティ UI を UI ビルダー 内に作成します。

    始める前に

    必要なロール:playbook admin

    手順

    1. 移動先 すべて > プレイブックエクスペリエンス > アクティビティ UI.
    2. [新規] を選択します。
    3. フォームのフィールドに入力します。
      表 : 1. プレイブックアクティビティ UI フォーム
      フィールド 説明
      名前 アクティビティ UI の名前。
      プレイブックエクスペリエンス アクティビティ UI を使用するプレイブックエクスペリエンスを選択します。[グローバルプレイブックエクスペリエンス] を選択して、アクティビティ UI をすべてのプレイブックエクスペリエンスで利用できるようにします。
      エクスペリエンスタイプ アクティビティ UI に適用するエクスペリエンスタイプを選択します。エクスペリエンスタイプの詳細については、「 エクスペリエンスタイプ」を参照してください。
      UI テンプレート アクティビティ UI 用にクローンを作成する UI テンプレートを選択します。UI テンプレートが選択されていない場合は、 空白 のテンプレートが適用されます。アクティビティ UI のエクスペリエンスタイプとは異なるエクスペリエンスタイプの UI テンプレートを選択した場合、追加の変更がないと完全な互換性がない場合があります。
    4. [送信] を選択します。
    5. 作成したアクティビティ UI をリストから選択します。
    6. [プレイブックアクティビティの上書き] テーブルで [新規] を選択します。
      新規 を選択して、アクティビティの上書きを作成します。
    7. アクティビティ上書きフォームに入力して、アクティビティ UI がデフォルトのアクティビティ UI を上書きするタイミングを指定します。
      詳細については、「Playbook アクティビティの上書きのセットアップ」を参照してください。
    8. UI ビルダーで [Edit (編集)] を選択します。
      UI ビルダーでアクティビティ UI を編集します。

    タスクの結果

    UI ビルダー が新しいタブで開き、アクティビティ UI が表示されます。UI ビルダーを使用してカスタムアクティビティ UI を変更します。詳細については、「UI Builder」を参照してください。

    UI ビルダーアクティビティの UI エディター。

    でのアクティビティ UI の構成 UI ビルダー

    アクティビティ UI は、次の方法で UI ビルダー でカスタマイズできます。

    での UI テンプレートの使用 UI ビルダー

    アクティビティ UI は、カスタムアクティビティ UI の作成時に選択した UI テンプレートとして UI ビルダーで開きます。各 UI テンプレートには、 UI ビルダー内でカスタマイズできる事前構成済みのコンポーネントが含まれています。たとえば、デフォルトのアクティビティ UI には、次のサポートが含まれています。
    • リッチテキストの説明
    • レコードフィールドの積み重ねラベル値ペア
    • チェックリスト (選択されている [チェックリストの表示] エクスペリエンスプロパティが条件)
    • フォーム
    • 添付ファイル
    • フッター
    UI ビルダーのデフォルトのアクティビティ UI テンプレート。
    UI テンプレートを選択しなかった場合、カードの外部シェルを含む空のプレイブックカードが表示されます UI ビルダー 。空のテンプレートを含むすべてのテンプレートには、次のものが含まれます。
    • アクティビティラベル
    • アクティビティ状況
    • SLA タイマー
    • フッター
    • 宣言アクション
    UI ビルダーの空のアクティビティ UI テンプレート。

    すぐに利用可能なアクティビティ UI

    プレイブックには、次のアクティビティ UI が含まれています。

    デフォルト
    デフォルトのアクティビティ UI テンプレート
    リスト
    リストアクティビティ UI テンプレート
    ナレッジ
    ナレッジアクティビティ UI テンプレート
    レコードジェネレータ
    レコードジェネレーターアクティビティ UI テンプレート

    アクティビティ UI にコンテンツを追加する

    [コンテンツ] パネルには、アクティビティ UI のコンポーネントが表示されます。すべてのアクティビティ UI には、アクティビティ UI 全体をラップする最も外側のコンポーネントとしてプレイブックカードコンポーネントが含まれています。

    どのプレイブックカードスロットにもコンポーネントを追加できます。
    プレイブックカードスロット Description (説明)
    コンテンツ プレイブックカードに表示する一般的なコンテンツを追加します。
    フォーム フォームスロットは、プレイブックフォームコンポーネント用に予約されています。フォームが大きすぎてプレイブックカード内に収まらない場合、フォームはモーダルに表示されます
    フォームの下 フォームの下に表示するコンテンツを追加します。
    フッター カードフッターに表示するコンテンツを追加します。

    アクティビティ UI へのデータのバインド

    UI ビルダー でデータバインディングを使用して、プレイブックエクスペリエンスプロパティをアクティビティ UI にバインドします。これらのプレイブックエクスペリエンスデータリソースは、アクティビティ UI のコンポーネントにデータを動的に公開します。

    各アクティビティ UI には、 プレイブックによって実行時にアクティビティに渡されるエクスペリエンスプロパティのコレクションを定義するエクスペリエンスタイプがあります。たとえば、レコードエクスペリエンスタイプには、プレイブックアクティビティに表示されるフォームを指示するフォームビューエクスペリエンスプロパティが含まれています。

    データバインディングは、UI ビルダー の構成パネルの [構成] タブにあります。UI ビルダーコンポーネントにバインドされたプレイブックエクスペリエンスプロパティ。

    たとえば、このリッチテキストコンポーネントの HTML プロパティは、description エクスペリエンスプロパティにバインドされています。データバインディングの形式は @context.props.experienceProperties.description.value です。説明エクスペリエンスプロパティが変更されると、このコンポーネントはその新しい値を反映して更新されます。

    UI ビルダー 入力時にオートコンプリート値を提供し、適切なエクスペリエンスプロパティに誘導します。アクティビティ UI に選択したエクスペリエンスタイプに合わせてオートコンプリート UI ビルダー エクスペリエンスプロパティ。エクスペリエンスプロパティがエクスペリエンスタイプに追加されると、自動的に表示されます。

    experienceProperties に加えて、@context.props オブジェクトには、activityState や parentTable など、バインドできるその他の便利なデータが含まれています。「@context.props」と入力して、何が使用可能かを確認します。

    UI ビルダー のデータバインディングの詳細については、「UI ビルダーのデータリソース」を参照してください。

    内のカスタムアクティビティ UI のプレビュー UI ビルダー

    カスタムアクティビティ UI を UI ビルダー でプレビューします。サンプルデータを提供して、実行中のプレイブックでコンポーネントがどのように表示されるかをプレビューできます。

    始める前に

    必要なロール:プレイブックアドミンまたはアクティビティ作成者

    このタスクについて

    UI ビルダー で作成したアクティビティ UI をプレビューします。サンプルデータを変更して、実行中のプレイブックでアクティビティがどのように表示されるかをプレビューします。このタスクの構成パネルで行った変更は、実行時のアクティビティ UI には影響しません。UI ビルダー内のプレビューにのみ影響します。各エクスペリエンスプロパティの実行時のデフォルト値は、エクスペリエンスプロパティの作成時に設定されます。

    手順

    1. 移動先 すべて > プレイブックエクスペリエンス > アクティビティ UI.
    2. プレビューするアクティビティ UI を選択します。
    3. UI ビルダーで [Edit (編集)] を選択します。
    4. コンテンツパネルで [本文 ] を選択します。
      本文には、デモデータでカスタマイズできる値が含まれています。
    5. 構成パネルで [構成] タブを選択します。
      [構成] タブには、アクティビティをプレビューするためにカスタマイズできるプロパティが表示されます。
    6. [エクスペリエンスのプロパティ] フィールドで [編集] を選択します。
      エクスペリエンスプロパティは、実行時に プレイブック が提供するコンテンツを定義します。提供されたサンプルデータを変更して、アクティビティ UI をプレビューできます。このデータをカスタマイズしても、実行中のプレイブックでアクティビティ UI に表示される内容には影響しません。
    7. エクスペリエンスプロパティ JSON を編集します。
    8. [適用] を選択します。
      エクスペリエンスのプロパティをカスタマイズし、UI ビルダーでアクティビティをプレビューします。
    9. [ 構成 ] タブの他のプロパティを変更して、アクティビティ UI をカスタマイズできます。

      たとえば、 activityState を変更して、保留中または完了状態のアクティビティをプレビューできます。でさまざまなアクティビティ状況をプレビューできます UI ビルダー

    10. [保存] を選択します。

    タスクの結果

    UI ビルダーには、[構成] タブで行った変更が表示されます。