OmniScript Best Practices (管理パッケージ)

ビジネスプロセスとロジック

ビジネスプロセスとロジックのベストプラクティスは次のとおりです。

• OmniScript 要素と OmniStudio データマッパー応答ノードには一意の名前を使用します。
• OmniScript ごとに 1 人の所有者を使用します。
• OmniScript 全体のスケルトンを作成して、再利用可能な要素を特定します。
• 要素の [内部メモ] プロパティで要素の目的を文書化します。
• 要素名の変更を回避して、データ・マッパーとApexクラスを維持します。要素名を更新する必要がある場合は、名前の変更をデータマッパーまたは Apex クラスに適用します。
• OmniScript 内で ContextId を割り当てないようにします。OmniScript の ContextId は、URL からレコード ID を割り当てる予約キーです。
• 複数の OmniScript でプロセスを繰り返すことができる場合は、再利用可能な OmniScript を作成し、適切な親 OmniScript に追加します。

ユーザーインターフェース

LWC OmniScript では、Lightning Web コンポーネントを使用して、個々の要素と OmniScript 自体のスタイルを定義します。Angular OmniScript では、テンプレートを使用して OmniScript の外観を決定します。

Angular OmniScript UI のベストプラクティスを次に示します。

• テンプレートの CSS を編集して、Angular UI 要素をカスタマイズします。可能な限り、JavaScript と HTML の変更は避けてください。
• カスタムテンプレートは、静的リソースや Vlocity テンプレートなどの 1 つの場所に保存します。
• Newport Design System を使用して、グローバルブランドを適用します。

LWC OmniScript UI のベストプラクティスは次のとおりです。

• OmniScript 要素のコンポーネントを拡張してスタイル設定の変更を適用するカスタム Lightning Web コンポーネントを作成します。
• Newport Design System を使用して、グローバルブランドを適用します。

アクセシビリティ

アクセシビリティのベストプラクティスは次のとおりです。

• 現在、OmniScript のテーブルモードで設定された編集ブロックはスクリーンリーダーと互換性がありません。スクリーンリーダーを使用する場合は、OmniScript ではなく FlexCard を使用することをお勧めします。FlexCard では、スクリーンリーダーと互換性のあるデータテーブルまたは Lightning データテーブルを使用できます。「 Show Data in a Table on a Flexcard and Lightning Web Component – Datatable 」を参照してください。

ユーザーエクスペリエンス設計の原則

UX 設計の原則は次のとおりです。

• コンテキストデータを使用して項目を事前入力することで、ユーザーが情報を入力する必要がある項目の数を減らします。
• プロセスを最小限の要素を含む短いステップに分割することで、ユーザーを混乱させないようにします。
• コンテキストヘルプテキストを作成し、入力項目を論理的に並び替えてユーザーをガイドします。

パフォーマンス要素

クライアント側とサーバー側両方のパフォーマンスに関するベストプラクティスのセットが存在します。

クライアント側のベストプラクティスは次のとおりです。

• 可能な場合は、条件付きビュー、差し込み項目、数式を減らします。
• Response JSON を切り取って、応答の適用を高速化します。
• 要素名からスペースを削除して、OmniScript の読み込み時間を短縮します。
• スクリプトの要素数を最小限に抑えます。1 つの OmniScript は、埋め込み再利用可能な OmniScript を含めて 750 要素以下にする必要があります。たとえば、OmniScript に埋め込み OmniScript 参照を含む 500 個の要素 (250 個の要素を含む再利用可能な OmniScript など) がある場合、OmniScript は最大 750 個の要素に達しています。
• 可能な場合は、インテグレーション手順の条件ロジックやデータマッパーの数式を含め、サーバーでロジックを実行します。
• 時間追跡を有効にしてパフォーマンスをテストします。本番で時間追跡を使用していない場合、本番にリリースする前にこの機能を無効にします。
• 250KB を超える PDF の生成は遅い。1 MB を超える PDF は、生成に数分かかり、タイムアウトになることがあります。

サーバー側のベストプラクティスは次のとおりです。

• JSON 要求を切り捨てて、要求のペイロードサイズを減らします。
• 4 MBを超えるLightning Webコンポーネントを使用してOmniScriptを作成しないでください。プレビューで、4 MB を超える OmniScript に「OmniScript が無効であるか、リリースされていません。」というエラーが表示されます。OmniScript LWC をダウンロードしてサイズを確認します。
• 複数のアクションがステップ間で実行されるたびに Integration Procedure を使用して、サーバーの往復数を減らします。fire-and-forget プロパティを有効にして、インテグレーション手順を非同期で実行します。
• データマッパーの抽出出力を切り取って不要なデータを削除します。