diff options
Diffstat (limited to 'docs/fr/source')
14 files changed, 235 insertions, 0 deletions
diff --git a/docs/fr/source/_static/annexe-technique-06-01.png b/docs/fr/source/_static/annexe-technique-06-01.png Binary files differnew file mode 100644 index 000000000..5af00bea1 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-01.png diff --git a/docs/fr/source/_static/annexe-technique-06-02.png b/docs/fr/source/_static/annexe-technique-06-02.png Binary files differnew file mode 100644 index 000000000..911ef87be --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-02.png diff --git a/docs/fr/source/_static/annexe-technique-06-03.png b/docs/fr/source/_static/annexe-technique-06-03.png Binary files differnew file mode 100644 index 000000000..f04ae54c3 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-03.png diff --git a/docs/fr/source/_static/annexe-technique-06-04.png b/docs/fr/source/_static/annexe-technique-06-04.png Binary files differnew file mode 100644 index 000000000..1a58ae82f --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-04.png diff --git a/docs/fr/source/_static/annexe-technique-06-05.png b/docs/fr/source/_static/annexe-technique-06-05.png Binary files differnew file mode 100644 index 000000000..77d9f5ee3 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-05.png diff --git a/docs/fr/source/_static/annexe-technique-06-06.png b/docs/fr/source/_static/annexe-technique-06-06.png Binary files differnew file mode 100644 index 000000000..b3b01780c --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-06.png diff --git a/docs/fr/source/_static/annexe-technique-06-07.png b/docs/fr/source/_static/annexe-technique-06-07.png Binary files differnew file mode 100644 index 000000000..d0a93a87e --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-07.png diff --git a/docs/fr/source/_static/annexe-technique-06-08.png b/docs/fr/source/_static/annexe-technique-06-08.png Binary files differnew file mode 100644 index 000000000..ac21a20c2 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-08.png diff --git a/docs/fr/source/_static/annexe-technique-06-09.png b/docs/fr/source/_static/annexe-technique-06-09.png Binary files differnew file mode 100644 index 000000000..a785c3478 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-09.png diff --git a/docs/fr/source/_static/annexe-technique-06-10.png b/docs/fr/source/_static/annexe-technique-06-10.png Binary files differnew file mode 100644 index 000000000..d4f9e90c4 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-10.png diff --git a/docs/fr/source/_static/annexe-technique-06-11.png b/docs/fr/source/_static/annexe-technique-06-11.png Binary files differnew file mode 100644 index 000000000..922506998 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-11.png diff --git a/docs/fr/source/_static/annexe-technique-06-12.png b/docs/fr/source/_static/annexe-technique-06-12.png Binary files differnew file mode 100644 index 000000000..500090ed0 --- /dev/null +++ b/docs/fr/source/_static/annexe-technique-06-12.png diff --git a/docs/fr/source/annexe-tech-6-configuration-syndication.rst b/docs/fr/source/annexe-tech-6-configuration-syndication.rst new file mode 100644 index 000000000..c51e68e34 --- /dev/null +++ b/docs/fr/source/annexe-tech-6-configuration-syndication.rst @@ -0,0 +1,234 @@ +.. -*- coding: utf-8 -*- + +.. _annexe-tech-6-configuration-syndication: + +==================================================== +Annexe technique 6 - Configuration de la syndication +==================================================== + +:Auteurs: Étienne Loks +:Date: 2023-02-16 +:Copyright: CC-BY 3.0 +:Ishtar Version: v4.0 + +La syndication de données entre instances Ishtar est une fonctionnalité +puissante mais assez complexe à mettre en place. La documentation +ci-dessous détaille pas à pas les différentes étapes pour mettre en +place cela. + +Selon que l’on soit l’instance qui partage des données ou celle qui +consulte des données les enjeux sont différents : + +L’instance qui partage des données (dite « hôte ») doit paramétrer : + +- les type de données à partager ; +- les sous-ensemble de ces données à partager ; +- les attributs que l’on souhaite exposer / cacher ; +- à qui l’on va partager les données (nécessitant la création d’un + compte système avec un jeton d’accès et le paramétrage de l’adresse + IP du serveur vers lequel les données vont être envoyées). + +L’instance hôte est configurée en administration via les entrées « API - +Accès distant ». + +L’instance qui consulte les données (dite « cliente ») doit paramétrer : + +- le serveur « hôte » qui fourni les données, son adresse web d’Ishtar + et un jeton d’accès ; +- la correspondance entre les listes de vocabulaires contrôlés de son + instance et les listes de vocabulaires contrôlés de l’instance hôte. + Cette correspondance est nécessaire pour traduire les recherches par + critères de manière pertinente. + +L’instance cliente est configurée en administration via les entrées « +API - Recherche ». + +Pour illustrer une syndication de données, nous allons prendre l’exemple +suivant : + +L’instance Charente-Maritime veut partager un ensemble de données avec +l’instance Nouvelle-Aquitaine. + +Le serveur dit « hôte » est celui de Charente-Maritime. + +Le serveur dit « client » est celui de Nouvelle-Aquitaine. + +Configuration du serveur hôte +============================= + +Cette configuration est à faire si vous souhaitez donner un accès en +lecture à vos données depuis une autre instance Ishtar. Dans notre +exemple, il s’agit du serveur Charente-Maritime. + +Préalablement à cette configuration vous avez besoin de l’adresse IP du +serveur de l’autre instance Ishtar. + +Création d’un utilisateur système +--------------------------------- + +Contrairement à la création d’utilisateur classique, on créé un +utilisateur système. Celui-ci n’aura pas accès à l’instance Ishtar +directement. Créer cet utilisateur en interface « Administration de base +de données » : « Authentification et autorisation > Utilisateurs > Ajout +». Utiliser un identifiant qui n’existe pas encore en base de données, +exemple « syndication-nouvelle-aquitaine ». Le mot de passe ne sera pas +utilisé : en choisir un particulièrement complexe. + +|image0| + +Associer un jeton d’authentification à un utilisateur système +------------------------------------------------------------- + +Associer ensuite à ce compte un jeton d’authentification. Depuis +l’interface « Administration de base de données » : « Accueil > Jeton +d’authentification > Jetons > Ajout ». Le compte est retrouvé via +l’icône loupe. + +Une fois le jeton créé, aller à la liste des jetons puis mettre de côté +la clé du jeton. + +|image1| + +Par exemple sur la capture d’écran, la clé est +``a14b32f31029216da11621ba5ddb0431997ca61d``. Une fois la configuration +terminée, cette clé sera à transmettre à l’administrateur de l’autre +instance Ishtar. + +Associer l’adresse IP du serveur client à l’utilisateur système +--------------------------------------------------------------- + +Depuis « Ishtar - Commun > API - Accès distant - Utilisateurs > Ajout », +on associe l’utilisateur système à l’adresse IP du serveur. + +|image2| + +Pour notre exemple, le serveur de Nouvelle-Aquitaine a l’adresse +``8.8.8.8``. + +Ouvrir l’accès à un ou plusieurs types de contenu +------------------------------------------------- + +Pour chaque type de contenu que l’on souhaite ouvrir (Opération, Unité +d’Enregistrement, Mobilier, …), ajouter une entrée via : « Ishtar - +Commun > API - Accès distant - Modèles de recherche > Ajout ». + +|image3| + +On sélectionne notre utilisateur système, le type de contenu, ainsi +qu’éventuellement une requête filtrante. Cette requête correspond à une +chaîne de caractères correspondant à recherche. Seuls les éléments +correspondants à cette requête seront partagés. Si l’on ne renseigne pas +cette requête filtrante tous les éléments seront renvoyés. + +Filtrer la fiche de contenu +--------------------------- + +Il est possible de cacher certains champs sur la fiche que l’on partage. +Pour chaque champ que l’on souhaite cacher, ajouter une entrée via « +Ishtar - Commun > API - Accès distant - Filtres de fiche > Ajout ». Le +formulaire doit rempli en deux fois. On se contente d’abord de choisir +le type de contenu que l’on veut filtrer. + +|image4| + +Valider avec le bouton « Enregistrer et continuer les modifications ». + +Une fois ce premier enregistrement, l’aide disponible sous le champ « +Clé » liste les différentes clés correspondant au contenu que l’on +souhaite filtrer. + +|image5| + +Sur cet exemple, on souhaite filtrer l’affichage de l’image principale. +Note : si l’on souhaite qu’aucune image ne soit affichée, il faut +ajouter chaque champ « image ». + +Configuration du serveur client +=============================== + +Cette configuration est à faire si vous souhaitez accéder à des données +d’une autre instance Ishtar depuis votre propre instance. Dans notre +exemple, il s’agit du serveur Nouvelle-Aquitaine. + +Préalablement à cette configuration vous avez besoin du jeton +d’authentification donné par le serveur hôte ainsi que l’adresse web +pour accéder à celui-ci. + +Créer la source externe +----------------------- + +Cette source externe se créé en interface « Administration de base de +données » : « Ishtar - Commun > API - Recherche - Sources externes > +Ajout ». + +|image6| + +Sur le formulaire reprendre l’adresse web du serveur hôte ainsi que le +jeton d’authentification qui vous a été fourni. Le nom renseigné doit +être explicite, il apparaîtra sur les écrans de recherche de +l’interface. On renseigne explicitement chaque utilisateur qui aura +accès à cette source externe. + +Synchroniser les listes de vocabulaire contrôlées depuis la source +------------------------------------------------------------------ + +Une fois la source externe créée il est nécessaire de récupérer les +listes de vocabulaire contrôlées de cette source (le serveur hôte). Pour +cela, on se rends sur la page listant les sources externes : « Ishtar - +Commun > API - Recherche - Sources externes ». Sélectionner la source +externe concernée, l’action « Mettre à jour les types depuis la source » +et valider (le bouton « Aller »). + +|image7| + +Cette action peut prendre un certain temps. Si des changements sont +faits sur les listes de vocabulaires contrôlés sur la source cette étape +ainsi que les suivantes sont à effectuer de nouveau. + +Mettre à jour les correspondances +--------------------------------- + +Pour chaque liste de vocabulaire contrôlée, des correspondances sont +faites automatiquement entre les termes identiques. Lorsque deux +instances partagent la même langue et ont des cas d’utilisation +semblable, une bonne partie des listes de vocabulaires sont mis en +correspondance automatiquement. Afin de visualiser les correspondances +et de compléter les correspondances manquantes, on génère un document de +correspondance. Celui est sous la forme d’un document tableur +LibreOffice. Pour cela, on reste sur la page listant les sources +externes : « Ishtar - Commun > API - Recherche - Sources externes ». +Sélectionner la source externe concernée, l’action « Générer le document +de correspondance » et valider (le bouton « Aller »). + +|image8| + +Ouvrir le document généré avec LibreOffice et parcourir les différents +onglets pour effectuer les éventuelles correspondances manquantes : là +où des cellules sur la troisième colonne « Local » sont vides. Choisir +l’élément manquant dans la liste. + +|image9| + +Une fois ces modifications faites, enregistrement le document et +déposez-le sur le serveur sur la source externe concernée. + +|image10| + +Enregistrez la source externe puis sélectionnez la source externe +concernée, l’action « Mettre à jour les associations depuis un document +de correspondance » et valider. + +|image11| + +.. |image0| image:: _static/annexe-technique-06-01.png +.. |image1| image:: _static/annexe-technique-06-02.png +.. |image2| image:: _static/annexe-technique-06-03.png +.. |image3| image:: _static/annexe-technique-06-04.png +.. |image4| image:: _static/annexe-technique-06-05.png +.. |image5| image:: _static/annexe-technique-06-06.png +.. |image6| image:: _static/annexe-technique-06-07.png +.. |image7| image:: _static/annexe-technique-06-08.png +.. |image8| image:: _static/annexe-technique-06-09.png +.. |image9| image:: _static/annexe-technique-06-10.png +.. |image10| image:: _static/annexe-technique-06-11.png +.. |image11| image:: _static/annexe-technique-06-12.png diff --git a/docs/fr/source/index.rst b/docs/fr/source/index.rst index 3678e87ac..a9a332e19 100644 --- a/docs/fr/source/index.rst +++ b/docs/fr/source/index.rst @@ -24,3 +24,4 @@ Contents: annexe-tech-3-variables-gen annexe-tech-4-jinja-filters annexe-tech-5-manage-commands + annexe-tech-6-configuration-syndication |
