Méthodologie pour documenter votre application Access

Pour faciliter l'identification des objets de votre base de données et donc la lecture de votre documentation, faites en sorte que leur nom respecte une norme :

• Tables : T_Fournisseur, T_Materiel, etc. ;
• Requêtes : R_Fournisseurs, R_Liste_Materiels, etc. ;
• Formulaires : F_Fournisseur ;
• Colonnes ou champs : Id_Fournisseur, Nom_Fournisseur, etc. ;
• …

Pour garder une vision d'ensemble de l'application et mieux comprendre le fonctionnement de tous ses composants, accompagnez vos explications de schémas et de captures d'écran.

Pensez à bien indenter votre code et à choisir des noms de variables et de fonctions explicites pour faciliter sa relecture.

Utilisez des fonctions génériquesfonctions génériques pour éviter les redondances dans le code et ainsi simplifier sa maintenance. Idéalement, ces fonctions peuvent être regroupées dans des modules séparés, de manière à pouvoir éventuellement les « transporter » rapidement d'une appli à l'autre.

Si vous souhaitez, par exemple, piloter une autre application (Excel, Word, etc.), optez pour des variables objet à liaison anticipée (early binding), c'est-à-dire déclarées dans un type d'objet spécifique, car elles offrent plusieurs avantages :

• les objets à liaison anticipée permettent au compilateur d’allouer de la mémoire et d’effectuer d’autres optimisations avant l’exécution d'une application. Ils sont donc plus rapides que les objets à liaison tardive ;
• l'utilisation du early binding rend également votre code plus lisible et facilite sa gestion. En effet, cette solution permet d'afficher les membres (propriétés, méthodes…) de vos objets au fur et à mesure de l'écriture de votre code (complétion - CTRL + Espace), et vous donne accès à l'aide dynamique sur la syntaxe.

Enfin, pour une meilleure compréhension du code, commentez-le à bon escient, en donnant le rôle de chacune des fonctions et en décrivant ses parties importantes.

Mettez à jour la documentation à chaque fois que vous modifiez le code source ou les objets de la base de données. Si vous enregistrez plusieurs versions de votre application, prévoyez une documentation par version.

Présentez tout d'abord votre application, en énumérant brièvement ses fonctions principales.

Dans notre exemple, notre base Access permet de :

• gérer le matériel informatique de l'entreprise par catégorie (ordinateur, imprimante, serveurs, claviers, etc.) ;
• gérer le stock du matériel : en prêt, en réparation, en stock, hors service, obsolète ;
• gérer les alertes de fin de garantie du matériel ;
• enregistrer et visualiser le journal d'activité des utilisateurs.
• …

Pour avoir une vue d'ensemble de l'application, vous pouvez ensuite ajouter un schéma montrant les interactions entre les différents formulaires, accompagné d'une copie d'écran du formulaire d'accueil avec ses différents menus.

Pour notre gestion de stock, nous présentons tout d'abord sa structure générale :

Puis, le sommaire permettant d'accéder aux différents formulaires :

Et enfin, le formulaire permettant le suivi du stock des matériels informatiques, accessible depuis le sommaire :

Si votre application est utilisée en mode multiutilisateurmultiutilisateurs, vous pouvez également donner ici un schéma de l'architecture frontale/dorsale.

Dans cette partie, commençons par afficher la fenêtre Relations d'Access pour avoir une vue d'ensemble des tables de notre base de données (Onglet Outils de base de données, puis Relations).

Puis décrivons le rôle et la structure de ces tables. Pour cela, on utilise des tableaux comportant trois colonnes pour indiquer le nom des champs, leur type de données et leur description.

IV-A-1. Table T_Materiel▲

IV-A-2. Table T_Fournisseur▲

IV-A-3. …▲

Détaillons ensuite le rôle et la structure des requêtes. Pour mieux décrire leur composition, on va réaliser des copies d'écran de chaque requête affichée en mode création. Vous pouvez pour cela utiliser la touche « Impression écran » de votre clavier, puis coller votre image dans Paint ou Photoshop, pour ensuite la modifier comme vous le souhaitez.

IV-B-1. Requête R_Liste_Fournisseurs▲

Basée sur la table T_Fournisseur, elle permet d'afficher la liste des fournisseurs classée par ordre croissant de leur nom :

Formule pour afficher le nom du fournisseur en majuscules

Sélectionnez

Fournisseur: Majuscule([Nom_Fournisseur])

IV-B-2. …▲

Décrivons ensuite les formulaires. Pour nous aider, on va réaliser des copies d'écran de chaque formulaire affiché en mode création.

IV-C-1. Formulaire F_Sommaire▲

Ce formulaire de démarrage comporte un certain nombre de boutons de commande permettant d'accéder aux différents formulaires :

Nous décrivons ensuite ces différents boutons de commande et leur procédure associée

IV-C-1-a. Bouton de commande Cmd_Liste_Materiels▲

Ce bouton permet d'ouvrir la liste des matériels pour identifier ceux qui sont en stock, en réparation, ou hors service.

Procédure événementielle exécutée sur clic

Sélectionnez

Private Sub Cmd_Liste_Materiels_Click()
    DoCmd.OpenForm "F_LISTE_MATERIELS"
End Sub

IV-C-1-b. Bouton de commande Cmd_ajout_Fiche_Fournisseur▲

Ce bouton permet d'ouvrir le formulaire F_Fournisseur en mode ajout.

Procédure événementielle exécutée sur clic

Sélectionnez

Private Sub Cmd_Ajouter_Fiche_Fournisseur_Click()
    DoCmd.OpenForm "F_FOURNISSEUR", , , , acFormAdd
End Sub

IV-C-1-c. …▲

Poursuivre la description des autres boutons de commande…

IV-C-2. Formulaire F_Liste_Materiels▲

Il s'ouvre depuis le sommaire :

On remarque qu'il comporte un sous-formulaire et des listes déroulantes pour filtrer les données de ce sous-formulaire.

On présente ici un exemple de liste déroulante en plus du contrôle sous-formulaire.

IV-C-2-a. Liste déroulante Cmb_Categorie_Materiel▲

Elle permet de filtrer le sous-formulaire en fonction de la catégorie de matériel choisie.

Elle a comme source de données la table T_Categorie_Materiel :

Procédure événementielle exécutée sur l'événement afterUpdate

Sélectionnez

Private Sub Cmb_Categorie_Materiel_AfterUpdate()
    ' rafraîchit la liste des matériels en fonction des choix effectués sur les listes déroulantes
    RefreshListeMateriels
End Sub

IV-C-2-b. Sous-formulaire SF_Liste_Materiels▲

Le contrôle sous-formulaire est lié au formulaire SF_Liste_Materiels comme vous pouvez le voir sur sa feuille des propriétés :

IV-C-3. …▲

On présente dans cette partie les fonctions et les procédures, et on commente leur code. On utilise pour cela la balise de code disponible dans l'éditeur XML.

IV-D-1. Module M_Automation_Outlook▲

Public Function IsOpenOutlook() As Boolean
    Dim olkApp As Outlook.Application ' variable objet pour faire référence à l'application Outlook

    On Error Resume Next ' passe à la ligne suivante en cas d'erreur
    Set olkApp = GetObject(, "Outlook.Application")
    On Error GoTo 0 ' annule la gestion d'erreur

    If olkApp Is Nothing Then ' si outlook n'est pas ouvert
        IsOpenOutlook = False
    Else ' sinon
        IsOpenOutlook = True
    End If

End Function

Sub sendEmail(olkApp As Object, emailAddr As String, subj As String, msg As String)
    ' envoie l'e-mail d'objet subj et de contenu msg à l'adresse emailAddr
    Dim emailItem As olMailitem ' variable objet pour faire référence à l'objet MailItem
 
    ' Création de l'objet olMailitem
    Set emailItem = olkApp.CreateItem(olMailItem)
    
    With emailItem ' mise à jour des propriétés de l'objet olMailItem
        .To = emailAddr ' adresse e-mail du destinataire
        .Subject = subj ' objet du message
        .BodyFormat = olFormatRichText ' format texte enrichi pour le message
        .HTMLBody = msg ' contenu du message
        .Send ' envoi du message
    End With
    
    ' on libère la variable objet
    Set emailItem = Nothing

End Sub

IV-D-2. Module M_Alertes_Garanties▲

Public Function SendAlertes(obj As" String, msg As String) As Boolean
    ' fonction permettant d'envoyer une alerte aux utilisateurs dont la garantie du matériel arrive à échéance
    On Error GoTo err_SendAlertes ' gestion d'erreur
    Dim db As DAO.Database ' variable pour faire référence à la base de données
    Dim rsAlertes As DAO.Recordset ' variable pour faire référence au recordset lié à la requête affichant la liste des alertes
    Dim olkApp As Object
    Dim msg2 As String

    
    Set db = CurrentDb ' référence à la base courante
    Set rsAlertes = db.OpenRecordset("R_Liste_Alertes_Garanties", dbOpenDynaset) ' ouverture du recordset basé sur la requête R_Liste_Alertes_Garanties
    
    If Not IsOpenOutlook() Then ' teste si Outlook est ouvert
        Dim wsShell As Object
        Set wsShell = CreateObject("WScript.Shell")
        Call wsShell.Run("outlook", 1, True) ' lance Outlook si pas ouvert
    End If
    
    Set olkApp = CreateObject("Outlook.application") ' crée l'objet application d'Outlook
    
    Do Until rsAlertes.EOF ' on parcourt les alertes
        
        If Nz(rsAlertes!E_MAIL) <> "" Then ' si l'utilisateur a une adresse e-mail de renseignée
        
            msg2 = Replace(msg, "FABRICANT_MATERIEL", rsAlertes!FABRICANT)
            msg2 = Replace(msg2, "MODELE_MATERIEL", rsAlertes!MODELE)

            sendEmail olkApp, rsAlertes!E_MAIL, obj, msg2 ' envoi de l'e-mail à l'utilisateur
            
        End If
        
        rsAlertes.Edit
        rsAlertes!ALERTE_GARANTIE = True ' on met la valeur du champ ALERTE_GARANTIE à True
        rsAlertes.Update
        
        rsAlertes.MoveNext ' on passe à l'alerte suivante
    
    Loop
    
    
    SendAlertes = True ' on renvoie True pour indiquer que tout s'est bien passé
    
err_SendAlertes:

    If (Err.Number <> 0) And (SendAlertes = False) Then ' en cas d'erreur
        MsgBox (Err.Description) ' affichage du message d'erreur
    End If
    
    On Error Resume Next
    ' on ferme et libère les variables
    If Not rsAlertes Is Nothing Then
        rsAlertes.Close
    End If
    Set rsAlertes = Nothing
    
    Set db = Nothing
    
    Set olkApp = Nothing
    
End Function

IV-D-3. …▲