Sage 100 CRM Guide de l Analyseur de Logs Intégration de Sage 100 CRM Version 8

Transcription

1 Sage 100 CRM Guide de l Analyseur de Logs Intégration de Sage 100 CRM Version 8 Mise à jour : 2015 version 8

2 Composition du progiciel Votre progiciel est composé d un boîtier de rangement comprenant : le cédérom sur lequel est enregistré le programme. Propriété & Usage Ce logiciel et sa documentation sont protégés par le Code de la Propriété Intellectuelle, les lois relatives au copyright et les traités internationaux applicables. Toute utilisation non conforme du logiciel, et notamment toute reproduction ou distribution partielle ou totale du logiciel ou toute utilisation audelà des droits acquis sur le logiciel est strictement interdite. Toute personne ne respectant pas ces dispositions se rendra coupable de délit de contrefaçon et sera passible des peines pénales prévues par la loi. La marque Sage est une marque protégée. Toute reproduction totale ou partielle de la marque Sage, sans l autorisation préalable et expresse de la société Sage est donc prohibée. Tous les noms de produits ou de sociétés, toute image, logo ou représentation visuelle mentionnés dans ce logiciel ou sa documentation et n appartenant pas à Sage peuvent constituer des marques déposées par leurs propriétaires respectifs. Conformité & Mise en garde Evolution Compte tenu des contraintes inhérentes à la présentation sous forme de manuel électronique, les spécifications visées dans la présente documentation constituent une illustration aussi proche que possible des spécifications. Il appartient au client, parallèlement à la documentation, de mettre en œuvre le progiciel pour permettre de mesurer exactement l adéquation de ses besoins aux fonctionnalités. Il est important, pour une utilisation sûre et opérationnelle du progiciel, de lire préalablement la documentation. La documentation correspond à la version référencée. Entre deux versions, des mises à jour du logiciel peuvent être opérées sans modification de la documentation. Toutefois, un additif peut être joint à la documentation existante pour présenter les modifications et améliorations apportées à ces mises à jour. Mise à jour : 2015 version 8

3 Sommaire 2015 Sage 3

4 Introduction Présentation Ce guide est destiné aux utilisateurs et administrateurs système de Sage 100 CRM dans le cadre de l utilisation du composant Sage 100 CRM Analyseur de logs intégration. Ce composant est une application.net écrite en C# et utilise les extensions.net de Sage 100 CRM. L analyseur de logs intégration met à disposition une interface conviviale permettant d analyser simplement les informations de synchronisation contenues dans les logs d intégration, d identifier les éventuelles erreurs de synchronisation et de proposer des solutions pour les erreurs référencées. Prérequis : Guide de l'utilisateur Sage 100 CRM Guide de l'administrateur système Sage 100 CRM. Guide de l intégration Sage Ce guide décrit l'utilisation des fonctionnalités d'utilisateur et d'administrateur système liées à ce composant. Ce guide est présenté dans le thème Classique. Pour toute utilisation relative au thème Moderne défini par défaut, veuillez-vous reporter au guide de démarrage rapide : Conditions préalables Pour utiliser l analyseur de logs intégration, vous devez Connaître son périmètre fonctionnel Disposer d une version 8 de Sage 100 CRM i7 installée Disposer du service Web d intégration Sage 100 i7 Vérifier l autorisation en écriture du répertoire CustomPages 2015 Sage 4

5 Utilisation Accès à l analyseur de logs intégration Installé automatiquement, l analyseur de logs intégration est accessible depuis l onglet Analyseur de Log intégration de la fiche intégration. (Menu Administration, bouton ) Analyse des logs présents dans le répertoire logs de Sage 100 CRM L analyseur de logs offre l avantage de pouvoir analyser n importe quel log d intégration présent dans le répertoire logs de Sage 100 CRM, bien évidemment les logs issus des intégrations déclarées dans le dossier Sage 100 CRM courant, mais également des logs issus d autres dossiers Sage 100 CRM et copiés dans le répertoire logs du dossier courant. Pour analyser un log d intégration provenant d un autre dossier Sage 100 CRM, il suffit de copier le fichier log dans le répertoire logs du dossier courant. Le nom du dossier apparaîtra alors automatiquement dans la liste des dossiers proposés dans l interface de l analyseur de logs. L analyseur de logs analyse automatiquement l ensemble des logs d intégration présents dans le répertoire logs et propose de choisir les logs en les classant alphabétiquement par nom d intégration puis pour chaque nom par ordre décroissant par date. Dans ce mode, la liste des noms d intégration affichés provient des logs trouvés dans le répertoire logs même si les fiches d intégration n existent pas dans le dossier courant Sage 5

6 Analyse des logs d une intégration déclarée dans le dossier courant Pour accéder directement aux logs concernant une intégration, affichez la fiche de l intégration concernée, puis cliquez sur l onglet Analyseur de Log intégration de la fiche intégration. L analyseur de logs propose alors uniquement l analyse des logs liés à l intégration courante Sage 6

7 Les logs de démonstration DEMOBijou et DEMOError Deux logs sont automatiquement copiés dans le répertoire des logs Sage 100 CRM lors de l installation de l analyseur de logs. Ils permettent de découvrir les fonctionnalités de l analyseur de logs même si aucune intégration n a encore été définie dans le dossier courant et si aucun fichier de log d intégration n est à disposition. Log de démonstration DEMOBijou Ce fichier de log correspond à une synchronisation initiale du dossier BIJOU suivie de synchronisations différentielles. Il permet de se familiariser rapidement avec l analyseur de logs. Log de démonstration DEMOError Ce log a été créé artificiellement et regroupe un ensemble d erreurs classiques pouvant être rencontrées en exploitation. Il permet à la fois d avoir une vue d ensemble des erreurs référencées avec leur description et solution éventuelle et aussi de se familiariser avec la consultation des erreurs dans un log d intégration Sage 7

8 Structure des logs traités L analyseur de logs ne permet pas de regrouper en un seul log des logs de plusieurs jours. Il conviendra de concaténer ces logs dans un seul fichier log pour avoir une analyse complète. Chaque fichier de logs d intégration présent dans le répertoire logs est automatiquement proposé à condition que son nom respecte la normalisation des noms de fichiers de logs d intégration sous la forme : <DATE AAAAMMJJ>integrationlog<NOM>.log (exemple integrationlogBijou.log). Il convient de respecter cette normalisation dans le cas où vous souhaitez renommer un fichier de log. La structure interne d un log d intégration est constituée de lignes contenant chacune 5 colonnes séparées par des tabulations. Il est impératif de conserver ce format et par conséquent déconseillé de récupérer des logs par copier/coller du contenu, cette opération risquant de perdre les tabulations. Le message La structure du fichier de logs est incorrecte sera affiché si le fichier de log ne contient aucune ligne comportant 5 colonnes séparées par des tabulations Sage 8

9 Utilisation générale de l analyseur de logs Choix d un log et demande d analyse L analyseur de logs comporte un entête permettant de choisir le log à analyser et le mode d affichage des résultats et un bouton Analyser permettant de lancer le traitement d analyse du log choisi. Les champs suivants sont disponibles lors du choix d un log. Libellé Logs d intégration Journal à analyser Regrouper les synchronisations Description Liste des différents noms d intégration associés à des fichiers de logs triée par ordre alphabétique (bloqué sur le nom de l intégration courante si l analyseur de logs est lancé depuis la fiche intégration courante). Liste des logs associés au nom de l intégration choisie. Les logs sont affichés par ordre décroissant de date, donc du plus récent au plus ancien. La taille de chaque log est affichée à droite de la date du log. Cette case à cocher est activée par défaut et permet de regrouper toutes les synchronisations d une journée au lieu de les afficher chacune. Lorsque la case à cocher Regrouper les synchronisations est décochée, elle permet de consulter chacune des synchronisations contenues dans le fichier de log. Néanmoins dans le cas où de nombreuses synchronisations sont contenues dans le log la volumétrie des informations renvoyées par l analyseur de logs risquera de provoquer des ralentissements d affichage. Pour afficher les informations du log choisi, cliquez sur le bouton Analyser. Lancer l analyse du log sélectionné Afin de faciliter la consultation successive de plusieurs journées de logs, le choix d un fichier de logs depuis la liste de choix Journal à analyser provoque automatiquement l analyse du nouveau log sans nécessité de cliquer sur le bouton Analyser. Astuce : Le focus est donné au champ Journal à analyser après chaque analyse d un log. Depuis ce champ, il est alors possible via les touches flèches haut et flèches bas de consulter successivement l ensemble des logs rattachés à un dossier Sage 9

10 Consultation du résultat d analyse Après analyse, les informations concernant le log sont affichées dans une grille avec une ligne récapitulative pour chaque synchronisation (ou une seule ligne récapitulative globale si la case à cocher Regrouper les synchronisations est cochée) suivie d une ligne pour chaque entité concernée par le contrat d intégration. Si la case à cocher Regrouper les synchronisations est décochée, les synchronisations d une journée sont affichées par ordre décroissant d heure d exécution, c est donc toujours la synchronisation la plus récente qui est affichée en premier. Pour faciliter la lecture la première synchronisation affichée est par défaut toujours dépliée. Les symboles et situés à gauche de la grille permettent respectivement de déplier ou replier les informations contenues dans la grille Sage 10

11 Description des colonnes de la grille Lignes récapitulatives d une synchronisation Chaque ligne récapitulative d une synchronisation comporte les colonnes suivantes : Libellé Date Durée De l ERP Du CRM Erreurs entité Autres erreurs Description Date et heure du lancement de la synchronisation (ou de la première synchronisation si la case à cocher regrouper les synchronisations est cochée) Temps total de la synchronisation (ou de la totalité des synchronisations si la case à cocher regrouper les synchronisations est cochée) Nombre de fiches provenant de l ERP et synchronisées en création ou modification dans le CRM Nombre de fiches provenant du CRM et synchronisées en création ou modification dans l ERP. Nombre d erreurs provoquées concernant la synchronisation d entités. Un lien hypertexte sur le nombre permet d accéder directement à la consultation des erreurs. (cf. Paragraphe des erreurs) Nombre d erreurs provoquées ne concernant pas directement la synchronisation d entités (par exemple un problème de connexion au service Web). Un lien hypertexte sur le nombre permet d accéder directement à la consultation des erreurs. (cf. Paragraphe des erreurs) N ligne N de la première ligne dans le fichier de log concernant la synchronisation courante Sage 11

12 Lignes concernant les entités synchronisées Chaque ligne concernant les informations d une entité comporte les colonnes suivantes : Libellé Entité Durée Tps/Fiche Nb lots De l ERP Du CRM Nb d erreurs Description Nom de l entité synchronisée Temps de la synchronisation de l entité pour la synchronisation courante (ou de la totalité du temps de synchronisation de l entité de la journée si la case à cocher regrouper les synchronisations est cochée) Temps de traitement moyen par fiche de l entité. (Cet indicateur permet éventuellement de détecter des temps anormaux de traitement pouvant provenir de problèmes concernant l ERP ou la base Sage 100 CRM). Nombre de lots récupérés de l ERP. Un lien hypertexte sur le nombre permet d accéder directement à la consultation des temps de traitement de chaque lot. (cf. Paragraphe Consultation des logs GetChangeLog) Nombre de fiches de l entité provenant de l ERP et synchronisées en création ou modification dans le CRM. Nombre de fiches de l entité provenant du CRM et synchronisées en création ou modification dans l ERP. Nombre d erreurs provoquées concernant la synchronisation de l entité courante. Un lien hypertexte sur le nombre permet d accéder directement à la consultation des erreurs. (cf. Paragraphe des erreurs) N ligne N de la première ligne dans le fichier de log concernant la synchronisation de l entité courante Sage 12

13 Consultation des erreurs Si des erreurs ont été provoquées lors de la synchronisation, elles sont mentionnées par un nombre en rouge avec un lien hypertexte permettant de consulter le détail des erreurs. Les erreurs identifiées par l analyseur de logs concernent : les erreurs majeures identifiées dans le fichier de logs par le mot clé ERROR : les avertissements identifiés dans le fichier de logs par le terme RecoverableError les erreurs système identifiées dans le fichier de logs par le terme System.Web.Services.Protocols.SoapException. Le clic sur le nombre d erreurs permet d afficher une nouvelle fenêtre affichant le détail des erreurs. Une base de connaissances intégrée à l analyseur de logs est automatiquement exploitée afin de chercher si une erreur est déjà connue et proposer dans ce cas une description et des propositions de solutions : Cette base de connaissances est stockée dans le fichier XmlLogAnalyserErrorFile.XML. Ce fichier est copié dans le répertoire CustomPages du dossier Sage 100 CRM lors de l installation de l analyseur de logs. Grâce à l utilisation des expressions régulières, des termes clés contenus dans les messages d erreur sont comparés par rapport à ceux référencés dans le fichier XML afin de récupérer les descriptions et propositions de solutions associées. Attention! Bien que consignées à partir de situations clients réelles, les descriptions et propositions de solutions sont uniquement affichées à titre indicatif. L utilisateur devra vérifier si la solution proposée est adaptée à la situation avant de l appliquer et devra faire appel à son service assistance en cas de doute Sage 13

14 Des informations complémentaires sont disponibles pour chaque erreur. Ces informations concernent la date et heure de chaque occurrence de l erreur et le N de ligne dans le journal de logs courant. Le clic sur chaque symbole ou en face de chaque erreur permet de déplier les informations complémentaires concernant l erreur. Dans le cas où une erreur SQL a été provoquée par Sage 100 CRM, la solution préconisée propose d ouvrir le fichier de log SQL Sage 100 CRM. Les fichiers de logs SQL comme l ensemble des fichiers de logs Sage 100 CRM sont stockés dans le répertoire logs de l application Sage 100 CRM. Les noms des fichiers sont sous la forme <DATE AAAAMMJJ>ewaresql.log. Il conviendra alors d ouvrir le fichier de log de même date que le fichier de log de l intégration, se repérer par la date et heure et consulter les erreurs SQL. Attention! Si vous utilisez l analyseur de logs pour consulter des logs rapatriés d autres dossiers Sage 100 CRM et si une erreur SQL est trouvée, il faudra également avoir à disposition les fichiers de logs SQL pour pouvoir les consulter. Pensez à les copier en même temps que les fichiers de logs d intégration Sage 14

15 Chaque erreur est identifiée par les colonnes suivantes : Libellé Entité Nb Description Nom de l entité concernée par l erreur. Cette colonne n apparaît pas si la consultation des erreurs a été demandée depuis la colonne Autres erreurs. Nombre d occurrences de la même erreur. Afin d éviter de surcharger inutilement la grille des erreurs, les erreurs strictement identiques sont regroupées ensemble. Une info bulle sur chaque ligne d erreur affiche les N de toutes les lignes du fichier de logs où l erreur est présente (ou des premières lignes si le nombre dépasse la capacité d affichage de l info bulle). Description Solution Message Information extraite de la base de connaissances incluse dans l analyseur de logs si le message d erreur a été identifié. Propositions de solution extraites de la base de connaissances incluse dans l analyseur de logs si le message d erreur a été identifié. Message d origine de l erreur tel qu il est indiqué dans le fichier de logs Sage 15

16 Filtres applicables sur les données de la grille Il est possible de cibler la consultation sur des informations précises. L entête de l analyseur de logs se complète automatiquement avec trois champs de filtre dès que l analyse d un log a été effectuée. Les trois champs de filtre sont décrits ci-dessous : Libellé Entités à afficher N afficher que les lignes avec fiches N afficher que les lignes avec erreur Description Liste multi-choix des entités concernées par une synchronisation. Cette liste permet de sélectionner la ou les entités dont on souhaite plus particulièrement analyser le résultat. Pour annuler la sélection, choisir la valeur -- Tout --. Case à cocher permettant de n afficher que les lignes de la grille contenant des erreurs ou des fiches synchronisées. Case à cocher permettant de n afficher que les lignes de la grille contenant des erreurs. Les champs de filtre sont cumulatifs, il est ainsi possible par exemple, de ne visualiser que les éléments concernant les comptes et si des fiches ont été synchronisées pour ces comptes. La liste de choix des entités affiche le code et le libellé de l entité (exemple : Account (Compte)). Le libellé n étant pas stocké dans le fichier de logs, est lu dynamiquement par rapport aux métadonnées du dossier Sage 100 CRM courant. Par conséquent, les libellés peuvent éventuellement ne pas être en phase avec le paramétrage effectué sur le dossier duquel ont été rapatriés les logs à analyser. Exemple de filtre : N afficher que les informations concernant les comptes 2015 Sage 16

17 Exemple de filtre : N afficher que les entités ayant des fiches synchronisées Exemple de filtre : N afficher que les lignes de la grille comportant des erreurs 2015 Sage 17

18 Consultation des lots (GetChangeLog) Lors de la demande faite par Sage 100 CRM à l ERP d envoi des fiches de l ERP devant être mises à jour en création ou modification dans le CRM, le service Web d intégration interroge l ERP et renvoie des lots de fiches à Sage 100 CRM. (La demande de Sage 100 CRM au service Web d intégration se fait à travers une méthode nommée : GetChangeLog ) Le nombre de lots dépend du nombre de fiches à récupérer et du paramètre indiquant le nombre de fiches devant être contenues dans chaque lot. Ce paramètre dépend du service Web d intégration. Dans le cas du service d intégration Sage 100, le paramètre a été fixé à 999 fiches par lot. L analyseur de logs vous permet d analyser le temps passé par l ERP pour traiter les demandes d envoi des mises à jour à destination de Sage 100 CRM. Le temps total est consultable via une info bulle directement en positionnant le curseur souris sur le nombre de lots de l entité courante. Le temps détaillé de chaque lot est visible en cliquant sur le nombre de lots. Dans le cas où la durée d attente du retour de l ERP indiquée dans la fenêtre GetChangeLog semble anormalement élevée, il conviendra d analyser avec l aide éventuelle du service d assistance compétent le contenu de la base de données Sage Sage 18

19 L information Rapport de synthèse L entête de l analyseur de logs affiche en haut à droite des informations complémentaires sur l analyse du log courant. Nb de synchronisations correspond au nombre de demande de synchronisation de l intégration associée au log. Ces synchronisations peuvent avoir été activées : manuellement via le bouton accessible depuis la fiche de l intégration automatiquement via le service CRM Integration Service manuellement depuis le bouton accessible depuis une fiche Société Statut de la dernière intégration correspond à la présence ou l absence dans le fichier de log de l information indiquant la fin d une synchronisation. Cet indicateur permet par exemple de savoir si une intégration en cours de synchronisation est achevée ou non. Consultation du journal original et journal des erreurs Il est possible d ouvrir directement le journal des erreurs d intégration original depuis l interface de l analyseur de logs en cliquant sur le bouton : Afficher sous forme de fichier texte le journal de log d intégration Il est aussi possible de consulter sous forme de fichier texte un journal contenant uniquement les erreurs d intégration. Ce fichier journal est généré automatiquement par l analyseur de logs lors de l analyse d un log. Il est stocké dans le sous répertoire errors du répertoire logs. Chaque fichier d erreur se nomme : Errors<DATE AAAAMMJJ>integrationlog<NOM>.log Pour visualiser le journal des erreurs, cliquez sur le bouton : Afficher sous forme de fichier texte le journal des erreurs d intégration 2015 Sage 19

20 Conseils Interprétation des informations Des indicateurs peuvent vous aider à optimiser ou corriger le comportement d une synchronisation : Indicateur d erreurs : Cet indicateur est le premier révélateur d anomalies survenues lors des synchronisations. L analyseur de logs est alors un outil indispensable car il met en évidence des erreurs qui n auraient pas été constatées auparavant. Par exemple, l information indiquant sur la fiche intégration si une intégration s est terminée en Echec ou Avertissement est écrasée par la synchronisation suivante si celle-ci se termine en succès. En consultant régulièrement les logs via l analyseur de logs, l identification des erreurs peut alors plus facilement expliquer des anomalies constatées via les applications sur les données échangées. Indicateur nombre de synchronisations : Le nombre de synchronisations, affichées dans le pavé rapport de synthèse peut alerter sur un nombre trop élevé de synchronisations quotidiennes. Par exemple un intervalle de synchronisation laissé à la valeur par défaut (5 mn) sur la fiche intégration provoquera en moyenne 288 intégrations par jour. Une session de synchronisation est consommatrice de ressources serveur et alourdit le contenu des logs. Si le nombre d intégrations moyen affiché par log quotidien est élevé, il convient peut être de réajuster l intervalle de synchronisation et l adapter aux réels besoins fonctionnels d échanges de données entre Sage 100 CRM et l ERP. Indicateur nom des entités en double : Pour une session de synchronisation la liste des entités affichée dans la grille de résultat de l analyseur de logs ne doit comporter qu une seule entrée par entité. Si vous constatez des doublons d entités (par exemple, plusieurs lignes concernant l entité Products), une anomalie est survenue dans la table Sage 100 CRM ErpEntityMappings qui doit être remise en cohérence. Contactez alors votre service assistance. Ce type d anomalie n est pas bloquant mais peut ralentir les synchronisations en raison d un appel multiple de la même entité à chaque synchronisation. Indicateur Temps GetChangeLog : Le temps d attente avant que l ERP renvoie un lot de mises à jour à Sage 100 CRM est indiqué via la consultation des lots (cf. Paragraphe Consultation des logs GetChangeLog). Sur des bases Sage 100 volumineuses, ce temps d attente peut être très élevé pour chaque lot. Dans ce cas, plus le nombre de fiches par lots est bas, plus le temps global d attente sera élevé. Indicateur nombre de fiches échangées : Cet indicateur permet de constater si des données ont été échangées entre le CRM et l ERP. Si vous constatez en utilisant Sage 100 CRM ou l ERP que des données n ont pas été échangées, consultez via l analyseur de logs les volumes d échanges de données afin d être guidés sur l origine du dysfonctionnement (le plus souvent des indicateurs d erreur vous permettront de comprendre pourquoi les données ne sont plus correctement échangées) Sage 20