AttachmentDownloaderApp | télécharger une copie des pièces jointes

AFFICHER TOUT LE CONTENU

Table des matières

Introduction

Il est possible de profiter de l'hébergement des pièces jointes dans le cloud pour les rendre disponibles en tout temps. Des copies de sauvegardes de fichiers sont déjà en place sur le cloud, mais certains clients qui ont des processus importants dans Octopus préfèrent avoir une copie locale des pièces jointes pour le cas où leur réseau externe ferait défaut ou qu'Octopus ne serait pas disponible. 

AttachmentDownloader permet de faire le téléchargement de toutes les pièces jointes d'Octopus du cloud vers le réseau local. 

Références

Description du fonctionnement

Le programme AttachmentDownloader permet de télécharger manuellement ou de manière automatique, à l'aide d'une tâche planifiée Windows toutes les pièces jointes hébergées d'une équipe. 

Le programme s'exécute pour une équipe à la fois et télécharge les fichiers dans le dossier des pièces jointes configuré pour cette équipe. 

Prérequis

  • Avoir les pièces jointes hébergées par Octopus.
  • Création d'un compte Octopus système qui sera associé à la tâche. Voir l'article Compte système Octopus.
  • Création d'un dossier où déposer les pièces jointes sur le réseau local. 
    • Si la BD contient plus d'une équipe, on recommande un dossier différent pour chaque équipe. 
    • Le chemin complet du dossier doit être ajouté dans la configuration de chaque équipe qui utilise AttachmentDownloader à partir du menu Outils > Options > 3- Options générales importantes  > Répertoire réseau contenant les fichiers joints
    • Les droits aux intervenants de chaque équipe doivent être attribués en fonction de l'utilisation qui sera faite.
   Attention aux clients qui sont passés du mode de pièces jointes locales vers le mode de pièces jointes hébergées !

Un dossier était déjà configuré dans les options qui contient probablement encore des pièces jointes qui n'ont pas encore été téléchargées dans le cloud.

Il est important de ne pas modifier le chemin de ce dossier.

 

Ce qu'il faut savoir :

L'objectif d'avoir une copie locale en plus de la copie déjà hébergée n'est pas de modifier les fichiers localement, mais d'y avoir accès dans le cas d'une panne.

Normalement AttachmentDownloader devrait être utilisé avec le paramètre ForceReplaceFiles pour assurer que la copie locale est à jour.

Comme la copie locale sera écrasée lors du prochain téléchargement, il faut donc s'assurer que les modifications aux pièces jointes sont retournées dans Octopus ou temporairement sauvegardées ailleurs durant une panne. 
 

 

Lancement d'AttachmentDownloader

 

AttachmentDownloader est un programme qui s'exécute à partir d'une ligne de commande (DOS). Il est conçu ainsi pour être facile à automatiser. 

Pour lancer le programme ESI.Octopus.DataImporterApp.exe, il faut ouvrir une fenêtre d'invite de commande (DOS) et se positionner dans le répertoire d'Octopus. Par la suite, entrer la ligne de commande. (Voir Exemples de ligne de commande).

Important : Le répertoire courant doit être le répertoire où est situé le programme ESI.Octopus.AttachmentDownloaderApp.exe.

Par défaut, le répertoire d'Octopus est C:\Program Files\Octopus OU \%homepath%\AppData\Local\Octopus.

Autres exemples de répertoires où peut se situer Octopus :

  • Pour Windows 7 et +
    • C:\Users\slevesque\AppData\Local\Octopus.
  • Pour Windows XP
    • C:\Documents and Settings\slevesque\Local Settings\Application Data\Octopus.

Ce qu'il faut savoir :

À chaque exécution du programme un fichier .LOG est créé avec le format NomDeL'Outil_AAAAMMJJ_HHMMSS.log,

  • Par exemple AttachmentDownloader_20190618_105242.log.

Utiliser ce fichier pour voir les résultats d'exécution de la commande et les erreurs s'il y en a. 

Voir aussi l'article Outils Octopus | Entretien des fichiers logs sur l'importance de faire la gestion de ses fichiers. 

Paramètres disponibles

Il y a plusieurs paramètres disponibles, dont 3 obligatoires, pour exécuter AttachmentDownloader:

Paramètres obligatoires

  • /Login
    • Nom d’utilisateur Octopus.
  • /Password
    • Mot de passe Octopus.
  • /Team

​Exemple: ESI.Octopus.AttachmentDownloaderApp.exe /Login:system /Password:octo  /Team:1

Paramètres facultatifs

  • ​/ForceReplaceFiles
    • Bien que ce paramètre ne soit pas obligatoire, logiquement il devrait toujours être utilisé pour s'assurer que la copie locale de la pièce jointe est la copie la plus à jour.
    • Écrase l'ancienne copie d'une pièce jointe avec la version du cloud.
    • Sans ce paramètre, AttachmentDownloader va simplement ajouter les nouvelles pièces jointes sans mettre à jour celles qui ont déjà été téléchargées. 
  • /LogFilePath
    • Remplace le nom et l'emplacement du fichier de journalisation. Par défaut, le fichier se nomme AttachmentDownloaderApp_AAAAMMJJ_HHMMSS.log et est situé dans le répertoire d'Octopus.
    • Si on déplace le fichier dans un répertoire autre que celui d'Octopus, il faut s'assurer que ce répertoire existe (le système ne peut créer le répertoire).
    • De plus, le chemin doit contenir le nom du fichier.
    • Pour en savoir plus sur l'emplacement des fichiers Octopus, voir l'article Répertoire d'installation d'Octopus.
      Exemple : /LogFilePath:C:\LogFiles\JournalAttachmentDownloader.log
  • /WaitKeyPress
    • ​Permet de forcer l’activation d’une touche après l'exécution de l’importation. C'est-à-dire que la fenêtre (DOS) reste affichée, tant que l'activation d'une touche n'est pas exécutée.
    • Cette option peut être utile lorsque l'on fait des tests, afin de s'assurer qu'aucun problème n'affecte notre ligne de commande.

    • Prendre note que ce paramètre ne doit pas être utilisé pour les tâches récurrentes.

  • /PurgeLogs
    • Permet d'effacer automatiquement les vieux fichiers de logs. 
    • Le paramètre permet de déterminer le nombre de jours de fichiers logs qu'on désire conserver.
    • Pour plus d'information, voir l'article Outils Octopus | Entretien des fichiers logs.

Exemples

  • Ligne de commande de téléchargement avec les paramètres de base.
ESI.Octopus.AttachmentDownloaderApp.exe /Login:system /Password:octo /Team:1 /ForceReplaceFiles
  • Ligne de commande de téléchargement avec les paramètres facultatifs.
ESI.Octopus.AttachmentDownloaderApp.exe /Login:system /Password:octo /Team:1 /ForceReplaceFiles /WaitKeyPress /LogFilePath:G:\DossierABC

Automatisation du programme AttachmentDownloader

Pour automatiser le téléchargement à partir d'AttachmentDownloader, voir l'article Tâches planifiées Windows.

Journal des opérations

Au cours de l'exécution, AttachmentDownloader crée un journal des opérations en plus d'afficher les résultats à l'écran. Ce journal est sauvegardé dans le fichier AttachmentDownloaderApp_AAAAMMJJ_HHMMSS.log et est situé dans le même répertoire que l'exécutable de DataImporter, c'est-à-dire, dans le répertoire d'Octopus.
 

X
Aidez-nous à améliorer l’article








Aidez-nous à améliorer l’article