Statistiques des commentaires en ligne Confluence

Comment collecter des statistiques de commentaire de page dans Confluence?

Oui, et pourquoi cela pourrait-il être nécessaire?

Pourquoi et pourquoi

Dans le projet dans lequel je suis arrivé à travailler, le processus suivant de préparation et d'approbation des exigences est né:

• Confluence a été utilisé pour la documentation.
• L'équipe des fournisseurs a préparé des descriptions des processus commerciaux et de leurs étapes sous forme de pages séparées selon le modèle.
• Une fois par semaine, un lot de descriptions préparées a été remis au client pour relecture.
• L'équipe client a laissé toutes les questions et ajouts sur la page correspondante sous la forme de commentaires intégrés.
• Et l'équipe du fournisseur a complété le contenu, répondu aux commentaires, fixé des questions pour une étude supplémentaire.
• Si la question est répondue et que le contenu est mis à jour ou que la tâche à étudier est fixée, l'équipe client doit fermer le commentaire.
• Les questions sur un lot de documents de la semaine en cours doivent être fermées au moment du transfert du prochain lot la semaine prochaine.

Chaque semaine, les chefs de projet ont pour tâche de comprendre dans quelle mesure le lot de documents livré a fonctionné et ce qui peut être considéré comme conditionnellement prêt à partir de celui-ci. Et les participants de l'équipe des fournisseurs doivent périodiquement vérifier l'état des commentaires sur leurs documents et travailler de manière ciblée avec les autres. Mais comment les trouver? Vous pouvez ouvrir chaque page, rechercher le premier commentaire dessus avec vos yeux (ou à l'aide d'une petite astuce ), puis cliquer sur tous les commentaires, car l'équipe du client n'est pas pressée de les fermer, de penser à chacun et de chercher une réponse.

Le lot hebdomadaire contient de 50 à 100 pages distinctes, et le faire avec vos mains représente un travail considérable. Et si vous essayez toujours de recueillir des arguments pour convaincre l'autre côté, cela devient très triste. Et il y a aussi des commentaires qui résultent d'une modification incorrecte de la page lorsque le texte source est accidentellement supprimé. Un tel commentaire est visible dans les commentaires résolus, mais il ne peut pas être rouvert (vous pouvez, si vous recréez un marqueur invisible dans le texte de la page).

La recherche d'outils a échoué. De plus, Confluence est déployé côté client, vous ne pouvez pas installer de plugins, sans parler d’acheter. Aucune expertise en développement macro.

À un moment donné, je me suis souvenu de l' API REST Confluence et de mon expérience antérieure avec l'utilisation de l' API Jira similaire. La recherche et les expériences avec les fonctions d'appel à partir du navigateur ont montré que vous pouvez accéder aux commentaires et à leurs propriétés. Ensuite, vous avez dû choisir un outil d'automatisation et vous pouvez commencer à résoudre. J'ai une certaine expérience dans la création de scripts sur des outils plus susceptibles d'être plus proches d'administrateurs comme Bash, Perl, JScript. Je ne suis pas développeur, je n'avais aucun outil familier ou familier. Je voulais essayer quelque chose de plus commun ou convenable. Ensuite, j'ai découvert un wrapper pour l'API Python et j'ai décidé d'essayer avec.

Principe général

Le problème a été formulé comme suit. Vous devez trouver toutes les pages liées à une livraison hebdomadaire spécifique. Recueillez les commentaires sur eux dans une liste: page, lien vers le commentaire, auteur et date du commentaire, texte source sur la page, commentaire et réponses, auteur et date de la dernière réponse, statut du commentaire. En outre, collectez des statistiques pour chaque page, le nombre de commentaires au total, le nombre de dangers, le nombre de messages ouverts. Enregistrez tout sur une page de statistiques spéciale.

Je mets Python, regarde à travers les bases de travailler avec, et allons-y. Créez d'abord une connexion:

from atlassian import Confluence UserLogin = 'xxxxxx' # input("Login: ") UserPwd = 'xxxxxx' # input("Password: ") confluenceURL = 'http://wiki.xxxxxx' confluence = Confluence( url=confluenceURL, username=UserLogin, password=UserPwd) 

Pour rechercher des pages d'un lot hebdomadaire, j'ai décidé d'utiliser des balises. Comment les livrer en masse est une tâche distincte.

 page_label = 'week123' cql = 'space.key={} and label = "{}" and type = page ' 'ORDER BY title '.format('YYY', page_label) pages = confluence.cql(cql, expand=None, start=0, limit=200) 

Nous avons donc obtenu une liste de pages à vérifier. Ensuite, nous commençons à traiter chaque page individuelle. Nous collectons à partir de ses données sur les commentaires avec leurs paramètres. Sur la base de ces données, nous construisons des statistiques sur le nombre de commentaires sur la page et dans quelles conditions. Ensuite, nous supprimons le résultat pour toutes les pages et commençons à formater le résultat. Nous créons le corps de la page avec le résultat sous la forme d'un tableau de statistiques et d'une liste détaillée des commentaires ouverts.

Fonctionnalités de l'API

Voyons maintenant comment traiter la page. Par défaut, l'API renvoie uniquement des informations de base, telles qu'un identifiant ou un nom de page. Toutes les propriétés supplémentaires doivent être spécifiées explicitement. Ils peuvent être vus en analysant le résultat de l'appel. Des données supplémentaires peuvent être trouvées dans les sections ou sous-sections de _expandable. Nous ajoutons l'élément souhaité pour développer et regarder plus loin jusqu'à ce que nous trouvions les données nécessaires.


Et il y a aussi une restriction sur le nombre de résultats publiés, la pagination. Il est configuré côté serveur (API?) Et dans notre cas, il est de 25. Pour certaines demandes, il peut être modifié en spécifiant explicitement, mais cela ne fonctionnera que pour le niveau supérieur. Et révélant des commentaires sur la page, nous n'en obtenons tout de même que 25, tandis que la taille est également fausse. Dans l'exemple, il y en avait 29 en réalité. Nous avons réussi à contourner la pagination des commentaires en utilisant une fonction distincte dans le module Confluence - get_page_comments avec la possibilité de spécifier la taille de la page.

 #    import re #      XML def replace_chars2(in_text): text = re.sub(r'&', '&', in_text) text = re.sub(r'\'', ''', text) text = re.sub(r'<', '<', text) text = re.sub(r'>', '>', text) text = re.sub(r'"', '"', text) return text 

Le prochain écueil attendait les caractéristiques de la préservation et de la délivrance des caractères spéciaux. Le corps d'une page ou d'un commentaire peut être obtenu dans plusieurs vues: XML interne - stockage, HTML intermédiaire sans sortie macro - vue et HTML avec sortie macro - export_view. Mais le titre du titre de la page et le texte original commenté originalSelection sont toujours publiés sous une forme adaptée à la lecture. Parce que à l'avenir, ces données tombent dans le corps de la page avec des statistiques, puis certains caractères ont conduit à des erreurs de conversion. J'ai dû écrire une procédure de remplacement ci-dessus.

Commentaires sur la page

Passons maintenant à l'analyse de la page. Il s'agit d'une procédure qui charge une page, collecte ses données, puis extrait une liste de commentaires avec des réponses et les recueille dans la correspondance. Le résultat est une liste de dictionnaires, où chaque élément de la liste correspond à un commentaire avec des réponses. Et tous les attributs de ce commentaire se trouvent dans les champs correspondants du dictionnaire.

Statistiques et tableaux

Pour la clarté de la présentation des données, nous collectons des statistiques à leur sujet et les organisons sous forme de tableaux.


Pour faire les données sous forme de tableaux, nous ferons une autre procédure. Il forme le code HTML du tableau à partir de la liste des dictionnaires, comme en-têtes il ajoute une ligne à partir des noms des clés du dictionnaire et ajoute une colonne avec des numéros de ligne.

 def create_table(tab_data): tab_start = '<table style="width: 100.00%;"><colgroup><col />' '<col /></colgroup><tbody>' tab_end = '</tbody></table>' tab_code = tab_start + '<tr>' row_num = 1 if len(tab_data) > 0: tab_code += '<th>Num</th>' for key in tab_data[0].keys(): tab_code += '<th>{}</th>'.format(key) tab_code += '</tr>' for row in tab_data: tab_code += '<tr><td>{}</td>'.format(row_num) row_num += 1 for field in row.values(): tab_code += '<td>{}</td>'.format(field) tab_code += '</tr>' tab_code += tab_end + '\n' return tab_code 

Maintenant, tout est prêt. Après avoir étiqueté et exécuté le script, nous obtenons une page qui ressemble à ceci:

PS

Bien sûr, ce n'est pas tout ce qui s'est finalement avéré. Il y a eu une analyse des pages et une recherche d'une macro avec le numéro de tâche dans Jira. Il y avait un étiquetage automatique par numéros de tâches dans Jira et des liens entre eux et Confluence. Il y a eu une comparaison et une vérification des listes de livraison hebdomadaires. Il y avait une sauvegarde des commentaires dans Excel et la collecte de données communes à partir de plusieurs fichiers Excel hebdomadaires. Et récemment, l'analyse des commentaires de Word a été ajoutée.