Agent d’export de documents et de données vers Excel

Présentation générale

Cet outil permet d’exporter de manière planifiée des documents processus ou des données du réservoir de données dans un fichier Excel créé sur le file system de l’instance VDoc.

Remarque

Pour définir les documents où les données à exporter, vous devez concevoir au préalable une vue puis référencer cette vue dans les paramètres XML de l’agent.

Utilisation

Pour mettre en place cet outil, il faut simplement suivre la procédure suivante :

aller dans la section Administration > Planification des agents ;
créer un agent en sélectionnant le modèle d’agent Agent d’export de ressources vers Excel ;
aller sur l’onglet Configuration et cliquer sur le bouton Remplacer par la configuration d’origine ;
définir les paramètres de la configuration.

Configuration de l’agent

Définition de la configuration

<configuration>
  <output-folder></output-folder>
  <output-filename />
  <language>fr</language>
  <project-uri />
  <view-uri />
  <separated-files>false</separated-files>
  <fields-to-export>
    <fieldname>sys_Title</fieldname>
    <fieldname>sys_Reference</fieldname>
    <fieldname>sys_CreationDate</fieldname>
    <fieldname>sys_Creator</fieldname>
  </fields-to-export>
</configuration>

Description de la configuration

Balise	Description
output-folder	Dossier de destination du fichier exporté. Précision : Sous Windows les caractères ‘' dans le chemin doivent être remplacés par ‘/’ (par exemple pour exporter dans le dossier Windows “D:\Export-DU-Hermes”, indiquez dans le XML de paramétrage de l’agent la valeur : “D:/Export-DU-Hermes”) Sous Linux, le chemin sera de la forme “/opt/vdocplatform/contentstore/[votre dossier perso]” (ici pour la plateforme DevOps hébergée chez Visiativ). Le stockage comme sous-dossier de contentstore est la meilleure solution car elle n’a aucun impact lors d’un deploy (contrairement à 1 stockage dans un dossier de custom... qui se retrouve ensuite dans l’ear sous JBoss) et ce dossier est intégré aux sauvegardes.<br/Si les dossiers et sous-dossiers n’existent pas sur le File System, ils sont créés par l’agent d’export VDoc.
output-filename	Nom court du fichier à exporter. Précisions : Suffixe : le suffixe *.xlsx est ajouté automatiquement Ecrasement du fichier précédent : à chaque exécution de l’export un nouveau fichier est généré, si un fichier portant le même nom est déjà présent dans le dossier (fichier issu d’un précédent export) l’ancien fichier est écrasé.
language	Langue utilisée pour l’extraction des données.
project-uri	ProtocolURI de l’application (dans le Studio).
view-uri	ProtocolURI de la vue permettant de sélectionner les documents ou données (information présente dans Studio > Propriétés de la vue).
separated-files	Indique si chaque document doit être exporté dans un fichier Excel séparé. La valeur par défaut est false.
fields-to-export	Permet de définir quels sont les champs à exporter. Précisions : Cette balise est optionnelle. Si non présente, tous les champs seront exportés. Pour définir les champs à exporter, ajouter des balises filles fieldname en spécifiant le nom système des champs (ou colonnes).

Exemple de configuration

<configuration>
  <output-folder>D:/TEMP/VDOC</output-folder>
  <output-filename>out</output-filename>
  <language>fr</language>
  <project-uri>uril://vdoc/project/DefaultOrganization/LesTypes</project-uri>
  <view-uri>uril://vdoc/workflowContainerView/DefaultOrganization/LesTypes/GroupeDeProcessus:0/TypesDeChamp/TousLesDocuments</view-uri>
  <separated-files>false</separated-files>
</configuration>

Astuces d’utilisation

Pour faciliter le paramétrage de l’agent, et trouver les “protocol uri” (uril:/) du projet et de la vue d’export à déclarer dans l’XML de paramétrage de l’agent :
- demandez à installer temporairement l’outil vdoc.kit.extensions
- ouvrez le Studio puis allez dans les** propriétés de l’objet (projet, vue) et copier l’uri** qui est affichée grâce à vdoc.kit.extensions dans la zone Identifiant.
Comment exporter des données stockées dans plusieurs tables différentes du réservoir ou des documents de plusieurs processus différents ?
- Réponse : les paramètres de l’agent n’acceptant la déclaration que d’une seule vue, vous devrez donc paramétrer puis exécuter plusieurs agents d’exports différents (1 agent d’export par vue).

Précisions sur l’export des champs pièces jointes

Les fichiers attachés dans les champs pièces jointes sont exportés par l’agent de la manière suivante :

dans le fichier Excel : présence d’une colonne par champ pj contenant les différents chemins des pièces jointes exportées (cellule “texte multi-valeurs”)
sur le file system du serveur après export : création de l’arborescence suivante
- sys_Reference du document ou de la donnée >
  - Nom système du champ Pièces jointes >
    - Fichiers attachés.

Limites connues

Cet export ne contient pas l’historique des actions de workflow réalisées (tableau d’historique du document : étape / action / intervenant / date / commentaire …).