アプリを設計する

各アプリにはさまざまなコンポーネントが含まれている場合があり、作成する機能に応じて、必須のコンポーネントと省略可能なコンポーネントがあります。

このセクションでは、各コンポーネントについて、必要な場所や使用目的など、詳細について説明します。また、さまざまなコンポーネントを使用したサンプル アーキテクチャの選択も含まれています。

アプリのコンポーネント

次のセクションでは、一般的なアプリ コンポーネントについて説明し、それらが必要な場所と理由について説明します。

アプリシェル [#app-shell-app-components]

• 必須: Answers チャットボット ブロック、Conversations コンテキスト カード、Moments フロー要素、マーケットプレースにリストされているすべてのアプリ
• 用途: 構成ページの表示、保存
• 概要: Exchange の [発行] タブにあるアプリに格納されているデータのコレクション

積荷目録 [#manifest-app-components]

• 必須: Answers チャットボット ブロック、Conversations コンテキスト カード、Conversationsフルページ アプリ、Moments フロー 要素
• 用途: アプリを Answers、Conversations、または Moments に接続し、ユーザー インターフェイスでアプリを正しく表示するために必要な情報を NTT CPaaS 製品に提供する
• 概要: アプリの API 構造またはコンテクストカードの場所を記述する JSON または YAML ファイル

コンテキスト カード UI ページ [#context-card-ui-page-app-components]

• 必須: Conversations コンテキスト カード、Conversations フルページ アプリ
• 用途:Conversations コンタクトセンターエージェントに役立つユーザーコンテンツを表示する。
• 概要:エージェントのConversationsダッシュボード内のiframeに表示されるWebサイト

API エンドポイント [#api-endpoint-app-components]

• 必須: Answers チャットボット ブロックとMoments フロー要素
• 用途: アプリで必要な関数を実行し、ユーザー アカウントのプロファイルと設定を照合し、プラットフォーム API エンドポイントへの要求を作成するために API ミドルウェアと組み合わせる場合があります
• 概要: API ミドルウェアまたは NTT CPaaS Exchange からアクセスできる API エンドポイント

API ミドルウェア [#api-middleware-app-components]

• オプション: すべての種類のアプリ
• 用途: Exchange からの要求を解釈し、最終的な API エンドポイント用にフォーマットしたり、データのフローを管理したりします。ミドルウェアは、アプリ設定データベースのデータを使用して、アカウントマッピングやその他のアカウントレベルの設定を処理できます
• 概要: NTT CPaaS Exchange からアクセスできる API エンドポイント

構成ページの UI [#configuration-page-ui-app-components]

• オプション: すべての種類のアプリ
• 用途: NTT CPaaS ユーザーのアカウントを外部プラットフォーム アカウントに接続したり、言語設定などのアカウント レベルの設定を収集したりするために一般的に使用される、アプリのアカウント レベル設定の収集に使用されます。
• 概要: Exchange マーケットプレース内の iframe に表示される Web サイト

アプリ設定データベース [#app-settings-database-app-components]

• オプション: すべての種類のアプリ
• 使用目的: 構成ページの UI で定義され、コンテクストカード UI または API ミドルウェアがアカウント設定を適用するために使用するアカウント レベル設定の格納
• 概要:アカウントマッピング、ユーザー設定などの情報を格納するデータベース

アプリ コンポーネントの要件

次の表では、各アプリ コンポーネントが既定で必要な場所と省略可能な場所について説明します。

サンプル アーキテクチャ

次の図は、さまざまな種類のアプリのサンプル アーキテクチャを示しています。

シンプルなConversations コンテクストカード [#simple-conversations-context-card-sample-architectures]

アカウント管理付きのコンテキスト カード [#context-card-with-account-management-sample-architectures]

シンプルなAnswers チャットボットブロック [#simple-answers-bot-block-sample-architectures]

ミドルウェアとアカウント管理によるAnswers チャットボットブロック [#answers-bot-block-with-middleware-and-account-management-sample-architectures]

Answers チャットボットブロックとConversations コンテクストカードをアカウント管理と組み合わせた複雑なアプリ [#complex-app-combining-an-answers-bot-block-and-conversations-context-card-with-account-management-sample-architectures]

People データとアカウント管理の同期 [#people-data-sync-with-account-management-sample-architectures]

シンプルなMoments - フロー エレメント [#simple-moments--flow-element-sample-architectures]

Moments - ミドルウェアとアカウント管理によるフロー エレメント [#moments--flow-element-with-middleware-and-account-management-sample-architectures]