構成移行パッケージを使用すると、2 つの Vault 間で設定変更およびテストデータを移行することができます。この機能は、組織が Sandbox 環境の Vault で設定とテストを行い、設定を本番環境の Vault に移行する場合に非常に便利です。この例では、Sandbox 環境の Vault の送信パッケージの作成およびエクスポート、パッケージのインポート、レビュー、本番環境の Vault での展開を行います。

構成パッケージを有効化する方法

管理者 > 設定 > 全般設定からこの機能を有効にできます。設定が 2 つあります:

  • 送信パッケージの許可: この設定はソース Vault で有効でなければなりません。この設定により管理者 > 展開タブが表示されます。
  • 受信パッケージの許可: この設定はターゲット Vault で有効でなければなりません。この設定により管理者 > 展開タブが表示されます。

有効化したら、一旦ログアウトして再度ログインすると展開タブが表示されます。

送信パッケージタイプについて

移行パッケージまたはテストデータパッケージのいずれかの作成を選択できます。

  • 移行パッケージには、コンポーネント、データ、および Vault Java SDK コードを含めることができ、設定および参照オブジェクトデータをある Vault から別の Vault に移行できます。
  • テストデータパッケージにはデータのみが含まれており、特に Sandbox Vault をリフレッシュする際のオブジェクトデータ保護に便利です。

パッケージを作成およびエクスポートする方法

送信パッケージを作成するには、現在の Vault から構成要素をエクスポートします。送信パッケージを作成するには:

  1. 管理者 > 展開 > 送信パッケージに移動し、作成をクリックします。
  2. 送信パッケージタイプを選択します。詳細は送信パッケージタイプを参照してください。
  3. ユーザがこのパッケージの目的と内容を理解するために役立つ概要を入力します。
  4. 任意の作業: ユーザを所有者として選択します。この欄を空白にすると、デフォルトで自分が所有者に設定されます。パッケージをインポートする際に、パッケージに関して不明な点があった場合に連絡する担当者が分かるように所有者情報がターゲット Vault に表示されます。
  5. 移行パッケージの場合はオプションです: ターゲット Vault を選択します。このオプションは、Vault がターゲット Vault に対してパッケージの依存関係をチェックすることを可能にします。ターゲット Vault として、親プロダクション Vault と親、子、兄弟の Sandbox Vault を選択できます。
  6. 保存をクリックします。Vault のパッケージ詳細ページが開きます。
  7. 移行パッケージの作成を選択した場合、コンポーネントセクションに進みます。追加をクリックして、このパッケージのコンポーネントを指定します。ダイアログで、チェックボックスを使用してコンポーネントを追加または削除します。1 つのパッケージに最大 200 のコンポーネントを追加することができます。
  8. データセクションに進みます。追加をクリックしてこのパッケージに新しいデータ手順を指定します。セットラベルを入力します。このフィールドを空欄にすると、選択済みのオブジェクトに基づいて Vault が自動でラベルを生成します。プライマリオブジェクト選択リストからデータオブジェクトを選択します。関連データオブジェクトを追加するには、関連オブジェクトの追加をクリックして関連オブジェクトを選択します。各データセットには最大 9 個の関連オブジェクトを追加できます。保存をクリックして送信パッケージのページに戻ります。
  9. 移行パッケージの任意の作業: コードセクションに進みます。Vault Java SDK コードを含めるかどうかを選択します。はいを選択すると、Vault Java SDK 展開オプションのデフォルトがすべて置き換えるに設定されます。
  10. 移行パッケージの場合はオプションです: オプションメニューで、依存関係の表示/追加を選択します。結果ダイアログには、パッケージのコンポーネントの依存関係のうち、ターゲット Vault で満たされていないものがすべて表示されます。パッケージに追加したい依存関係にチェックを入れ、保存をクリックします。依存関係を追加するには、手順 5 でターゲット Vault を選択する必要があります。
  11. 任意の作業: パッケージセクションに進みます。アップロードをクリックしてエクスポートした VPK を保存します。
  12. アクションメニューを開いてエクスポートを選択します。エクスポートが完了すると、システムメッセージページにメモが表示され、Vault からメールが送られます。通知には VPK をダウンロードするためのリンクが含まれます; Vault ではお使いのマシンに自動的に VPK がダウンロードされません。

パッケージおよび依存性

パッケージには、選択されたコンポーネントの設定詳細のみが含まれます。場合によっては、あるコンポーネントが別のコンポーネントに依存するような設定になることがあります。例えば、選択リストタイプのドキュメントフィールド対象者は、最初にそのフィールドで使用する選択リストを作成しない限り、作成できません。依存性に関する問題の発生を防ぐために、設定全体を 1 つのパッケージとしてエクスポートおよび展開することを推奨します。上記の手順で説明したように、移行パッケージをエクスポートする前に、その依存関係を表示および追加できます。依存コンポーネントの情報に Vault API を使用してパッケージを検証し、パッケージまたはターゲット Vault に存在するかどうかを検証することもできます。

Vault 間比較からのパッケージの作成

同じドメインにある Vault の場合、Vault Compare はソース Vault とターゲット Vault の違いに基づいて自動的に送信パッケージを作成します。

データセットについて

送信移行パッケージにデータセットを追加すると、コンポーネントとオブジェクトデータの両方を含めて、別の Vault にグループとして移動させることができます。データセットはオブジェクトと関連オブジェクトデータから構成されています。各データセットには、1 個のプライマリオブジェクトおよび 9 個の追加関連オブジェクトを含む、最大 10 個のデータオブジェクトを含めることができます。各送信パッケージには最大 100 個のデータオブジェクトを含めることができます。

送信テストデータパッケージを使用して、オブジェクト関係を含むオブジェクトデータを移行できます。例えば、治験、および施設の間の親の親、親、および子関係です。テストデータパッケージはグローバル ID およびリンクフィールドを使用してデータを移行します。

ユーザオブジェクトは移行パッケージおよびテストデータパッケージで使用できますが、ユーザデータは別の Vault、特にドメインが異なる Vault では同一にはなりません。そのためほとんどの場合は、Vault ローダを使用してユーザレコードを別の Vault に抽出および移動することを推奨します。

オブジェクトの選択

データセット設定ページからオブジェクトをデータセットに追加するには:

  1. Vault で使用可能なすべてのオブジェクトのリストからプライマリオブジェクトを選択します。このリストには、オブジェクトタイプとシステム管理レコードを持つオブジェクトは含まれていません。
  2. 任意の作業: 関連オブジェクトの追加をクリックして、適用可能な送信関係と受信関係のリストから選択します。
  3. 保存をクリックします。

データセットの編集

既存のデータセットを編集するには.送信パッケージ詳細ページのデータセットの隣にあるアクションメニューから編集を選択するか、データセット編集ページの編集をクリックします。

データオブジェクトのデフォルト設定の編集

データオブジェクトのデフォルト設定を編集するには:

  1. 送信パッケージ詳細ページからデータセットをクリックします。
  2. 目的のオブジェクトから、アクションメニューで編集を選択します。
  3. 任意の作業: アクション選択リストから更新/挿入作成削除、または更新を選択します。これにより、展開のデフォルトアクションが決定されます。Vault は、挿入/更新をデフォルトアクションとして設定します。
  4. 任意の作業: キーフィールド選択リストからフィールドを選択します。これは、デフォルトの挿入/更新更新、または削除アクションの更新部分のレコードをルックアップするために使用される固有フィールドです。作成アクションには、ルックアップの固有フィールドは不要です。
  5. 任意の作業: レコード移行モードチェックボックスを選択します。レコード移行モードを使用して、ライフライクルを持つオブジェクトに初期状態のレコードを移行できます。また、移行モードでレコードを作成する際、Vault はバリデーションルールおよび参照制限を迂回します。レコード移行モード作成アクションでのみ使用できます。
  6. 任意の作業: フィルタ セクションを展開し、 VQL WHERE clauseこのフィールドは、Vault Loader の Where Clause フィールドと同じ構文で、移動させたいレコードを絞り込むために使用されます。オブジェクトに別のオブジェクトへの受信子関係がある場合、Vault は自動的に削除することができない status__v='active' フィルターを含めます。文法エラーを確認するには、 検証 をクリックします。開発者ポータルで VQLの詳細をご覧ください。
  7. 任意の作業: セクションを展開して選択したオブジェクトの列を変更します。すべての編集可能な列はデフォルトで選択されています。含める列を選択解除することで、特定のフィールド値を移動させないよう選択することができます。送信関係のデフォルトの参照フィールドを他の一意の参照フィールドに置き換える選択もできますが、各送信関係に含めることができる参照フィールドは 1 つに限られます。有効な固有の参照フィールドがない場合、Vault はごれらの列を除外します。オブジェクトに別のオブジェクトへの受信子関係がある場合、Vault は status__v 列を除外します。
  8. 保存をクリックします。

パッケージをインポートおよび検証する方法

パッケージをインポートおよび検証するには:

  1. 管理者 > 展開 > 受信パッケージに移動し、インポートをクリックします。
  2. お使いのコンピュータでエクスポートされた VPK ファイルを探して選択します。
  3. Vault はパッケージを非同期的にインポートおよび検証して、完了時にメールで通知を送信します。通知メールのリンクをクリックすると、インポートの検証ログが開きます。
  4. 既存の受信パッケージを検証するには、受信パッケージの隣にあるアクションメニューから検証を選択します。

検証ログについて

検証ログには、受信パッケージの各パッケージ手順の展開ステータスおよび依存性に関する詳細情報が含まれています。展開する前に、不足 – ブロックステータスを持つ依存性リストに表示される不足している依存性をパッケージに追加してください。受信パッケージ全体のパッケージステータスは、手順レベルの展開ステータスを反映しており、次に依存性からのステータスを反映します。必須の依存性が不足している場合、手順の展開ステータス、次に全体のパッケージがブロックに設定されます。

バリデーションステータス

Vault は、パッケージ手順のリストにある依存性ごとにステータスを割り当てます。

  • ターゲットにあり: 依存コンポーネントはすでにターゲット Vault に存在しています。
  • パッケージにあり: 依存コンポーネントはパッケージに存在しています。
  • 不足 – 無視: 依存コンポーネントは不足しており、Vault はそのコンポーネントを無視します。
  • 不足 – 作成: 依存コンポーネントは不足しており、Vault はそのコンポーネントを作成します。
  • 不足 – ブロック: 依存コンポーネントは不足しており、Vault は VPK をブロックして展開しないようにします。
  • パッケージにあり – 無視: 依存コンポーネントはパッケージに存在しており、ブロックタイプは無視です。
  • パッケージにあり – 作成: 依存コンポーネントはパッケージに存在しており、ブロックタイプは作成です。
  • パッケージにあり – 誤った順序 – ブロック: 依存コンポーネントの順序が誤っており、ブロックタイプはブロックです。

パッケージを展開する方法

  1. アクションメニューからレビューおよび展開を選択します。Vault 上で、パッケージのすべてのコンポーネントの一覧が表示されます。
  2. 各項目の展開ステータス展開アクションをレビューします。特定の手順を削除するには、チェックボックスのチェックを外します。
  3. 任意の作業: 手順の順序を変更するには、順序の変更をクリックして、変更したい手順番号を手順フィールドに入力してから保存をクリックします。
  4. 次へをクリックします。Vault の設定に応じて、パッケージ手順の展開ステータスブロック済みの場合、Vault で次へをクリックできない場合があります。
  5. 確認ページの確認が終わったら、終了をクリックします。

パッケージコンポーネント比較をエクスポートする方法

パッケージコンポーネント比較のエクスポート (XLSX) は、任意のパッケージのコンポーネントについて、それらのコンポーネントが Vault の現在の構成とどのように違うのか、パッケージ自体の詳細について理解するのに役立ちます。このオプションは、展開前後にインポートされたパッケージで利用可能です。

比較をエクスポートするには:

  1. 管理者 > 展開 > 受信パッケージに進みます。
  2. パッケージまたはパッケージ詳細ページのアクションメニューで、パッケージコンポーネント比較を選択します。
  3. Vault は、比較処理を開始し、完了したら通知を送信します。通知には、パッケージ比較レポートのダウンロード用リンクが含まれます。

2 つの Vault の設定を比較するには、Vault 間比較を使用します。

展開ステータス

Vault は、パッケージの各手順 (コンポーネントまたはデータ) がソース Vault の手順に一致する (チェックサムによる) ことを確認することで、まず受信パッケージの展開ステータスを決定します。ステータスは、受信パッケージの表示時と、レビューおよび展開中の手順のレビューおよび選択確認時に表示されます。展開すると、状況を反映してステータスが更新されます。展開ステータスは、各手順と、パッケージ全体に存在します。個別の手順でエラーが発生した場合、パッケージのステータスにもエラーと表示されます。

  • インポート済み: VPK は正常にインポートされました。
  • 確認済み: パッケージの手順はソース Vault に一致しますが、まだ展開されていません。
  • 未確認: VPK または手順が変更されたことを示します。
  • 展開済み: Vault は正常にコンポーネントの構成をターゲット Vault に展開しました。
  • 展開中: VPK の展開が進行中です。
  • 展開済み: VPK は正常に展開され、警告もエラーもありませんでした。
  • 展開時に障害発生: Vault は VPK を完全に展開しましたが、障害が発生しました。
  • 展開時にエラー発生: Vault は、展開中にエラーを検出しましたが、一部のコンポーネントとデータを正常に展開することができています。
  • 警告付き展開: Vault が展開中に何らかの問題を特定しましたが、正常に展開されました。例: パッケージにオブジェクトライフサイクルを参照するオブジェクトが含まれていたが、ターゲット Vault にそのオブジェクトライフサイクルが存在しない場合。プレースホルダーライフサイクルを作成することで、展開を続行できました。このステータスはコンポーネントにのみ適用されます。
  • スキップ済み: 展開時に、コンポーネントはすでにターゲット Vault に存在したため、ユーザがこの手順のスキップを選択したか、Vault がこの手順をスキップしました。
  • エラー: パッケージの展開中に Vault にエラーが発生しました。エラー詳細をご確認ください。
  • ブロック済み: 依存性が不足または順序が不適切だったため、Vault は VPK を展開できません。

展開アクション

Vault は、すでにターゲット Vault にある手順とパッケージの手順を比較して、受信パッケージの展開アクションを決定します。展開アクションは、レビューおよび展開中のレビューおよび選択の手順確認手順の段階で表示されます。展開ステータスとは異なり、展開アクションは、パッケージの各手順の手順レベルでのみ存在します。

  • 追加: パッケージによってターゲット Vault に追加される新しいコンポーネントです。
  • 作成: パッケージによってターゲット Vault に追加される新しいデータ手順です。
  • 挿入/更新: この操作では、データ手順がまだ存在しない場合はターゲット Vault に追加し、存在する場合はそれを更新します。
  • 更新: このコンポーネントはターゲット Vault にすでに存在しているものの、設定が異なります。パッケージは設定が一致するように既存のコンポーネントを更新します。この操作は、監査証跡などのコンポーネントに対するすべての参照を維持します。
  • 変更なし: パッケージのコンポーネントがすでにターゲット Vault に存在するコンポーネントと同一です。

展開アクションをクリックして、ポップアウトビューアの各コンポーネントの詳しい比較と依存性を表示します。

展開の通知

レビューおよび展開中に Vault がコンポーネント構成の更新を処理している場合、レビューおよび選択の手順展開の確認のページに警告メッセージが表示されます。

Vault がコンポーネント構成の更新を処理している間は、展開アクションとステータスが正確でない場合があるため、処理が完了する前にパッケージを展開すると、展開エラーが発生する可能性があります。構成の更新処理の終了を待ってから展開を完了させることをお勧めします。

展開エラーを解決する方法

ほとんどの展開エラーは検証ログおよびパッケージコンポーネント比較をレビューすることで避けることができますが、それでも展開エラーが発生する場合があります。パッケージの展開中に Vault でエラーが発生した場合、展開は中断されますが、すでに行われた設定の変更は元に戻されません。

エラーを解決して展開を完了するには:

  1. 展開ログを確認して、エラーの原因を突き止めます。ログへのリンクが通知に表示されています。ログは、受信パッケージにも添付されています。受信パッケージの詳細ページからログをダウンロードできます。
  2. エラーの原因に対処します。エラーによっては、必要なコンポーネントを含む別のパッケージの展開が必要になったり、手動で設定変更を行わなければならない場合があります。特定のエラーおよび警告を解決するための詳細をご確認ください。
  3. 受信パッケージでエラーが発生したパッケージに戻ります。アクションメニューから展開を選択します。
  4. Vault で前回の展開が中断したところからプロセスが再開されます。

コンポーネントの展開順序

単一の構成移行パッケージを構築する場合、Vault はコンポーネントの順序を自動的に処理します。しかし、複数の構成移行パッケージを構築する場合は、移行プロジェクトを成功させるために適切な展開順序で構築することが必要になります。順序の問題を解決できない場合は、Veeva マネージドサービス

コンポーネントタイプ

Vault 構成移行がサポートする構成要素の一覧はコンポーネントタイプをご確認ください。

コンポーネント名

パッケージを展開する際に発生したエラーおよび警告メッセージは、ラベルではなく名前でコンポーネントを指定します。通常、名前はラベルに基づいており、つながりがはっきりと分かるようになっています。場合によっては、名前が分かりにくいこともあります。

そのような場合は、設定詳細でコンポーネント名を参照してください。例えば、ドキュメントフィールド名は管理者 > 設定 > ドキュメントフィールド、オブジェクトワークフロー名は管理者 > 設定 > オブジェクトワークフロー > 詳細にあります。

ドキュメントフィールド移行の詳細

ドキュメントフィールドを移行する際、Vault には構成移行パッケージの自動管理グループを参照するセキュリティオーバーライドは含まれませんが、自動管理グループに基づかないその他のセキュリティオーバーライドは含まれます。

ドキュメントライフサイクル移行の詳細

ドキュメントライフサイクルを移行する際に、以下のルールに留意しておくようにしてください:

  • ライフサイクルロール割り当てルールは、Doclifecycle コンポーネントタイプに含まれません。ライフサイクルロール割り当てルール API を使用してデフォルトルールオーバーライドルールを移行する必要があります。

ドキュメントワークフロー移行の詳細

ワークフローを移行する際に、以下のルールに留意してください:

  • 移行できるのはステータスが有効のワークフローのみです。ソース Vault でワークフローが現在編集モードになっている場合、送信パッケージにワークフローの最終有効バージョンが含まれます。
  • 同じバージョンの Vault 上にある場合を除き、限定リリース Vault と一般リリース Vault の間でワークフローを移行することはできません。これは、一般リリースの直後にのみ発生します。
  • ライフサイクル間でワークフローを移行することはできません。すべてのファミリーでコンポーネント名が同じとは限らないため、アプリケーションファミリーが異なると構成移行が正常に機能しない場合があります。構成を変更する前に、本番環境のコピーから Sandbox およびテスト環境を更新することが推奨されます。

オブジェクトタイプ移行の詳細

オブジェクトタイプを移行する際に、以下のルールに留意しておくようにしてください:

  • オブジェクトタイプをパッケージに追加する前に、オブジェクトタイプを有効にする必要があります。
  • オブジェクトタイプを追加した後に、新規デフォルトのオブジェクトタイプを設定できます。
  • オブジェクトタイプを使用して Vault から移行する際は、パッケージから Base (base__v) オブジェクトタイプを削除してください。Vault はこのオブジェクトタイプを自動作成します。

オブジェクトライフサイクル移行の詳細

オブジェクトライフサイクルが関連付けられているオブジェクトを移行する際は、Vault はターゲット Vault に一時的なプレースホルダーライフサイクルを作成します。プレースホルダーはオブジェクトに関連づけられ、ソース Vault のオブジェクトライフサイクルと同じパブリックキーを持ちますが、プレースホルダーは無効です。オブジェクトライフサイクルのインポート時に、Vault はプレースホルダーライフサイクルを上書きし、新規オブジェクトライフサイクルを有効化します。

オブジェクトライフサイクルを移行するには、Lifecyclestatetype コンポーネントおよびライフサイクルの Lifecyclestatetypeassociation コンポーネントを VPK に含める必要があります。これらのコンポーネントを含めない場合、オブジェクトレコードを作成する際にエラーが発生します。ターゲット Vault でオブジェクト状態タイプをライフサイクル状態に手動で関連付ける必要があります。

オブジェクトワークフロー移行の詳細

オブジェクトワークフローを移行する際に、以下のルールに留意しておくようにしてください:

  • 移行されたオブジェクトワークフローは、移行先の Vault で無効ステータスになります。デプロイ後、手動で有効にする必要があります。
  • 電子署名を使用するオブジェクトワークフローを含む 17R3 Vault から VPK をインポートする場合、まずターゲット Vault のそのオブジェクトで電子錠名を有効化する必要があります。

保存済みビュー移行の詳細

必須としてマークされた保存済みビューのみが移行の対象となります。

検索可能オブジェクトフィールド移行の詳細

オブジェクトの移行時に、検索可能オブジェクトフィールドが含まれます。パッケージには、カスタムフィールドのみを含める必要があります。

グループ移行の詳細

グループを移行する際は、以下に留意してください:

  • 移行またはテストデータパッケージ内のデータセットをすることでのみグループの移行を行うことができます。Vault は、グループに対する関連オブジェクトの移行をサポートしていません。
  • システム管理グループを作成することはできませんが、既存のシステム管理グループの更新は可能です。
  • 移行またはテストデータパッケージ内のグループメンバーをエクスポートすることはできません。ただし、移行されたグループに含まれるセキュリティプロファイルに応じて、Vault によってグループメンバーが自動的に追加または削除される場合があります。

以下の権限は構成移行パッケージのアクションを制御します:

タイプ権限ラベル制御
セキュリティプロファイル管理者: 移行パッケージ: 作成構成移行用のパッケージ作成機能; この権限がソース Vault に必要です。
セキュリティプロファイル管理者: 移行パッケージ: 展開構成移行用のパッケージを展開する権限; この権限がターゲット Vault に必要です。
セキュリティプロファイル管理者: 様々様々なコンポーネントの作成または編集機能。手動でコンポーネントを作成した場合は、パッケージを展開する際に同じ権限が必要になります。例えば、選択リストコンポーネントを含むパッケージを展開するには管理者 > 選択リスト > 編集が必要です。
セキュリティプロファイルオブジェクト: 送信パッケージ: 読取り送信パッケージオブジェクトを表示する権限。このオブジェクトのすべてのフィールドに対する読取り権限も必要です。
セキュリティプロファイルオブジェクト: 受信パッケージ: 読取り受信パッケージオブジェクトを表示する権限。このオブジェクトのすべてのフィールドに対する読取り権限も必要です。
セキュリティプロファイルオブジェクト: 受信パッケージ手順: 読取り受信パッケージ手順オブジェクトを表示する権限。このオブジェクトのすべてのフィールドに対する読取り権限も必要です。
セキュリティプロファイルオブジェクト: 受信パッケージデータ: 読取り受信パッケージデータオブジェクトを表示する権限。このオブジェクトのすべてのフィールドに対する読取り権限も必要です。
セキュリティプロファイルオブジェクト: 受信パッケージコンポーネント: 読取り受信パッケージコンポーネントオブジェクトを表示する権限。このオブジェクトのすべてのフィールドに対する読取り権限も必要です。

標準 Vault 所有者およびシステム管理者のセキュリティプロファイルには、必要なすべての権限があります。