Vous pouvez importer tous les artefacts de gouvernance d'une instance IBM Knowledge Catalog à l'aide d'un fichier ZIP que vous avez créé en exportant les artefacts.
Vous pouvez utiliser cette méthode pour déplacer des artefacts de gouvernance d'une instance d'IBM Knowledge Catalog à une autre ou pour modifier les propriétés des artefacts de gouvernance à l'aide d'un outil externe. Tous les artefacts importés sont publiés immédiatement sans flux de travaux.
- Prérequis
- Edition du contenu du fichier ZIP
- Préparation de l'importation d'un fichier ZIP
- Options de fusion
- Importation d'un fichier ZIP
- Surveillance du processus d'importation
- Nettoyage d'un processus d'importation bloqué
Prérequis
Avant d'importer des artefacts de gouvernance avec un fichier ZIP, créez le fichier avec le format correct et vérifiez que vous disposez des droits requis.
Fichier ZIP
Vous devez disposer d'un fichier ZIP des artefacts exportés que vous avez créés avec la demande d'API GET /v3/governance_artifact_types/{artifact_type}/export . La taille maximale du fichier ZIP est de 2 Go. Voir Exportation de tous les artefacts de gouvernance dans un fichier ZIP.
Droits
Vous devez disposer du droit d'utilisateur Gérer le glossaire .
Vous n'avez pas besoin d'être un collaborateur dans les catégories créées ou affectées par le processus d'importation.
Edition du contenu du fichier ZIP
Le fichier ZIP exporté contient un dossier distinct pour chaque type d'artefact avec un fichier CSV contenant ce type d'artefact.
Vous pouvez modifier manuellement le contenu du fichier ZIP exporté. Suivez les instructions ci-dessous :
- Ne créez pas de dossiers supplémentaires, par exemple, un dossier parent.
- Ne modifiez pas les noms de dossier. Les dossiers de chaque type d'artefact dans le fichier ZIP doivent avoir les noms suivants:
category,classification,data_class,glossary_term,policy,ruleetreference_data. - Conservez le format correct de chaque fichier CSV. Voir Format de fichier CSV pour l'importation d'artefacts de gouvernance.
- Ne supprimez pas ou ne renommez pas la colonne
Artifact IDdans chaque fichier CSV. Cette colonne indique l'identificateur de l'artefact en plus du nom de l'artefact. - Définissez une relation entre deux artefacts de gouvernance pour un seul des artefacts. Il existe deux exceptions:
- La relation est entre une stratégie et une règle de gouvernance. Dans ce cas, définissez la relation pour les deux artefacts dans les deux fichiers CSV. Dans le fichier CSV avec des règles, ajoutez la relation dans la colonne
Rule. Dans le fichier CSV avec règles de gouvernance, ajoutez la relation dans la colonneParent Policies. - Vous utilisez l'option de fusion
all. Dans ce cas, vous devez vous assurer que tout le contenu CSV est cohérent en ce qui concerne les relations entre les artefacts. Par exemple, si le fichier d'importation ZIP contient à la fois un terme et une classe de données connectés avec une relation, cette relation doit être présente à la fois dans les classes de données CSV et dans les termes CSV. Sinon, le comportement d'importation de la relation est imprévisible, la relation peut être importée ou non.
- La relation est entre une stratégie et une règle de gouvernance. Dans ce cas, définissez la relation pour les deux artefacts dans les deux fichiers CSV. Dans le fichier CSV avec des règles, ajoutez la relation dans la colonne
Préparation de l'importation d'un fichier ZIP
Avant d'importer un fichier ZIP, vous devez effectuer les tâches suivantes:
- Effectuez l'action appropriée pour éviter les artefacts prédéfinis en double
- Créer des propriétés et des relations personnalisées
Eviter les artefacts prédéfinis en double
Les artefacts des fichiers ZIP exportés sont identifiés par des identificateurs d'artefact dans la colonne Artifact ID , et non par le nom d'artefact et le chemin de catégorie. Cependant, les identificateurs d'artefacts pour les termes commerciaux prédéfinis, les classes de données et les classifications diffèrent entre chaque instance d'IBM Knowledge Catalog Par conséquent, les termes métier prédéfinis importés, les classes de données et les classifications ne sont pas reconnus comme étant les mêmes que les termes métier, les classes de données et les classifications prédéfinis existants. Par conséquent, le processus d'importation crée des artefacts en double.
Vous pouvez éviter les doublons d'artefacts prédéfinis à l'aide de l'une des méthodes suivantes:
Supprimez les artefacts prédéfinis existants de l'instance IBM Knowledge Catalog cible avant d'importer des artefacts. Voir Suppression d'artefacts publiés du même type.
Pour les classes de données et les classifications prédéfinies:
- Excluez la catégorie [ uncategorized ] lorsque vous créez le fichier ZIP en exportant des artefacts.
- Editez les fichiers CSV des classes de données et des classifications et remplacez les identificateurs d'artefact des classes de données et des classifications prédéfinies dans les colonnes Classification parent et Classe de données parent par les noms d'artefact et les chemins de catégorie prédéfinis équivalents.
- Editez les fichiers CSV d'autres artefacts et remplacez les identificateurs d'artefact des classes de données et des classifications prédéfinies par les noms d'artefact et les chemins de catégorie prédéfinis équivalents dans les colonnes Classifications et Classes de données , pour tous les artefacts qui ont des relations avec les artefacts prédéfinis.
Lorsque vous importez les artefacts, des relations vers les artefacts prédéfinis de la cible existants sont créées.
Pour les termes métier prédéfinis:
- Excluez la catégorie Exemples de données personnelles de Knowledge Accelerator lorsque vous créez le fichier ZIP en exportant des artefacts.
- Editez les fichiers CSV pour les Termsa métier et les autres artefacts et remplacez les identificateurs d'artefact pour les termes métier prédéfinis par les noms d'artefact et les chemins de catégorie prédéfinis équivalents dans la colonne Termes associés et dans toute autre colonne définissant des relations de termes métier.
Lorsque vous importez les artefacts, des relations vers les artefacts prédéfinis de la cible existants sont créées.
Les ensembles de données de référence prédéfinis dans la catégorie Emplacements ont les mêmes valeurs d'ID d'artefact dans toutes les instances d'IBM Knowledge Catalog
Créer des propriétés et des relations personnalisées
Vous devez créer chaque propriété personnalisée ou définition de relation manuellement avant d'importer le fichier ZIP. Sinon, les valeurs de propriété personnalisée et de relation ne sont pas importées.
Pour plus d'informations, voir Propriétés et relations personnalisées.
Options de fusion
Les options de fusion suivantes sont disponibles lors de l'exécution de l'importation ZIP:
all- Remplacez toutes les valeurs. Les valeurs importées remplacent les valeurs existantes dans un catalogue.
specified- Remplacer par des valeurs définies. Les valeurs importées qui ne sont pas vides remplacent les valeurs existantes dans un catalogue.
empty- Remplacez les valeurs vides. Les valeurs importées remplacent uniquement les valeurs vides dans un catalogue.
specified est utilisé comme valeur par défaut.
Lors de l'importation de fichiers contenant des valeurs de données de référence, vous devez toujours utiliser merge_option=all.
Pour plus d'informations sur les options de fusion, voir Méthodes de fusion des artefacts importés et existants
Importation d'un fichier ZIP
Pour importer un fichier ZIP d'artefacts de gouvernance:
- Si nécessaire, supprimez les artefacts prédéfinis existants ou éditez les relations avec les artefacts prédéfinis. Voir Préparation de l'importation d'un fichier ZIP.
- Soumettez la demande
POST /v3/governance_artifact_types/import. Incluez l'option de fusion et le chemin d'accès au fichier ZIP. Voir la documentation d'API: Importation de valeurs à partir d'un fichier ZIP spécifié. Tous les artefacts sont publiés immédiatement sans flux de travaux. - Une fois le processus d'importation terminé, ajoutez d'autres collaborateurs aux nouvelles catégories. Voir Gestion des collaborateurs de catégorie.
Vous devez attendre la fin du processus d'importation ou nettoyer le processus bloquépour pouvoir démarrer un nouveau processus d'importation.
Surveillance du processus d'importation
Une fois que vous avez soumis la demande d'importation du fichier ZIP, un ID de processus est fourni dans la réponse (paramètreprocess_id ). Vous pouvez utiliser cet ID pour vérifier l'état de l'importation. Soumettez une demande GET /v3/governance_artifact_types/import/status/{process_id} pour interroger le statut d'importation. Voir la documentation de l'API : Statut de l'importation.
Nettoyage d'un processus d'importation bloqué
Expérimental Il s'agit d'une version expérimentale qui n'est pas encore prise en charge dans les environnements de production.
Si l'importation se bloque, vous pouvez nettoyer le processus d'importation, puis importer à nouveau le fichier ZIP. Vous ne pouvez pas démarrer un nouveau processus d'importation tant que le processus précédent n'est pas terminé ou que vous n'avez pas nettoyé le processus bloqué. Tous les processus d'importation sont nettoyés automatiquement après 24 heures d'inactivité.
Vous pouvez vérifier le statut du processus d'importation en soumettant une demande GET /v3/governance_artifact_types/import/status/{process_id} . Le processus est bloqué si le statut est IN_PROGRESS, mais les artefacts ne sont pas importés.
Pour nettoyer un processus d'importation bloqué ou ayant échoué, soumettez la demande POST /v3/governance_artifact_types/import/cleanup/{process_id} .
Voir la documentation de l'API : Nettoyer le processus d'importation ZIP.
En savoir plus
Exportation de tous les artefacts de gouvernance dans un fichier ZIP
Résolution des problèmes d'importation des artefacts de gouvernance
Documentation de l'API: Importation des valeurs à partir du fichier ZIP spécifié
Rubrique parent: Importation de méthodes pour les artefacts de gouvernance