Vault Java SDK を使用すると、Vault から Vault へのカスタムインテグレーションを作成してさまざまな Vault 全体でのビジネスプロセスを自動化することができます。Vault UI で、インテグレーションオブジェクトレコードを設定して、企業管理者へのインテグレーションの事業目標を表示することができるため、企業管理者がインテグレーションを管理しやすくなります。例えば、企業管理者はインテグレーションのオンとオフを切り替えることができます。
このページには、2 つの Vault 間のインテグレーションに固有の情報が含まれます。インテグレーションオブジェクトは、ローカルまたは外部接続タイプには対応していません。
注: この機能は非常に複雑です。カスタマーサクセスマネージャーまたは Veeva サービスと設定作業を行うことを強くお勧めします。
インテグレーション管理へのアクセス
管理者 > 接続からインテグレーションの表示と管理を行います。ここで、Vault から Vault へのインテグレーションタイプとの各接続レコードのインテグレーションを表示することができます。このタブの接続にアクセスするには、アプリケーション: 接続の管理権限が付与されたセキュリティプロファイルが必要です。
ユーザ例外メッセージ、統合ルールなど、接続以外の統合関連アイテムにアクセスし、現在 Vault にデプロイされている Spark メッセージプロセッサを表示するには、アプリケーション: 統合の管理権限が必要です。
SDK インテグレーション概要
2 つの Vault 間のインテグレーションによって、これまで手動で行っていたビジネスプロセスが自動化できます。例えば、Vault QMS の新しいイベントの変更レコードは、Spark メッセージを Vault Registrations に送信します。このメッセージは、Vault Registrations のレギュラトリ―に関する一連のアクティビティを開始し、また変更イベントに関する必須情報について Vault QMS にコールバックすることもできます。
2 つの Vault 間にインテグレーションを作成するには、それらに接続レコードを設定する必要があります。このレコードには 2 つの Vault が通信できるようにするアグリーメントが含まれます。詳しくは、接続の設定をご覧ください。
2 つの Vault 間に接続が作成できたら、接続にインテグレーションとインテグレーションポイントのレコードを設定することができます。これらのオブジェクトと提供される機能が本記事の焦点です。
開発者は Vault Java SDK を使い、2 つの Vault 間のインテグレーションにビジネスロジックを構築します。インテグレーションコードは、接続、インテグレーション、およびインテグレーションポイントのオブジェクトを参照します。開発者ポータルで SDK インテグレーションのコーディングの詳細をご覧ください。
インテグレーションおよびインテグレーションポイントについて
根本的に、インテグレーション (integration__sys) オブジェクトは、インテグレーションポイント (integration_point__sys) レコードに関する独立した自立型の集団です。インテグレーションポイントは、単一の目標またはインテグレーションフローの「ポイント」を表します。インテグレーションは、多くのインテグレーションポイントを持つことができますが、単一のインテグレーションポイントは 1 つのインテグレーションにしか属すことができません。
インテグレーションとポイントはインテグレーションに必須ではありませんが、それらを使用するとさまざまなメリットがあります。例えば、管理者は、インテグレーションに関連付けられたインテグレーションポイントを表示して、Vault の設定や SDK コードを調べることなくその目標とフローを理解することができます。例: 新規変更管理レコードの作成処理。
インテグレーションポイントでは、ユーザ例外メッセージも使用することができます。これらのカスタム例外は、Vault Java SDK 開発者によってコード化され、Vault 管理者はよくあるインテグレーションエラーをトラブルシューティングすることができます。例えば、必須フィールドがないため、インテグレーションによって変更管理レコードが新規作成できなかった場合、企業管理者にこの情報を表示してエラーを修正してもらうことができます。
インテグレーションオブジェクトの作成方法
接続にインテグレーションレコードを作成するには:
- 管理者 > 接続から、インテグレーションレコードを作成したい接続を選択します。
- インテグレーションをクリックしてセクションを展開したら、作成をクリックします。
- このインテグレーションの名前を入力します。これは管理者 UI に表示されます。
- インテグレーションAPI 名を入力します。このようにして、開発者はJava SDK または API 経由でこのインテグレーションを参照します。小文字、英数字、アンダースコア (_) のみが許可され、名前はアンダースコアで開始または終了することはできません。
- インテグレーションのステータスを有効または無効のいずれかに設定します。カスタムインテグレーションの構築時に、開発者はこのステータスを使用してビジネスロジックを実行する必要があります。例: このステータスにロジックを追加してインテグレーションのオン/オフの切替えを制御する。デフォルトでこの設定は影響がありません。
- 任意の作業: インテグレーション詳細にリモート Vault のインテグレーションレコードへのリンクを含めたい場合は、リモート Vault インテグレーション名を入力します。これはリンクのラベルです。次に、リモート Vault インテグレーションID を入力します。これは、リモート Vault のインテグレーションレコードの ID 値です。
- 保存をクリックします。
インテグレーションレコードを作成したら、インテグレーションポイントを作成することができます。
インテグレーションポイントの作成方法
インテグレーションにインテグレーションポイントを作成するには:
- 管理者 > 接続から、インテグレーションポイントを作成したいインテグレーションを含む接続を選択します。
- インテグレーションをクリックしてセクションを展開したら、インテグレーションポイントを作成したいインテグレーションを選択します。
- インテグレーションポイント - 送信またはインテグレーションポイント - 受信のいずれかのセクションを展開します。
- このインテグレーションポイントの名前を入力します。これは管理者 UI に表示されます。
- インテグレーションAPI 名を入力します。このようにして、開発者はJava SDK または API 経由でこのインテグレーションポイントを参照します。小文字、英数字、アンダースコア (_) のみが許可され、名前はアンダースコアで開始または終了することはできません。
- このインテグレーションポイントの説明を入力します。これは、インテグレーションにおけるこのポイントに関連付けられたビジネスプロセスまたはインテグレーション目標を説明するものとします。
- インテグレーションのステータスを有効または無効のいずれかに設定します。カスタムインテグレーションの構築時に、開発者はこのステータスを使用してビジネスロジックを実行する必要があります。デフォルトでこの設定は影響がありません。
- 保存をクリックします。
ユーザ例外メッセージについて
管理者 > 接続 > ユーザ例外メッセージから、インテグレーションによって生成されたユーザ例外メッセージを表示できます。
Vault には、ユーザ例外メッセージオブジェクトとその子オブジェクトのユーザ例外項目が含まれているため、企業管理者はインテグレーションで発生するエラーを追跡・解決することができます。Vault Java SDK 開発者は、これらのオブジェクトを Spark メッセージプロセッサ内に使用して、これらのカスタム例外メッセージを作成します。
例えば、インテグレーションの両端で受信メッセージの処理に失敗した場合、カスタム SDK ロジックはユーザ例外メッセージを作成し、失敗を取得して企業管理者に情報を表示します。このレコードには、トラブルシューティングの方法、必要なアクション、問題が解決しない場合の連絡窓口などの情報を含めることができます。
新規ユーザ例外メッセージがあった場合に、常に特定のユーザまたはグループにシステムメッセージを送信したい場合は、ユーザ例外メッセージオブジェクトにカスタムライフサイクルを作成し、システムメッセージエントリアクションを設定する必要があります。
ユーザ例外メッセージは、個別のインテグレーションポイントに紐づけられます。このため、インテグレーションとインテグレーションポイントを設定しない場合はユーザ例外メッセージを使用できません。
統合ルールについて
Spark 統合ルールによって、開発者は、設定可能なルールを Spark メッセージプロセッサに統合して、2 つの Vault 間のオブジェクトやドキュメントフィールドのマッピングに使用することができます。詳しくは、統合ルールの作成および管理をご確認ください。
Spark メッセージプロセッサ
管理者 > 接続 > Spark メッセージプロセッサを選択すると、Vault に現在展開されているすべての Spark メッセージプロセッサを表示できます。
Spark メッセージプロセッサは、Spark メッセージを処理するためのロジックを提供します。例えば、受信メッセージに対して実行する操作を提供するには、すべてのインバウンドキューに Spark メッセージプロセッサを含める必要があります。
- 名前: Spark メッセージプロセッサの名前。
- ソース: この Spark メッセージプロセッサのソース。カスタムは、この が Vault Java SDK で作成されたことを意味します。
- オペレーティングステータス: この Spark メッセージプロセッサのステータス: 有効または無効。無効プロセッサをインバウンドキューに割り当てることはできますが、メッセージを処理できるのは有効プロセッサのみとなります。
Spark メッセージデリバリイベントハンドラ
管理者 > 接続 > Spark メッセージデリバリイベントハンドラ選択すると、Vault に現在展開されているすべての Spark メッセージデリバリイベントハンドラを表示できます。
これらは、管理者と Spark インテグレーション開発者が未配信の Spark メッセージを処理するためのメカニズムを提供します。送信キュー用に設定されると、Vault はハンドラロジックを実行します。例えば、ターゲット Vault が使用できない場合、ハンドラはメッセージを 24 時間以内にキューに戻したり、特定のユーザに通知したり、その他のアクションを実行したりする場合があります。
- 名前
- ハンドラの名前。
- ソース
- ハンドラのソース。カスタムは、このハンドラが Vault Java SDK で作成されたことを意味します。
- 業務ステータス
- ハンドラのステータス: 有効または無効。