Data Source Wizard について
学習の目的
この単元を完了すると、次のことができるようになります。
- 管理パッケージ用 Omnistudio の Flexcard を作成するために実行する Data Source Wizard のステップを挙げる。
- Flexcard の定義方法を説明する。
- データソース種別の選択方法を説明する。
- データソースの選択方法を説明する。
- データソース入力の設定方法を説明する。
Data Source Wizard で Flexcard を作成する
管理パッケージ用 Omnistudio で Flexcard を作成する場合、Data Source Wizard に次の一連のステップが表示されます。
- Flexcard を定義する。
- データソース種別を選択する。
- データソースを選択する。
- データソース入力を設定する。
この単元では、各ステップを見ていきます。
Flexcard を定義する
まず、Flexcard の名前、タイトル、作成者、説明、テーマなどの基本設定を行います。また、この Flexcard を子カードとして設定して、ほかの Flexcard に埋め込むこともできます。
名前と作成者の命名規則
管理パッケージ用 Omnistudio の Flexcard には、名前と作成者の厳格な命名規則が定められています。英数字とアンダースコアのみを使用し、スペース、ダッシュ、連続するアンダースコア、英数字以外の文字は使用しないでください。FlexCard 名には、キャメルケース、パスカルケース、またはスネークケースを使用することをお勧めします。
これらの命名規則に従った FlexCard 名の例は次のとおりです。
- キャメルケース:
teamAccount - パスカルケース:
TeamAccount - スネークケース:
team_account
こうしたガイドラインについての詳細は、Salesforce ヘルプの「Omnistudio for Managed Packages (管理パッケージ用 Omnistudio)」にある「Flexcard Naming Conventions (Flexcard の命名規則)」記事を参照してください。
タイトル
タイトルを設定すると、生成された Flexcard Lightning Web コンポーネントを Lightning アプリケーションビルダーとコミュニティビルダーで見つけることができます。
テーマ
Flexcard のテーマには 2 つのオプションがあります。
Salesforce Lightning Design System (SLDS) を使用する場合は [Lightning] を、Newport Design System を使用する場合は [Newport] を選択します。Newport は、デザイナーや Web 開発者向けの CSS フレームワークツールです。Omnistudio のすべての要素の外観を 1 か所で簡単に変更したり、今後すべてのページで使用できるように最適化されたカスタム CSS ファイルを作成したりすることができます。
Flexcard を保存すると、名前、作成者、テーマを編集できなくなります。編集を完了するには、Flexcard をコピーして、コピー作成時にこれらの設定を更新します。
データソース種別を選択する
Flexcard には、Salesforce オブジェクトや外部データソースからのデータ、またはサンプルデータが表示されます。データソース種別によって、Flexcard がデータを取得する方法が決まります。
ウィザードでは、各オプションが、どのような場合に選択するかの簡単な説明と共に表示されます。
このソースは、Flexcard を有効化する前であればいつでも更新できます。たとえば、Flexcard の作成とテストを行いながら、カスタムソースを選択したり、サンプルデータを使用したりできます。その後、Flexcard の準備が整ったら、ライブデータソースに接続します。
では、使用できるデータソースの種別を確認しましょう。
-
Apex REST は、Apex クラスの REST エンドポイントを使用してデータを返します。
-
Apex Remote は、Apex Remote クラスとメソッドを使用してデータを返します。
-
Custom は、サンプル JSON を使用して、最終的に別のデータソースに置き換えられる一時データで Flexcard を設定します。
-
SOQL Query は、Salesforce Object Query Language (SOQL) を使用して、組織の Salesforce データから特定の情報を検索します。たとえば、
SELECT Name, Id FROM Account LIMIT 5です。
-
SOSL Search は、Salesforce Object Search Language (SOSL) を使用して、検索インデックスにテキストベースの検索クエリを作成します。
-
Streaming API は、Salesforce ストリーミング API を使用して、Salesforce データの変更に関連付けられていない一般イベントの通知を送信します。
-
SDK はソフトウェア開発キット (SDK) のメソッドを使用してデータを取得し、Flexcard の項目に入力します。
また、Omnistudio データツールを使用することもできます。
-
Omnistudio Data Mapper は、Data Mapper Extract インターフェースを使用して Salesforce オブジェクトからデータを返します。
-
Integration Procedure は、Integration Procedure を使用して内部と外部の複数のソースからデータを返します。
Flexcard では、データソースに [None (なし)] を指定することもできます。親 Flexcard が親のデータソースのデータを子 Flexcard にプッシュするように設定されている場合、その子にはデータソースは必要ありません。子 Flexcard にデータソースがある場合は、親 Flexcard はデータソースを必要としないことがあります。
データソースを選択する
データソース種別を選択内容に応じて、データソース自体に表示するプロパティが決まります。たとえば、Integration Procedure を選択したとします。
使用する Integration Procedure を選択し、入力パラメーターを設定して、Integration Procedure に渡す変数を定義することで取得するデータを把握できるようにします。
この例では、Integration Procedure に取引先レコードの詳細を取得するように指示します。
データソース入力を設定する
このページでは、テスト変数を追加することで、実際のデータを使用して Flexcard をプレビューできます。Flexcard の作成を開始する前に、データソースからのテスト応答とパフォーマンスメトリクスを確認したり、JSON 形式で返されたデータをプレビューしたりできます。[Result JSON Path (結果の JSON パス)] (1) を絞り込むと、関連するデータのみが Flexcard に取り込まれます。
これで Data Source Wizard のすばらしい機能を理解できました。次は、データとアクションを Flexcard に表示する方法を見ていきましょう。