Gestion des rapports : Différence entre versions

Aller à : navigation, rechercher
m (Ajouter un champ dans le formulaire des rapports)
m (Configurer les rapports visibles pour les utilisateurs)
 
(38 révisions intermédiaires par 5 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
 +
__TOC__
 +
 
=Présentation=
 
=Présentation=
L'objet de cette page est de présenter la '''gestion des rapports''' sur la [[Accueil|version 4 d'OpenFlyers]].
+
L'objet de cette page est de présenter la gestion des rapports personnalisés sur la [[Accueil|version 4 d'OpenFlyers]].
  
__TOC__
+
A chaque fois qu'OpenFlyers développe un nouveau rapport à la demande d'une structure, l'équipe rajoute ce rapport dans la [[Bibliothèque des rapports]].
  
=Introduction=
+
Nous recommandons aux clients d'éviter de développer leurs propres rapports personnalisés et de faire appel à OpenFlyers afin de compléter la bibliothèque des rapports en fonction de leurs besoins. En effet, seuls les rapports présents dans cette liste sont maintenus à jour par OpenFlyers lors de mises à jour de la structure de la base de données.
A chaque fois qu'OpenFlyers développe un nouveau rapport à la demande d'une structure, l'équipe rajoute ce rapport dans la [[OF_doc-en:Export-generator-4|liste des rapports]]. Nous invitons également les clients ayant développé leurs propres rapports à les rajouter dans cette liste.
+
  
Seuls les rapports présents dans cette liste bénéficient de nos mises à jour lors de changement de version.
+
Pour les clients qui souhaitent néanmoins développer eux-mêmes leurs propres rapports, nous mettons à disposition la [[Structure de la base de données|structure de la base de données]].
 
+
Pour les clients qui souhaiteraient développer eux-mêmes leur rapport, nous mettons à disposition la [[Structure de la base de données|structure de la base de données]].
+
  
 
=Afficher un rapport favori=
 
=Afficher un rapport favori=
  
* Aller dans '''Rapports''' ou '''Admin > Rapports'''
+
* Aller au menu '''Gestion > Rapports > Rapports personnalisés > Visualiser'''
 
* Aller dans une des catégories de rapport
 
* Aller dans une des catégories de rapport
 
* Sélectionner un rapport à visualiser
 
* Sélectionner un rapport à visualiser
Ligne 21 : Ligne 20 :
  
 
=Ajouter un rapport=
 
=Ajouter un rapport=
Dans le cas où le rapport nécessite un ou plusieurs champs non présents dans la plateforme, il faut au préalable [[#Ajouter_un_champ_dans_le_formulaire_des_rapports|créer ce champ]].
+
Dans le cas où le rapport nécessite un ou plusieurs champs non présents dans la plateforme, il faut au préalable [[#Ajouter-un-champ-dans-le-formulaire-des-rapports|créer ce champ]].
*Côté admin, '''Rapports > Rapports personnalisés > Créer/Modifier'''
+
*Côté admin, '''Gestion > Rapports > Rapports personnalisés > Créer/Modifier'''
 
*Tout en bas du tableau, cliquer sur le bouton '''Ajouter'''
 
*Tout en bas du tableau, cliquer sur le bouton '''Ajouter'''
 
*Dans le champ '''Intitulé''', saisir un texte libre permettant de décrire l'objet du rapport
 
*Dans le champ '''Intitulé''', saisir un texte libre permettant de décrire l'objet du rapport
 
*Dans le champ '''Requête SQL''', saisir une requête SQL permettant de générer le rapport
 
*Dans le champ '''Requête SQL''', saisir une requête SQL permettant de générer le rapport
 
*Cliquer sur le bouton '''Valider'''
 
*Cliquer sur le bouton '''Valider'''
 +
 +
==Vérification lors de l'ajout==
 +
Lors du clic sur le bouton '''Valider''', deux vérifications sont effectuées sur la requête :
 +
*La première vérifie que la syntaxe de la requête SQL est correctement écrite.
 +
*La seconde vérifie que les champs et tables mentionnés dans la requête correspondent bien à des champs de la base de données.
  
 
=Ajouter un rapport en favori=
 
=Ajouter un rapport en favori=
  
* Côté admin, '''Rapports > Modifier les rapports favoris'''
+
* Côté admin, '''Gestion > Rapports > Bibliothèque > Accès'''
* Colonne "Favori"
+
* Colonne '''Favori''' : cocher les rapports à mettre en favoris
* Cocher les rapports à mettre en favori
+
  
==Champ de saisie==
+
=Champ de saisie=
  
===Champ de type "dbObject"===
+
==Ajouter un champ dans le formulaire des rapports==
  
Dans le formulaire, le champs de type "dbObject" est représenté sous forme de liste déroulante où est proposé comme choix :
+
Pour permettre de rajouter un paramètre pris en compte lors de la génération d'un rapport, il peut être nécessaire de rajouter un champ de saisie pour l'utilisateur lors d'une demande de rapport. Pour ce faire il faut effectuer les opérations suivantes :
* "Pas de filtre" comme premier choix
+
*'''Gestion > Rapports > Rapports personnalisés > Champs métiers'''
* La liste des différents "objets" comme autre choix. Par exemple, un type "dbObject::Person" va donner la liste des utilisateurs
+
*En bas du tableau :
 +
**Dans le champ vide de la colonne '''Nom de variable''', saisir le nom de la variable sans espace et sans caractère particulier
 +
**Dans le champ '''Intitulé''', saisir le nom en clair qui apparaitra dans le formulaire de saisie des rapports
 +
**Dans le champ '''Type de valeur''', choisir [[Champs-métiers#Type-de-valeur|le type en fonction du champ]]
 +
**Cocher ou non la case à cocher '''Remplissage obligatoire''' pour indiquer que le champ doit être systématiquement saisi lorsqu'il est mentionné dans la requête SQL
 +
**Dans le champ '''Valeur d'affichage maximum''', si la saisie est possible, mettre la valeur maximum ou la valeur -1 s'il n'y a pas de valeur maximum
 +
*Cliquer sur le bouton '''Ajouter'''
 +
'''Attention :''' cette étape doit être effectuée avant d'[[#Ajouter-un-rapport|ajouter une requête SQL pour un rapport]] qui fait [[Fonctionnement-du-moteur-des-rapports#Remplacement-des-variables|référence au nouveau champ]].
  
Une variable associé à ce type de champ recevra comme valeur possible :
+
==Case à cocher '''Mémoriser ce choix'''==
* Lorsque "Pas de filtre" est sélectionné, le caractère : -
+
* Lorsqu'une valeur est sélectionnée, un id sous forme de nombre
+
  
Exemple de prise en compte de la variable au niveau du rapport : Liste des utilisateurs actifs possédant le profil "$profileId"
+
Cette fonctionnalité n'est présente que sur les rapports de la [[Fonctionnement-du-moteur-des-rapports#Bibliothèque-des-rapports|bibliothèque]]. Pour rendre visible la case à cocher '''Mémoriser ce choix''' au niveau de chaque champ du formulaire, il faut disposer du droit [[Gestion-des-profils#Gestion-des-rapports|Gestion des rapports]] ou du droit [[Gestion-des-profils#Voir-tous-les-rapports|Voir tous les rapports]].
<sql>SELECT person.*
+
FROM person
+
LEFT JOIN profile ON person.profile & profile.id
+
WHERE profile.id='$profileId'
+
  AND activated=1</sql>
+
  
Exemple de prise en compte de la variable au niveau du rapport : Liste des utilisateurs actifs avec ou non, un filtre sur le profil
+
La case à cocher '''Mémoriser ce choix''' permet de mémoriser la sélection d'un champ dans le formulaire d'un rapport afin de simplifier une future exécution du rapport. Cette case à cocher est par défaut cochée. La mémorisation du choix n'est pas propre à un utilisateur mais à la plateforme.
<sql>SELECT *
+
FROM person
+
LEFT JOIN profile ON person.profile & profile.id
+
WHERE ( profile.id='$profileId' OR '-'='$profileId' )</sql>
+
  
===Champ de type "dbObjectMulti"===
+
==[[Champs-métiers#Type-de-valeur|Type de valeur]]==
 
+
Dans le formulaire, le champ de type "dbObjectMulti" est représenté sous forme de liste de cases à cocher où est proposé comme choix :
+
* La liste des différents "objets" comme autre choix. Par exemple, un type "dbObjectMulti::Profile" va donner la liste des profils
+
 
+
Une variable associé à ce type de champ recevra comme valeur possible :
+
* Lorsque rien n'est coché, la chaîne : '-'. Cela est considéré comme "Pas de filtre".
+
* Lorsqu'une valeur est cochée, un id sous forme de nombre
+
* Lorsque plusieurs valeurs sont cochées, plusieurs id sous forme de chaîne suivante : 1,2,3
+
 
+
Exemple de prise en compte de la variable au niveau du rapport : Liste des utilisateurs actifs possédant le profil "$profileId"
+
<sql>SELECT person.*
+
FROM person
+
LEFT JOIN profile ON person.profile & profile.id
+
WHERE profile.id IN ($profileId)
+
  AND activated=1</sql>
+
 
+
Exemple de prise en compte de la variable au niveau du rapport : Liste des utilisateurs actifs avec ou non, un filtre sur le profil
+
<sql>SELECT *
+
FROM person
+
LEFT JOIN profile ON person.profile & profile.id
+
WHERE ( profile.id IN ($profileId) OR '-' IN ($profileId) )</sql>
+
  
 
=[[Configuration#Reporting/Export|Configurer la mise en forme des rapports]]=
 
=[[Configuration#Reporting/Export|Configurer la mise en forme des rapports]]=
  
 
=Configurer les rapports visibles pour les utilisateurs=
 
=Configurer les rapports visibles pour les utilisateurs=
Pour rendre tous les rapports visibles à un profil d'utilisateurs, cela se paramètre en attribuant le droit [[Gestion des profils#Généralités_Admin|Voir tous les rapports]] au profil souhaité. Les rapports seront alors visible côté admin.
+
Pour rendre tous les rapports visibles à un profil d'utilisateurs, cela se paramètre en attribuant le droit [[Gestion-des-profils#Voir-tous-les-rapports|Voir tous les rapports]] au profil souhaité. Les rapports seront alors visible côté admin.
  
Pour rendre uniquement certains rapports visibles à certains profils d'utilisateurs, il faut disposer du droit [[Gestion des profils#Généralités_Admin|Gestion des rapports]] et effectuer les actions suivantes :
+
Pour rendre uniquement certains rapports visibles à certains profils d'utilisateurs, il faut disposer du droit [[Gestion-des-profils#Gestion-des-rapports|Gestion des rapports]] et effectuer les actions suivantes :
*'''Rapports > Rapports personnalisés > Créer/Modifier''' ou '''Rapports > Modifier les rapports favoris'''
+
*'''Gestion > Rapports > Rapports personnalisés > Créer/Modifier''' ou '''Gestion > Rapports > Bibliothèque > Accès'''
 
*Sélectionner la check-box correspondant à l'intersection de la colonne du profil pour lequel le rapport doit être visible avec la ligne du rapport concerné
 
*Sélectionner la check-box correspondant à l'intersection de la colonne du profil pour lequel le rapport doit être visible avec la ligne du rapport concerné
Les rapports rendus visibles pour les profils considérés sont consultables côté cahier dans le menu '''Données > Rapports'''.
+
Les rapports rendus visibles pour les profils considérés sont consultables dans les menus correspondants :
 +
**'''Gestion > Activités > Rapports'''
 +
**'''Gestion > Comptes > Rapports'''
 +
**'''Gestion > Rapports > Statistiques Aeral'''
 +
**'''Gestion > Utilisateurs > Rapports'''
 +
**'''Planning > Données > Rapports sur les réservations'''
 +
**'''Planning > Données > Rapports utilisateur > Rapports personnalisés'''
  
 
=[[Fonctionnement du moteur des rapports]]=
 
=[[Fonctionnement du moteur des rapports]]=
 
=Rapports=
 
==[[OF_doc-en:Export-generator-4|Bibliothèque des rapports]]==
 
 
==Tentatives de paiement par carte bancaire en ligne==
 
Ce rapport permet d'avoir la liste des tentatives de paiement entre 2 dates.
 
 
Rapport : [[OF_doc-en:Accounting-reports-3#online_payment_attempts_list|online payment attempts list]]
 
 
==Total des heures de vol par pilote==
 
Ce rapport mis par défaut lors du paramétrage d'une plateforme aéronautique permet d'avoir le total des heures de vol par pilote dans l'année.
 
 
Rapport : [[OF_doc-en:Reports-3#Flight-hours-total-per-pilot|Flight hours total per pilot]]
 
 
==Utilisateurs dont une validité X expire l'année Y==
 
''Ce rapport n'est pas mis par défaut lors du paramétrage d'une plateforme. Il doit donc être [[#Ajouter_un_rapport|ajouté]].''
 
 
Ce rapport permet d'avoir la liste des utilisateurs dont une validité X indiquée dans le champ '''Type de validité''' expire l'année Y indiquée dans le champ '''Année'''.
 
 
Il est permet d'avoir la liste des utilisateurs à jour de leur cotisation. Pour cela, il faut :
 
*Dans le champ '''Type de validité''', choisir ''Cotisation''
 
*Dans le champ '''Année''', choisir l'année en cours
 
*Sélectionner le rapport ''Liste des utilisateurs dont une validité X expire l'année Y''
 
*Cliquer sur le bouton '''Visualiser'''
 
 
Rapport : [[OF_doc-en:Users-reports-3#Users-with-expire-date-validity-equals-a-given-year|Users-with-expire-date-validity-equals-a-given-year]]
 
 
=Rendre des liens cliquables=
 
 
Par défaut, si du contenu dans les rapports produit des liens, ceux-ci ne sont pas cliquables.
 
 
Pour que les liens le deviennent, ceux-ci doivent être sur la forme :
 
<pre>[LINK=lien_cliquable]Du texte[/LINK]</pre>
 
 
Par exemple :
 
<pre>[LINK=http://openflyers.com]Site OpenFlyers[/LINK]</pre>
 
 
Exemple de construction de lien permettant d'éditer les 50 derniers vols :
 
<sql>SELECT CONCAT( '[LINK=index.php?menuAction=flight_record&menuParameter=', flight.id, ']Edit[/LINK]' ) AS Link, flight.*
 
FROM flight
 
WHERE flight.validated=0
 
ORDER BY flight.start_date DESC LIMIT 50</sql>
 
 
=Statistiques aeral=
 
La procédure suivante a été réalisée pour les demandes de statistiques aeral de l'année 2013. Elle est valable pour les années suivantes sauf si les statistiques aeral sont modifiées. Dans ce cas, nous vous invitons à contacter l'équipe OpenFlyers pour signaler les modifications.
 
 
==Adhérents par activité==
 
[[File:Rapport_AERAL_adherent.png]]
 
 
Le tableau se remplit à l'aide du rapport [[OF_doc-en::Export-generator-4#Number-of-men,-women-over-and-under-21-years-for-profile-X,-validity-Y-up-to-date-for-year-Z|Nombre d'hommes, femmes plus et moins de 21 ans pour le profil X, la validité Y à jour pour l'année Z]].
 
 
Il faut sélectionner la validité ''Cotisation'', l'année passée et le profil à visualiser s'il faut restreindre les personnes à compter à un profil donné. Sinon, il faut laisser le profil vide.
 
 
==Brevets, qualifications ou licences==
 
 
[[FILE:Rapport_AERAL_validite.png]]
 
 
Le tableau se remplit à l'aide du rapport [[OF_doc-en::Export-generator-4#Validities_in_the_year_:_Total_of_youngs/adults_with_specific_profile|Validité de l'année : Nombre de personne de plus et moins de 21 ans pour le profil sélectionné]] où il faut sélectionner l'année et le profil à visualiser.
 
 
==Activité en instruction==
 
 
[[FILE:Rapport_AERAL_hdv_instruction.png]]
 
 
Pour remplir ces deux formulaires, utiliser :
 
* Le rapport [[OF_doc-en::Export-generator-4#Flight_type_:_Flight_hours_total_on_instruction_with_specific_profile|Heures de vol en instruction sur le profil et type de vol sélectionnés]] où il faut sélectionner l'année et le profil à visualiser. Sélectionner le type de vol "Local" pour avoir le total "VFR Jour local", le type de vol "Navigation" pour le total "VFR Jour navigation", etc.
 
* Le rapport [[OF_doc-en::Export-generator-4#Flight_hours_total_on_instruction_:_male,_female,_less_than_21_years_and_more_than_21_years_with_specific_profile|Heures de vols en instruction par homme/femme et plus/moins de 21 ans sur le profil sélectionné]] où il faut sélectionner l'année et le profil à visualiser.
 
 
==Activité hors instruction==
 
 
[[FILE:Rapport_AERAL_hdv_hors_instruction.png]]
 
 
Pour remplir ces deux formulaires, utiliser :
 
* Le rapport [[OF_doc-en::Export-generator-4#Flight_type_:_Flight_hours_total_on_non-instruction_with_specific_profile|Heures de vol hors instruction sur le profil et type de vol sélectionnés]] où il faut sélectionner l'année et le profil à visualiser. Sélectionner le type de vol "Local" pour avoir le total "VFR Jour local", le type de vol "Navigation" pour le total "VFR Jour navigation", etc.
 
* Le rapport [[OF_doc-en::Export-generator-4#Flight_hours_total_on_non-instruction_:_male,_female,_less_than_21_years_and_more_than_21_years_with_specific_profile|Heures de vols hors instruction par homme/femme et plus/moins de 21 ans sur le profil sélectionné]] où il faut sélectionner l'année et le profil à visualiser.
 
 
==Toutes activités dont mouvements==
 
 
[[FILE:Rapport_AERAL_activite_mouvement.png]]
 
 
Le nombre de mouvements s'obtient avec le rapport [[OF_doc-en::Export-generator-4#Number_of_movements_on_based_airfield_on_specific_profile|Nombre de mouvements sur l'aérodrome basé sur le profil sélectionné]] où il faut sélectionner l'année et le profil à visualiser.
 

Version actuelle en date du 12 mars 2020 à 16:11

Présentation

L'objet de cette page est de présenter la gestion des rapports personnalisés sur la version 4 d'OpenFlyers.

A chaque fois qu'OpenFlyers développe un nouveau rapport à la demande d'une structure, l'équipe rajoute ce rapport dans la Bibliothèque des rapports.

Nous recommandons aux clients d'éviter de développer leurs propres rapports personnalisés et de faire appel à OpenFlyers afin de compléter la bibliothèque des rapports en fonction de leurs besoins. En effet, seuls les rapports présents dans cette liste sont maintenus à jour par OpenFlyers lors de mises à jour de la structure de la base de données.

Pour les clients qui souhaitent néanmoins développer eux-mêmes leurs propres rapports, nous mettons à disposition la structure de la base de données.

Afficher un rapport favori

  • Aller au menu Gestion > Rapports > Rapports personnalisés > Visualiser
  • Aller dans une des catégories de rapport
  • Sélectionner un rapport à visualiser
  • Compléter le formulaire qui s'affiche
  • Appuyer sur le bouton Visualiser
  • Le contenu du rapport va s'afficher dans un nouvel onglet

Ajouter un rapport

Dans le cas où le rapport nécessite un ou plusieurs champs non présents dans la plateforme, il faut au préalable créer ce champ.

  • Côté admin, Gestion > Rapports > Rapports personnalisés > Créer/Modifier
  • Tout en bas du tableau, cliquer sur le bouton Ajouter
  • Dans le champ Intitulé, saisir un texte libre permettant de décrire l'objet du rapport
  • Dans le champ Requête SQL, saisir une requête SQL permettant de générer le rapport
  • Cliquer sur le bouton Valider

Vérification lors de l'ajout

Lors du clic sur le bouton Valider, deux vérifications sont effectuées sur la requête :

  • La première vérifie que la syntaxe de la requête SQL est correctement écrite.
  • La seconde vérifie que les champs et tables mentionnés dans la requête correspondent bien à des champs de la base de données.

Ajouter un rapport en favori

  • Côté admin, Gestion > Rapports > Bibliothèque > Accès
  • Colonne Favori : cocher les rapports à mettre en favoris

Champ de saisie

Ajouter un champ dans le formulaire des rapports

Pour permettre de rajouter un paramètre pris en compte lors de la génération d'un rapport, il peut être nécessaire de rajouter un champ de saisie pour l'utilisateur lors d'une demande de rapport. Pour ce faire il faut effectuer les opérations suivantes :

  • Gestion > Rapports > Rapports personnalisés > Champs métiers
  • En bas du tableau :
    • Dans le champ vide de la colonne Nom de variable, saisir le nom de la variable sans espace et sans caractère particulier
    • Dans le champ Intitulé, saisir le nom en clair qui apparaitra dans le formulaire de saisie des rapports
    • Dans le champ Type de valeur, choisir le type en fonction du champ
    • Cocher ou non la case à cocher Remplissage obligatoire pour indiquer que le champ doit être systématiquement saisi lorsqu'il est mentionné dans la requête SQL
    • Dans le champ Valeur d'affichage maximum, si la saisie est possible, mettre la valeur maximum ou la valeur -1 s'il n'y a pas de valeur maximum
  • Cliquer sur le bouton Ajouter

Attention : cette étape doit être effectuée avant d'ajouter une requête SQL pour un rapport qui fait référence au nouveau champ.

Case à cocher Mémoriser ce choix

Cette fonctionnalité n'est présente que sur les rapports de la bibliothèque. Pour rendre visible la case à cocher Mémoriser ce choix au niveau de chaque champ du formulaire, il faut disposer du droit Gestion des rapports ou du droit Voir tous les rapports.

La case à cocher Mémoriser ce choix permet de mémoriser la sélection d'un champ dans le formulaire d'un rapport afin de simplifier une future exécution du rapport. Cette case à cocher est par défaut cochée. La mémorisation du choix n'est pas propre à un utilisateur mais à la plateforme.

Type de valeur

Configurer la mise en forme des rapports

Configurer les rapports visibles pour les utilisateurs

Pour rendre tous les rapports visibles à un profil d'utilisateurs, cela se paramètre en attribuant le droit Voir tous les rapports au profil souhaité. Les rapports seront alors visible côté admin.

Pour rendre uniquement certains rapports visibles à certains profils d'utilisateurs, il faut disposer du droit Gestion des rapports et effectuer les actions suivantes :

  • Gestion > Rapports > Rapports personnalisés > Créer/Modifier ou Gestion > Rapports > Bibliothèque > Accès
  • Sélectionner la check-box correspondant à l'intersection de la colonne du profil pour lequel le rapport doit être visible avec la ligne du rapport concerné

Les rapports rendus visibles pour les profils considérés sont consultables dans les menus correspondants :

    • Gestion > Activités > Rapports
    • Gestion > Comptes > Rapports
    • Gestion > Rapports > Statistiques Aeral
    • Gestion > Utilisateurs > Rapports
    • Planning > Données > Rapports sur les réservations
    • Planning > Données > Rapports utilisateur > Rapports personnalisés

Fonctionnement du moteur des rapports