シンプルな Omniscript を設定する
学習の目的
この単元を完了すると、次のことができるようになります。
- Omniscript の一意性について説明する。
- 管理パッケージ用 Omnistudio の Omniscript に Inputs を設定した Step を追加する。
- 要素プロパティを設定する。
- Omniscript のデータの入出力の流れについて説明する。
- Omniscript Action 要素を設定する。
このモジュールでは、受講者が管理パッケージ用 Omnistudio 開発者で、ここに記載の操作を実行する適切な権限を有すると想定しています。ただし、システム管理者でなくても問題ありません。このまま読み進み、本番組織で開発者が手順をどのように実行するのかを学習しましょう。Trailhead Playground で次の手順を実行しないでください。Trailhead Playground では管理パッケージ用 Omnistudio を使用できません。
Omniscript の一意性について
Omniscript の一意性は、Type (種別)、Subtype (サブタイプ)、Language (言語) で確定します。
同じ種別、サブタイプ、言語を使用する Omniscript を複数有効にすることはできません。必須事項ではありませんが、Omniscript の種別は小文字で始めることをお勧めします。
<img alt="Settings for creating a new Omniscript" class="image" src="images/kix.5np761y99751.jpg" width="600.0000000000001"/>
この例では、Omniscript の [Type (種別)] は team (1)、[SubType (サブタイプ)] は editAccount (2)、[Language (言語)] は English (3) になっています。Omniscript の名前は組織内で一意である必要はありません。この例では、Omniscript の [Name (名前)] は Edit Account (4) になっています。
Omniscript のバージョンは一度に 1 つのみ有効にできます。有効な Omniscript に変更を行う場合は、新しいバージョンを作成します。本番ですでに有効になっている Omniscript のバージョンは有効のままにして、新しいバージョンで作業を行うことができます。
この例では Team Edit Account Omniscript のバージョン 2 が有効になっています。この情報は Omniscript ヘッダーに表示されます。
<img alt="An Omniscript’s Version number and Active status displayed in the Omniscript Header" class="image" src="images/kix.imtgevgnz5q0.png" width="601.3333333333334"/>
Omniscript に Step と Inputs を追加する
Step はページを構成する方法です。Omniscript を作成したら、Step を設定します。
Inputs を設定した Step を Omniscript に追加するにはどうしたらよいのでしょうか? まず、前の単元の Edit Account Omniscript を確認します。
<img alt="Completed Edit Account design using the Omniscript Designer" class="image" src="images/kix.kssr118etzzt.png" width="912.0"/>
これはシンプルな 1 ステップの Omniscript です。作成するには、最初に 1 つの Step 要素とその入力項目を設定し、次に Actions 要素を追加します。
<img alt="Adding Text (Name), Telephone (Phone), and URL (Website) Inputs elements to a Step" class="image" src="images/kix.c8o7vnhndqxl.png" width="912.0"/>
- [Build (作成)] パネルから、キャンバスに <<strong>>Step</<strong>> 要素をドラッグします。
- Step に Inputs 要素をドラッグし、エンドユーザーに表示して、データを編集できるようにする項目を作成します。
- <<strong>>Text</<strong>> (1)
- <<strong>>Phone</<strong>> (2)
- <<strong>>URL</<strong>> (3)
- <<strong>>Text</<strong>> (1)
- URL 要素を選択し、[Properties (プロパティ)] タブの <<strong>>[Name (名前)]</<strong>> と <<strong>>[Field Label (項目表示ラベル)]</<strong>> に <<code>>Website</<code>> (Web サイト) と入力します。
素晴らしい! これで Omniscript に Step と Inputs が追加されました。次にプロパティの設定に進むことができます。
要素プロパティを設定する
多くの要素では同じ種別のプロパティが使用されています。たとえば、各要素には名前が必要です。
要素名は Omniscript 内で一意にする必要があります。その他に次のようなガイドラインがあります。
- 要素名にはパスカルケースを使用し、空白を入れません (例: <<code>>StepAccount</<code>>)。
- 明確にするためにオブジェクト名と項目名を使用します (例: <<code>>AccountName</<code>>)。
- ID を表すオブジェクトを指定します (例: <<code>>AccountId</<code>>)。
Display または Inputs 要素の場合、要素の表示ラベルはエンドユーザーの画面に表示されます。Actions 要素の場合、要素の表示ラベルは [Action Debugger (アクションデバッガー)] に表示されます。表示ラベルは一意にする必要はありません。
では、Edit Account Omniscript でこれらの機能を設定するために使用された要素プロパティを見てみましょう。
<img alt="An end user’s view of an interaction" class="image" src="images/kix.ydrynk5in6m1.png" width="417.3333333333333"/>
- [Name (名前)] 項目 (1) はユーザーが Salesforce の取引先レコード以外で取引先名を変更できないように参照のみ項目になっています。
- [Phone (電話)] 項目 (2) は必須項目で、赤のアスタリスクでマークされています。
- [Name (名前)]、[Phone (電話)]、[Website (Web サイト)] の各項目は行幅いっぱいには表示されません。
以上の動作を設定するにはどうすればよいのでしょうか?
|
プロパティ
|
有効化方法
|
動作
|
|---|---|---|
Read Only (参照のみ) |
チェックボックスを選択する。 |
ユーザーが項目を変更できないようにします。 |
Required? (必須?) |
チェックボックスを選択する。 |
エンドユーザーがこの項目にデータを入力しなければ先に進めないようにします。 |
Width Settings (幅設定) |
キャンバスで、反応型コントロール幅グリッドをドラッグする。 |
HTML Web 標準 (ダイナミックコントロール) を使用して項目のサイズを調整します。 |
Inputs 要素の設定を終えたら、Actions 要素の追加に進むことができます。その前に、Omniscript にデータがどのように入出力するのか説明しておきましょう。
Omniscript のデータの入出力の流れ
Omniscript へのデータ入力には複数のオプションがあります。ベストプラクティスは Integration Procedure を使用することです。その理由は「Omnistudio Integration Procedure」モジュールで詳しく説明していますが、Integration Procedure を使用すると、データ設定を Omniscript 設定から切り離すことができます。
その他のデータ入力オプションを使用するシナリオは次のとおりです。
|
データ入力ソースの種類
|
<<strong>>使用する </<strong>><<strong>>Omniscript</<strong>><<strong>> 要素</<strong>>
|
|---|---|
Salesforce 組織: 1 つの項目のみ |
Lookup: Inputs セクションにあり、Omnistudio Data Mapper Extract サービスを使用 |
Salesforce 組織: 1 つのオブジェクトのみの項目 |
Omnistudio Data Mapper Turbo Action |
Salesforce 組織: 1 つ以上の関連オブジェクトからの項目 |
Omnistudio Data Mapper Extract Action |
API |
HTTP Action |
Apex がアクセスできるデータ |
Remote Action |
ユーザー |
任意の Inputs 要素: Inputs セクションにあり、ユーザーによるデータ入力可 |
では Integration Procedure を使用して Salesforce から Omniscript にデータを移動するにはどうしたらよいのでしょうか? Omniscript が Flexcard のアクションから起動されると、ノードの JSON と共に RecordId が渡され、取得するレコードのデータが識別されます。このグラフィックでは、RecordId が AccountId になっています。「AccountId」は任意の名前ですが、適切にデータが流れるようにするには、各要素で同じ名前を使用する必要があります。
<img alt="Data flow from a Flexcard to an Omniscript" class="image" src="images/kix.t64u35cllq2z.png" width="576.0"/>
変数が Omniscript に保存されたら、AccountId 変数で RecordId を、使用する予定のデータツールに渡します。ベストプラクティスに従い、Integration Procedure を選択して AccountId を Omnistudio Data Mapper Extract に渡します。
Omnistudio Data Mapper Extract は Salesforce Object Query Language (SOQL) クエリで AccountId 変数を使用して Salesforce からデータを取得します。この取得されたデータには、AccountId 変数と取引先レコードのデータが含まれます。Omnistudio Data Mapper Extract はこのデータをデータ JSON に対応付けます。このデータ JSON が Integration Procedure に送信され、さらに Omniscript に送信されます。
Omniscript はパーサーを使用して、要素名に基づいて Integration Procedure から取得した JSON と Omniscript の入力項目を照合します。JSON が要素名と一致しない場合、項目には空白が表示されます。
データフローは次のようになります。
<img alt="Data flow from an Omniscript to a data tool that extracts data from Salesforce" class="image" src="images/kix.ksc931fsh6jg.png" width="912.0"/>
Omniscript の実行中にユーザーと他の Omniscript アクションによってデータが操作されます。
AccountId 変数を含む更新されたデータ JSON が Integration Procedure に渡され、Integration Procedure から Omnistudio Data Mapper Load にこの AccountId 変数を含む JSON が渡されます。Omnistudio Data Mapper Load は AccountId 変数を使用して元の取引先レコードを識別し、Salesforce 内のデータを更新します。
<img alt="Data flow from an Omniscript to a data tool that saves data to Salesforce" class="image" src="images/kix.pa0zn2sydr61.png" width="864.0"/>
ユーザーが行うのは、Flexcard から Omniscript へ、Omniscript から Salesforce へとデータが適切に流れるように Action 要素を設定することです。
Omniscript Action 要素を設定する
Omniscript Action 要素を設定するために、キャンバスに戻ります。しくみを理解するために、2 つの Integration Procedure Action が設定されている例を見てみましょう。
<img alt="Two Integration Procedure Actions with one placed before and one after the Step element" class="image" src="images/kix.yuho6fauvyit.png" width="653.3333333333334"/>
- [Build (作成)] パネルからキャンバスに Integration Procedure Action (1) をドラッグします。この Integration Procedure Action で、データを取得する Integration Procedure がコールされます。Step 要素の上に Integration Procedure Action (2) を配置します。
- データを保存する Integration Procedure をコールするために、[Build (作成)] パネルからキャンバスに Integration Procedure Action (3) をドラッグします。これを Step 要素の下に配置します。
Step の外部に配置する場合は、Action は表示されている順番で自動的に実行されます。Step の内部に配置する場合は、Action はボタンとして表示され、実行するにはクリックする必要があります。
Action には独自の命名規則があります。要素種別のプレフィックス (Omnistudio Data Mapper の DR、Integration Procedure の IP など) を使用します。そして VerbObjectDetail を使用します。Edit Account Omniscript の場合、IPGetAccountDetails が Step の上の Integration Procedure Action (2) の名前で、IPSaveAccountDetails が Step の下の Integration Procedure Action (3) の名前です。
各 Integration Procedure Action にはドロップダウンリストがあり、Omniscript からコールする Integration Procedure を選択できます。Integration Procedure を Omniscript にリンクすると、デフォルトで Omniscript から Integration Procedure に JSON 全体が送信されます。
Edit Account Omniscript のように JSON が小さければ、トリミングや再定義は必要ありません。ただし、ContextID がその JSON に含まれていることを確認する必要があります。たとえば、Edit Account Omniscript の場合、ContextId が AccountId であることを Integration Procedure に指定する必要があります。
「AccountId」は任意の名前ではないかと疑問に思っている方もいらっしゃるかもしれません。確かにそのとおりです。その場合でも、Integration Procedure にどのような RecordId を送信するかを明示的に指定するというベストプラクティスに従うことが重要です。
エンドユーザーが Omniscript に入力すると、Navigate Action はエンドユーザーの移動先を Omniscript に指示します。担当者がコンソールの Flexcard から Omniscript を開く場合、担当者をコンソールに戻すように Navigate Action を設定できます。
Navigate Action を追加し、Omniscript をプレビューしたら、Omniscript を有効にしてください。
これで完了です。エンドユーザーのプロセスをガイドする Omniscript の機能だけでなく、シンプルな 1 ステップ Omniscript を作成する方法も学習しました。
リソース
- Salesforce ヘルプ: Administering, Deploying, and Launching Omniscripts (Omniscript の管理、リリース、起動) (管理パッケージ)
- Salesforce ヘルプ: Omniscript Data and External Integrations (Omniscript データと外部のインテグレーション) (管理パッケージ)
- Trailhead: 管理パッケージ用 Omnistudio の分岐 Omniscript
- Trailhead: 管理パッケージ用 Omnistudio の Integration Procedure