前提条件

ZIP ファイルを使用してガバナンス成果物をインポートする前に、正しい形式でファイルを作成し、必要な権限があることを確認してください。

ZIP ファイルの内容の編集

エクスポートされた ZIP ファイルには、成果物タイプごとに別個のフォルダーが含まれており、そのタイプの成果物を含む CSV ファイルが含まれています。

エクスポートされた ZIP ファイルの内容は手動で変更できます。 以下のガイドラインに従ってください。

• 親フォルダーなどの追加フォルダーを作成しないでください。
• フォルダー名は変更しないでください。 ZIP ファイル内の各成果物タイプのフォルダーの名前は、 category、 classification、 data_class、 glossary_term、 policy、 rule、および reference_dataでなければなりません。
• 各 CSV ファイルの正しい形式を維持してください。 ガバナンス成果物をインポートするための CSV ファイル・フォーマットを参照してください。
• 各 CSV ファイル内の Artifact ID 列を削除したり名前変更したりしないでください。 この列は、成果物の名前に加えて、成果物の ID を指定します。
• 一方の成果物についてのみ、2 つのガバナンス成果物の間の関係を定義します。 ただし、次の 2 つの例外があります。
  1. この関係は、ポリシーとガバナンス・ルールの間の関係です。 この場合は、両方の成果物の関係を両方の CSV ファイルに定義します。 ポリシーを含む CSV ファイルで、 Rule 列に関係を追加します。 ガバナンス・ルールを含む CSV ファイルで、 Parent Policies 列に関係を追加します。
  2. all マージ・オプションを使用しています。 この場合、成果物間の関係について、すべての CSV コンテンツが整合していることを確認する必要があります。 例えば、ZIP インポート・ファイルに、関係に関連付けられた用語とデータ・クラスの両方が含まれている場合、この関係はデータ・クラス CSV と用語 CSV の両方に存在する必要があります。 そうしないと、関係のインポート動作が予測不能になり、関係がインポートされる場合とされない場合があります。

ZIP ファイルのインポートの準備

ZIP ファイルをインポートする前に、以下のタスクを実行する必要があります。

• 事前定義成果物の重複を回避するための適切なアクションを実行します。
• カスタム・プロパティーおよび関係の作成

マージ・オプション

ZIP インポートの実行時には、以下のマージ・オプションを使用できます。

all

すべての値を置換します。 インポートされた値は、カタログ内の既存の値を置き換えます。

specified

定義された値で置換します。 空でないインポートされた値は、カタログ内の既存の値を置き換えます。

empty

空の値を置き換えます。 インポートされた値は、カタログ内の空の値のみを置き換えます。

specified がデフォルトとして使用されます。

参照データ値を含むファイルをインポートする場合は、常に merge_option=allを使用する必要があります。

マージ・オプションについて詳しくは、 インポートされた成果物と既存の成果物をマージする方法 を参照してください。

ZIP ファイルのインポート

ガバナンス成果物の ZIP ファイルをインポートするには、以下のようにします。

1. 必要に応じて、既存の事前定義成果物を削除するか、事前定義成果物との関係を編集します。 ZIP ファイルのインポートの準備を参照してください。
2. POST /v3/governance_artifact_types/import 要求を実行依頼します。 マージ・オプションと ZIP ファイルへのパスを含めます。 API 資料: 指定された ZIP ファイルからの値のインポートを参照してください。 すべての成果物は、ワークフローなしで即時に公開されます。
3. インポート・プロセスが完了したら、他のコラボレーターを新規カテゴリーに追加します。 「 カテゴリー・コラボレーターの管理」を参照してください。

新規インポート・プロセスを開始する前に、インポート・プロセスが完了するか、または 停止したプロセスをクリーンアップするまで待つ必要があります。

インポート・プロセスのモニター

ZIP ファイルをインポートする要求を送信すると、応答 (process_id パラメーター) にプロセス ID が提供されます。 このプロセス ID を使用して、インポートの状況を確認できます。 GET /v3/governance_artifact_types/import/status/{process_id} 要求を送信して、インポート状況を照会します。 APIドキュメントインポート状況 を参照。

停止したインポート・プロセスのクリーンアップ

Experimental これは試験的リリースであり、実稼働環境での使用はまだサポートされていません。

インポートが停止した場合は、インポート・プロセスをクリーンアップしてから、ZIP ファイルを再度インポートすることができます。 前のインポート・プロセスが完了するか、停止したプロセスをクリーンアップするまで、新しいインポート・プロセスを開始することはできません。 すべてのインポート・プロセスは、非アクティブ状態が 24 時間経過すると自動的にクリーンアップされます。

GET /v3/governance_artifact_types/import/status/{process_id} 要求を送信することにより、インポート・プロセスの状況を確認できます。 状況が IN_PROGRESS であるが、成果物がインポートされていない場合、プロセスは停止します。

停止または失敗したインポート・プロセスをクリーンアップするには、 POST /v3/governance_artifact_types/import/cleanup/{process_id} 要求を実行依頼します。

APIドキュメント：ZIP インポート処理のクリーンアップ を参照。

もっと見る

• CSV ファイルを使用したガバナンス成果物のインポート

• ZIP ファイルへのすべてのガバナンス成果物のエクスポート

• ガバナンス成果物のインポートの問題の解決

• API 資料: 指定された ZIP ファイルからの値のインポート

親トピック: ガバナンス成果物のインポート・メソッド