Les extractions peuvent être enregistrées dans des dossiers ou sous-dossiers.
Les boutons de la catégorie "Dossier" sont disponibles :
Dans l'onglet 'Extractions', après avoir sélectionné un dossier, cliquez sur le bouton 'Nouveau' :
Renseignez le nom du fichier de définition, un nouveau fichier est créé dans le répertoire WEB-INF/param/extraction/definitions/<Dossier>.
L'outil 'Détails de l'extraction' s'ouvre, la racine de l'arbre est présente, ainsi que les nœuds qui permettent de définir des variables de clauses et des colonnes optionnelles.
Vous pouvez maintenant créer les composants de votre extraction.
Dans l'onglet 'Extractions', cliquez sur le bouton 'Modifier la description' :
L'outil de modification de contenu s'ouvre et vous permet de modifier la description de l'extraction.
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Thesaurus' de l'onglet 'Extractions' :
Une boîte de dialogue s'affiche vous permettant de renseigner les informations nécessaires à la création d'un composant de type thesaurus :
Un nœud Thesaurus est créé dans l'arbre, sous le nœud sélectionné.
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Requête' de l'onglet 'Extractions' :
Une boîte de dialogue s'affiche vous permettant de renseigner les informations nécessaires à la création d'un composant de type requête :
En fonction du type de requête sélectionné, de nouvelles informations doivent être renseignées :
Si vous souhaitez utiliser une requête sauvegardée :
| |
Si vous souhaitez créer une requête de toutes pièces :
|
Un nœud Requête est créé dans l'arbre, sous le nœud sélectionné.
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Compteur' de l'onglet 'Extractions' :
Une boîte de dialogue s'affiche vous permettant de renseigner les informations nécessaires à la création d'un composant de type compteur.
Un composant de type compteur correspond à un composant de type Requête. Les paramètres à renseigner sont globalement les mêmes.
La différence vient du fait que pour un composant de type compteur, on ne remonte que le nombre de contenus renvoyés par la requête. Aucun paramètre correspondant aux colonnes et au tri ne sont donc demandés.
Un nœud Compteur est créé dans l'arbre, sous le nœud sélectionné.
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Requête de correspondance' de l'onglet 'Extractions' :
Une boîte de dialogue s'affiche vous permettant de renseigner les informations nécessaires à la création d'un composant de type requête de correspondance.
Un composant de type requête de correspondance correspond à un composant de type Requête. Les paramètres à renseigner sont globalement les mêmes.
La différence vient du fait que les contenus renvoyés par la requête d'un composant de type requête de correspondance ne sont pas affichés. La requête de correspondance est invisible. De ce fait, aucun paramètre correspondant aux groupe, aux colonnes et au tri ne sont demandés. Le paramètre concernant le nom du tag n'est pas demandé non plus.
Un nœud Requête de correspondance est créé dans l'arbre, sous le nœud sélectionné.
Pour les join solr, il faut toujours mettre des guillements autour du q=
Une clause peut contenir des variables, définies dans un autre nœud de l'arbre. Regarder l'ajout de variables de clause. Le nom de la variable est mise entre accolades, précédées du signe '$'. Exemple :
${le_nom_de_ma_variable}
Une clause peut également servir à faire une jointure avec les composants parents. Le lien vers le composant parent est mis entre accolades, précédé du signe '$'. Utilisez la notation '..' pour remonter au parent direct. Pour remonter aux parents plus lointains, utilisez autant de fois que nécessaire "../". Vous pouvez également indiquer le nom d'un attribut du parent ciblé. Voici quelques exemples :
Contenu du parent direct :
${..}
Contenu du parent N+4 :
${../../../..}
Attribut attribute_A du contenu du parent direct :
${../attribute_A}
Attribut attribute_B du contenu lié par l'attribut attribute_A du contenu du parent N+2 :
${../../attribute_A.attribute_B}
Lors de l'utilisation d'une variable de clause multivaluée, lors d'une jointure sur un attribut multivaluée ou lors de l'autopostage pour les thesaurii, la requête spécifiée peut être modifiée avant son exécution pour tester toutes les valeurs attendues. Exemple, la requête suivante :
my_attribute_A:${../my_parent_multivalued_attribute_A}
devient
my_attribute_A:my_parent_attribute_A_value_1 OR my_attribute_A:my_parent_attribute_A_value_2 OR ...
Vous pouvez ajouter des groupes qui permettent de ne dupliquer que certaines parties des requêtes et non les requêtes entière. Cela permet que ces requêtes, exécutées un certain nombre de fois soient beaucoup plus performantes. Le groupe est mis entre accolades, précédé du signe '#' :
#{my_attribute_A:${../my_parent_mutlivalued_attribute_A}} OR {!ametys join=linkContent->my_attribute_B q='%{#{id:"${../my_parent_multivalued_attribute_B}"}}'}
devient
(my_attribute_A:my_parent_attribute_A_value_1 OR my_attribute_A:my_parent_attribute_A_value_2 OR ...) OR ({!ametys join=linkContent->my_attribute_B q='(id:"my_parent_attribute_A_value_1 OR id:my_parent_attribute_A_value_2 OR ...")'})
Plusieurs règles sont à connaître :
Une variable de clause est définie par un nom et un type de contenu. Sa valeur est fournie à l'exécution via un ou plusieurs contenus appartenant au type de contenu spécifié. La valeur peut ensuite être utilisée dans les clauses des composants.
Le nœud Variable de clause contient toutes les variables de clause. Il est automatiquement créé lors de la création du fichier de définition.
Dans l'outil 'Détails de l'extraction', sélectionnez le nœud Variables de clause et cliquez sur le bouton 'Modifier' de l'onglet 'Extractions'. Une boîte de dialogue s'affiche vous permettant d'ajouter des variables de clause ou de modifier les variables existantes :
Vous pouvez ajouter des variables en cliquant sur le bouton '+'.
Pour rendre une colonne optionnelle, on utilise des variables. A l'exécution, l'utilisateur choisit pour chaque variable si les colonnes qui dépendent de cette variable seront affichées ou non.
Le nœud Colonnes optionnelles contient toutes ces variables. Il est automatiquement créé lors de la création du fichier de définition.
Dans l'outil 'Détails de l'extraction', sélectionnez le nœud Colonnes optionnelles et cliquez sur le bouton 'Modifier' de l'onglet 'Extractions'. Une boîte de dialogue s'affiche, vous permettant de créer une ou plusieurs variables pour les colonnes optionnelles :
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Modifier' de l'onglet 'Extractions' :
Une boîte de dialogue s'affiche vous permettant de modifier les informations du nœud sélectionné. Les champs de la boîte de dialogue dépendent du nœud sélectionné.
Dans l'outil 'Détails de l'extraction', sélectionnez un nœud et cliquez sur le bouton 'Supprimer' de l'onglet 'Extractions' :
Après confirmation de votre part, le nœud sélectionné et tous ses enfants sont supprimés.
Lorsque vous effectuez une modification sur une extraction, une étoile s'affiche dans le nom de l'outil 'Détails de l'extraction' correspondant. Vous pouvez sauvegarder les modifications apportées à l'extraction en cliquant sur le bouton 'Sauvegarder' de l'onglet 'Extractions' :
Sinon, vous pouvez annuler ces modifications en cliquant sur le bouton 'Annuler' de l'onglet 'Extractions' :
Dans l'outil 'Extractions', sélectionnez un fichier de définition et cliquez sur le bouton 'Renommer' de l'onglet 'Extractions' :
Vous pouvez également cliquer sur le bouton 'Renommer' depuis l'outil 'Détails de l'extraction'.
Dans l'outil 'Extractions', sélectionnez un fichier de définition et cliquez sur le bouton 'Supprimer' de l'onglet 'Extractions' :
Les actions sur le partage des extractions sont disponibles sous la rubrique "Partage",
et sont accessibles quand une extraction est sélectionnée.
Ce bouton est disponible uniquement si l'extraction sélectionnée possède une visibilité partagée et permet d'ouvrir l'outil "Droits sur l'extraction"
Cet outil liste les utilisateurs ou groupes ayant accès en lecture et en lecture/écriture sur l'extraction sélectionnée.
Les utilisateurs ou groupes ayant accès en lecture pourront uniquement visualiser l'extraction, sans pouvoir la modifier.
Les utilisateurs ou groupes ayant accès en lecture/écriture pourront visualiser l'extraction, et également la modifier.
Les actions de l'outil "Droits sur l'extraction" sont disponibles dans un onglet "Partage".
Il permet d'ajouter un ou plusieurs utilisateurs à la/les catégorie(s) sélectionnées, et donc ajouter le droit correspondant.
Une fenêtre s'ouvre et permet de sélectionner les utilisateurs à qui donner le droit correspondant.
Il permet d'ajouter un ou plusieurs groupes à la/les catégories sélectionnées, et donc ajouter le droit correspondant.
Une fenêtre s'ouvre et permet de sélectionner les groupes à qui donner le droit correspondant.
Il permet de supprimer cet utilisateur ou ce groupe de la catégorie sélectionnée.
Une fenêtre pop-up s'ouvre pour demander confirmation.
Le bouton "Limiter l'accès" est disponible sur un répertoire ou une extraction.
Ce bouton ouvre l'outil de gestion ci-dessous :
Il est possible de retrouver ce même outil en cliquant sur le bouton "Utilisateurs, Groupes et Droits"/ "Affectation de profils" puis en sélectionnant le contexte "Extraction".
Cet outil permet d'assigner des droits aux répertoires ou aux requêtes, selon les principes suivants :
Tableau récapitulatif:
ID*: identifiant interne utilisé dans les messages de bus et les boutons