動的フィールドマッピング ​

動的フィールドマッピングにより、Embedパートナーはサードパーティシステム間のマッピングをサポートするようにレシピを設定できます。 Embedded顧客は、通常はパートナーのプラットフォーム内で、レシピビルダーの外部でフィールドをマッピングできます。 この機能により、エンドカスタマーはコアレシピロジックを変更せずに、ソースステップから宛先ステップへ標準フィールドまたはカスタムフィールドをマッピングできます。

動的フィールドマッピングは、主に次の2つのコンポーネントで構成されます:

• 動的マッピングレシピ設定: 各レシピアクションステップ内のトグルにより、そのステップのフィールドマッピングを有効にします。 マッピングされたデータのソースとして、先行するステップを選択します。 レシピ内の各アクションでは、すべてのコネクターで動的マッピングを使用できます。

レシピエディター内の動的フィールドマッピング

• field map schemaおよびfield map introspection API: field map schemaは、JSON形式でマッピングされたフィールドを定義します。 動的マッピングを含む各アクションステップには、一意のスキーマがあります。 これらのAPIを使用して、イントロスペクションデータの取得、ソーススキーマおよびターゲットスキーマの取得、フィールドマップスキーマの更新を実行できます。 これにより、パートナーは自社製品内にカスタムマッピングインターフェイスを構築できます。

フィールドマップスキーマ

動的フィールドマッピングの設定 ​

動的フィールドマッピングを設定するには、次の手順を実行します:

レシピで動的フィールドマッピングを有効にした後、事前構築済みの動的フィールドマッピングウィジェットまたはフィールドマップイントロスペクションAPIを使用して、マッピングインターフェイスを構築できます。

ロールと権限 ​

システムAdminロールを持つユーザーは、デフォルトでこの機能を使用できます。 カスタムロールの場合は、アクセス権を付与するために権限を更新する必要があります。

必要なロール権限

独自のマッピングエクスペリエンスの作成 ​

埋め込みインテグレーションで動的フィールドマッピングをサポートするには、次のいずれかの方法を選択します:

• 事前構築済みの動的フィールドマッピングウィジェットを使用する
• APIを使用して独自のウィジェットを構築する

事前構築済みの動的フィールドマッピングウィジェットを使用する ​

事前構築済みウィジェットを使用すると、最小限の設定で製品に動的フィールドマッピングを埋め込むことができます。 このウィジェットにはマッピングロジックとユーザーインターフェイスが含まれているため、カスタムソリューションを作成する必要がなくなります。

設定手順については、iframeタイプ別にURLを構築するセクションを参照してください。

APIを使用して独自のウィジェットを構築する ​

カスタムマッピングインターフェイスを構築するには、次のAPIエンドポイントを使用します:

• レシピ内のフィールドマップイントロスペクション | GET /api/v2/managed_users/:managed_user_id/recipes/:id/field_map_introspections
• フィールドマップイントロスペクション | GET /api/v2/managed_users/:managed_user_id/recipes/:id/field_map_introspections/:id
• Field mapsイントロスペクションを更新 | PUT /api/v2/managed_users/:managed_user_idrecipes/:id/field_map_introspections/:id
• Field mapsイントロスペクションのレシピのスキーマを更新 | POST /api/v2/managed_users/:managed_user_id/recipes/:id/field_map_introspections/:id/refresh_schema
• レシピのField mapsイントロスペクションのpick_listを取得 | POST /api/v2/managed_users/:managed_user_id/recipes/:id/field_map_introspections/:id/pick_list

必須フィールドマッピングエンドポイント

動的フィールドマッピング機能へのアクセスが必要な場合は、これらのエンドポイントを含めるようにAPIクライアントロールを更新します。

動的フィールドマッピングに関する考慮事項 ​

動的フィールドマッピングは、ほとんどのフィールドタイプの調整をサポートしています。 マッピングエクスペリエンスを構築する際は、次の要素を考慮してください:

• 複雑なデータ構造: 動的フィールドマッピングは、配列フィールドや複雑なデータ変換をサポートしていません。
• スキーマ整合性: プラットフォームは、extends_schema: trueでマークされたフィールドなど、スキーマを大幅に変更するマッピングをブロックします。 これにより、データの一貫性とインテグレーションの安定性が確保されます。
• マッピングタイプ: サポートされるマッピングタイプには、map、static、nullify、skipがあります。
• 分離されたロジック: レシピライフサイクルマネジメントは、動的フィールドマッピング設定のエクスポートとインポートをサポートしています。 ただし、フィールドマップスキーマはマニフェストから除外されます。 フィールドマップIDは、レシピライフサイクルマネジメントでインポートされた新しいレシピバージョン間で一貫して維持されます。
• 活動監査: フィールドマップスキーマに対するすべての更新は、ワークスペースの活動監査ログに表示されます。
• 結合ポイント: 動的フィールドマッピングは、結合ポイントを介して接続されたデータを表示しません。 結合ポイントは、次のコネクターにのみ存在します: active_reg_online、bamboohr、bill、fresh_desk、infusionsoft、intacct、quickbooks、replicon、salesforce、service_now、tsheets、zendesk。