LISTE DES DÉCLENCHEURS

Il existe différents types de déclencheurs pour les imports/exports :

Manuel

DÉFINITION

L'import ou l'export manuel permettent à des utilisateurs de déclencher manuellement un contexte d'import ou d'export, de ressources ou d'événements.

Un export manuel peut fonctionner avec :

  • Un fichier au format *.CSV ;

  • Une feuille (ou onglet) d'un fichier au format *.XLS ;

  • Une table d'une base de données de type :

    • MSAccess,

    • MYSQL,

    • Oracle,

    • SQL Server,

    • PostgreSQL,

    • ou MariaDB.

UTILISATION

Lancement d'un contexte

Pour lancer manuellement un contexte d'import ou export, aller dans le menu Planning > Bloc Export ou Bloc Import, puis :

  • Exporter des événements > cliquer sur la flèche de droite > choisir le contexte ;

  • Importer des événements > cliquer sur la flèche de droite > choisir le contexte ;

  • Exporter des ressources > cliquer sur la flèche de droite > choisir le contexte ;

  • Importer des ressources > cliquer sur la flèche de droite > choisir le contexte.

Une fenêtre similaire à la fenêtre suivante apparaît alors :

Cliquer sur Oui pour lancer l'importation ou l'exportation.

Exportation d'une sélection

Il est possible d'exporter une sélection de ressources ou d'événements selon un contexte défini.

Pour ce faire :

  • Cliquer droit sur une sélection d'événements > Exporter des événements > Choisir le contexte ;

  • Ou Cliquer droit sur une sélection de ressources > Exporter des ressources > Choisir le contexte.

Une fenêtre similaire à la fenêtre suivante apparaît alors :

Cliquer sur Oui pour lancer l'export.

Attention

Seuls les ressources ou événements sélectionnés qui appartiennent au filtre défini dans le contexte seront exportés.

Importation d'une sélection

Il est possible de déclencher un import de ressources ou d'événements depuis une sélection.

Pour ce faire :

  • Cliquer droit sur la sélection de ressources > Importer des ressources > Choisir le contexte ;

  • Cliquer droit sur la sélection d'événements > Importer des événements > Choisir le contexte.

Une fenêtre similaire à la fenêtre suivante apparaît alors :

Cliquer sur Oui pour lancer l'import.

Important

Cette fonctionnalité n'est active que dans le cas d'un import pour mise à jour.

Rapport d'exportation

Lorsque l'export est effectué, la fenêtre de Rapport d’exportation apparaît pour afficher le récapitulatif de l'opération.

Exportation correcte

Lorsque l'export est effectué, le rapport indique le nombre de données exportées et s'il y a eu des imports à la suite, le nombre de données importées.

Exportation incorrecte

Si les paramètres d'export ne permettent pas d'exporter, le message suivant apparaît :

Il faut alors relancer un export avec des paramètres corrects jusqu'à obtenir le message d'exportation correcte. (c.f. ci-dessus)

Rapport d'importation

Lorsque l'import est effectué, la fenêtre de Rapport d’importation apparaît pour afficher le récapitulatif de l'opération.

Importation correcte

Dans le cas ou les paramètres d'importation sont correctement renseignés, un message de ce type apparaît :

Importation incorrecte

Si les paramètres d'import ne permettent pas d'importer, le message suivant apparaît :

Il faut alors relancer un import avec des paramètres corrects jusqu'à obtenir le message d'importation correcte. (c.f. ci-dessus)

Aucune ressource définie

L'existence d'événements et implicitement l'import d'événements nécessitent au minimum une ressource à laquelle rattacher les événements importés.

Si aucune ressource n'est définie dans le contexte d'import, le message suivant apparaît :

Aucune correspondance définie

Si aucune correspondance n'est définie, le message suivant apparaît :

Service

Dans ce cas, le contexte d'import ou d'export est déclenché par service à une fréquence donnée.

Import par service

DÉFINITION

Un Import par service permet de déclencher selon une fréquence définie un import de données dans VISUAL PLANNING.

Cette fonctionnalité porte exclusivement sur :

  • l'Import de Ressources,

  • l'Import d’Événements.

Cette fonctionnalité permet donc d'exécuter régulièrement et en temps voulu, des contextes d'import préalablement définis et paramétrés.

Ce service fonctionne, que la source soit :

  • un fichier CSV,

  • un fichier Excel,

  • ou une base de données.

PRÉREQUIS
Prérequis technique

Cette fonctionnalité n’est disponible que pour VISUAL PLANNING ENTERPRISE.

Il faut que le service d'import/export soit démarré pour que les imports automatiques se déclenchent.

Prérequis fonctionnel

L'import par service nécessite :

  • La préparation du fichier ou de la base de données source,

  • La définition d’un contexte d’importation.

PARAMÉTRAGE
Paramètres du service de l'import

Pour paramétrer le déclenchement par service de l'import, dans lesParamètres généraux > Imports/exports > Cliquer sur le contexte d'import de ressources ou d'événements.

La partie correspondante s'active alors :

Pour en savoir plus sur ces caractéristiques, il faut se référer à l'Import de Ressources ou à l'Import d’Événements

Les caractéristiques suivantes ne concernent que le déclenchement par service du contexte.

Activé

Cette case à cocher permet d'activer ou de désactiver le service pour le contexte d'import concerné.

Déclencheurs

Les déclencheurs permettent de définir :

  • la fréquence de l'import,

  • le fichier source (cas de l'import depuis un fichier),

  • l'action sur le fichier après traitement (cas de l'import depuis un fichier).

En cliquant sur le bouton

La fenêtre suivante s’ouvre :

Cette fenêtre permet de définir la liste des services du contexte d'import.

Pour ajouter un nouvel import par service, cliquer sur le bouton Ajouter.

Cela signifie que l'on peut déclencher le lancement d'un même contexte d'import autant de fois que nécessaire, sans être obligé de définir plusieurs contextes.

Périodicité

On peut distinguer plusieurs types de périodicité:

  • Tous les jours à une heure définie ;

  • Tous les dd à une heure définie (Exemple : tous les Lundi) ;

  • Toutes les X minutes ;

  • Tous les mois le.

Information
  • Si la périodicité a été définie comme étant Tous les jours à, il faut alors préciser l'Heure,

  • Si la périodicité a été définie comme étant Toutes les X minutes,il faut alors préciser le nombre de minutes,

  • Si la périodicité a été définie comme étant Tous les mois le, il faut alors préciser le jour du mois et l'heure.

Fichier

Dans le cas de l'import depuis un fichier Excel ou CSV, il faut préciser l'adresse du fichier utilisé par le service.

A l'inverse du chemin défini dans le contexte d'import, ce fichier doit être accessible depuis le serveur.

Action

Enfin, définir le traitement à effectuer sur le fichier importé, après achèvement de l’importation.

  • Supprimer : Cela supprime définitivement le fichier importé.

  • Archiver : Cela renomme le fichier importé avec l'extension .yyyyMMddHHmmss (ex : fichier import.20180404165412.csv),

  • Aucune : Aucune traitement n'a lieu sur le fichier importé.

UTILISATION

L'import par service de données dans VISUAL PLANNING ne nécessite aucune utilisation particulière.

L'utilisateur final verra les données être modifiées directement sans manipulation de sa part, de manière transparente.

L'historique de l'événement ou de la ressource stocke le nom du contexte comme nom d'utilisateur.

Pour que les services fonctionnent, il est nécessaire d'activer les éléments ci-dessous.

Ces actions doivent être réalisées par l'administrateur :

  1. Le serveur VISUAL PLANNING doit être actif,

  2. Le déclencheur par service du contexte d’import ou d’export doit être activé,

  3. Les services d’import/export du planning doivent être activés (Admin center > cliquer droit sur le planning > Activer service import/export) c.f. Gestion des plannings

  4. Les services d’import/export de l’application doivent être activés : c.f. Gestion des services

Export par service

DÉFINITION

Un Export par service permet de déclencher selon une fréquence définie un export de données depuis VISUAL PLANNING.

Cette fonctionnalité porte exclusivement sur :

  • l'Export de Ressources,

  • l'Export d’Événements.

Cette fonctionnalité permet donc d'exécuter régulièrement et en temps voulu, des contextes d'export préalablement définis et paramétrés.

Cela fonctionne, que la destination soit :

  • un fichier Csv,

  • un fichier Excel,

  • un fichier XML,

  • ou une Base de données.

PRÉREQUIS
Prérequis technique

Cette fonctionnalité n’est disponible que pour VISUAL PLANNING ENTERPRISE.

Il faut que le service d'import/export soit démarré pour que les imports automatiques se déclenchent.

Prérequis fonctionnel

L'export par service nécessite :

  • La préparation du fichier ou de la base de données destinataire,

  • La définition d’un contexte d’exportation.

PARAMÉTRAGE
Paramètres de déclenchement de l'export

Pour paramétrer le déclenchement de l'export par service, dans les Paramètres généraux > Imports/exports > Cliquer sur le contexte d'export de ressources ou d'événements.

La partie correspondante s'active alors :

Pour en savoir plus sur ces caractéristiques, il faut se référer à l'Export de Ressources ou à l'Export d’Événements

Les caractéristiques suivantes ne concernent que le déclenchement par service du contexte.

Activé

Cette case à cocher permet d'activer ou de désactiver de service pour le contexte d'export concerné.

Déclencheurs

Les déclencheurs permettent de définir :

  • la fréquence de l'export,

  • le fichier de destination (cas de l'export vers un fichier).

En cliquant sur le bouton

La fenêtre suivante s’ouvre :

Cette fenêtre permet de définir la liste des services du contexte d'export.

Pour ajouter un nouvel export par service, cliquer sur le bouton Ajouter.

Cela signifie que l'on peut déclencher le lancement d'un même contexte d'export autant de fois que nécessaire, sans être obligé de définir plusieurs contextes.

Périodicité

On peut distinguer plusieurs types de périodicité :

  • Tous les jours à une heure définie ;

  • Tous les dd à une heure définie (Exemple : tous les Lundi) ;

  • Toutes les X minutes ;

  • Tous les mois le.

Information
  • Si la périodicité a été définie comme étant Tous les jours à, il faut alors préciser l'Heure,

  • Si la périodicité a été définie comme étant Toutes les X minutes,il faut alors préciser le nombre de minutes,

  • Si la périodicité a été définie comme étant Tous les mois le, il faut alors préciser le jour du mois et l'heure.

Fichier

Dans le cas de l'import depuis un fichier Excel ou CSV, il faut préciser l'adresse du fichier utilisé par le service.

A l'inverse du chemin défini dans le contexte d'export, ce fichier doit être accessible depuis le serveur.

UTILISATION

L'export par service de données dans VISUAL PLANNING ne nécessite aucune utilisation particulière.

Dans ce cas, l'utilisateur ne voit pas l'exportation des données. Cet export agit de manière transparente.

Pour que les services fonctionnent, il est nécessaire d'activer les éléments ci-dessous.

Ces actions doivent être réalisées par l'administrateur :

  1. Le serveur VISUAL PLANNING doit être actif.

  2. Le déclencheur par service du contexte d’import ou d’export doit être activé,

  3. Les services d’import/export du planning doivent être activés (Admin center > cliquer droit sur le planning > Activer service import/export) c.f. Gestion des plannings

  4. Les services d’import/export de l’application doivent être activés : c.f. Gestion des services

Automatique

DÉFINITION

Les imports et exports automatiques sont un mode de déclenchement des imports et des exports qui a lieu lors de la création et/ou la modification d'un événement ou d'une ressource.

Les cas possibles sont les suivants :

  • La création/modification d'un événement déclenche l'export de cet événement,

  • La création/modification d'un événement déclenche l'import pour mise à jour de cet événement,

  • La création/modification d'un événement déclenche l'export de l'une des ressources de cet événement,

  • La création/modification d'un événement déclenche l'import pour mise à jour de l'une des ressources de cet événement,

  • La création/modification d'une ressource déclenche l'export de cette ressource,

  • La création/modification d'une ressource déclenche l'import pour mise à jour de cette ressource.

UTILISATION

L'utilisation est transparente pour l'utilisateur puisque l'import ou l'export a lieu lors de la création ou modification de ressources ou d'événements sur le planning.

Pour activer les imports ou exports automatiques, cocher les critères correspondants dans le contexte.

URL

DÉFINITION

Cette fonctionnalité, limitée à VISUAL PLANNING ENTERPRISE, permet de déclencher en dehors de VISUAL PLANNING la mise en œuvre de contexte d'importation et d'exportation d'un planning.

Dans ce cas, le contexte d'import ou d'export est déclenché par le lancement d'une URL.

ACTIVATION DE L'URL

Pour activer le déclenchement de l'import ou de l'export via URL, il faut activer l'option dans le contexte d'import/export en cochant la case Appel via "URL".

OBTENTION DE L'URL

Pour obtenir l'URL de déclenchement du contexte d'import ou d'export de ressources ou d'événements, cliquer droit sur le nom du contexte > Afficher l'URL.

La fenêtre suivant s'ouvre, elle affiche l'URL de déclenchement de l'import ou de l'export.

Il suffit de copier cette URL et de l'utiliser au moment opportun.

EXPORTATIONS VIA URL

Il est également possible de faire des exportations en lançant une URL particulière construite en suivant les syntaxes ci-dessous.

URL simple
Pour les ressources

SERVER_IP/resourceexport.do?PLANNING=nom_planning&EXPORT=nom_contexte

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'exportation.
Pour les événements

SERVER_IP/eventexport.do?PLANNING=nom_planning&EXPORT=nom_contexte

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'exportation.
URL avec variables nommées

Lorsque l'URL contient une variable nommée, définie dans un filtre, le contexte d'export conduira à l'export des événements ou des ressources, définis dans un filtre de ressources ou un filtre d'événements et nommés par la variable.

Tous les espaces blancs existants dans le nom du planning, le nom du contexte d'export ou les valeurs de la variable doivent être transformés avec un caractère espace " " ou "_" ou "+" ou encore "%20".

La réponse est le résultat du contexte d'exportation.

Pour les ressources

SERVER_IP/resourceexport.do?PLANNING=nom_planning&EXPORT=nom_contexte&NOM_DE_LA_VARIABLE_1=valeur1&NOM_DE_LA_VARIABLE_N=valeurN

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'exportation,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N représentent le nom de la variable définie dans un filtre,
  • valeur1 et valeurN représentent la valeur que la variable nommée prend.
Pour les événements

SERVER_IP/eventexport.do?PLANNING=nom_planning&EXPORT=nom_contexte&NOM_DE_LA_VARIABLE_1=valeur1&NOM_DE_LA_VARIABLE_N=valeurN

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'exportation,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N représentent le nom de la variable définie dans un filtre,
  • valeur1 et valeurN représentent la valeur que la variable nommée prend.

IMPORTATIONS VIA URL

Il est également possible de faire des importations en lançant une URL particulière construite en suivant les syntaxes ci-dessous.

URL simple
Pour les ressources

SERVER_IP/resourceimport.do?PLANNING=nom_planning&IMPORT=nom_contexte&FILE=adresse_fichier

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'importation,
  • adresse_fichier représente l'adresse d'accès du fichier sur le serveur VISUAL PLANNING, le nom de celui-ci ainsi que son extension.
Pour les événements

SERVER_IP/eventimport.do?PLANNING=nom_planning&IMPORT=nom_contexte&FILE=adresse_fichier

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'importation,
  • adresse_fichier représente l'adresse d'accès du fichier sur le serveur VISUAL PLANNING, le nom de celui-ci ainsi que son extension.
URL avec variables nommées

Lorsque l'URL contient une variable nommée, définie dans un filtre, le contexte d'import conduira à l'import des événements ou des ressources, définis dans un filtre de ressources ou un filtre d'événements et nommés par la variable.

Tous les espaces blancs existants dans le nom du planning, le nom du contexte d'export ou les valeurs de la variable doivent être transformés avec un caractère espace " " ou "_" ou "+" ou encore "%20".

La réponse est le résultat du contexte d'importation.

Pour les ressources

SERVER_IP/resourceimport.do?PLANNING=nom_planning&IMPORT=nom_contexte&NOM_DE_LA_VARIABLE_1=valeur1&NOM_DE_LA_VARIABLE_N=valeurN

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'importation,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N représentent le nom de la variable définie dans un filtre,
  • valeur1 et valeurN représentent la valeur que la variable nommée prend.
Pour les événements

SERVER_IP/eventimport.do?PLANNING=nom_planning&IMPORT=nom_contexte&NOM_DE_LA_VARIABLE_1=valeur1&NOM_DE_LA_VARIABLE_N=valeurN

Où :

  • SERVER_IP est l'URL d'accès au serveur de VISUAL PLANNING, sans le /index.jsp final,
  • nom_planning est le nom du planning concerné,
  • nom_contexte​ est le nom du contexte d'importation,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N représentent le nom de la variable définie dans un filtre,
  • valeur1 et valeurN représentent la valeur que la variable nommée prend.

FTP et Webdav

DÉFINITION

WebDAV est une extension du protocole HTTP permettant de simplifier la gestion de fichier via des serveurs distants.

FTP est un protocole de transfert de fichier via des serveurs distants.

PRÉREQUIS

L'import ou l'export par protocole FTP ou WebDAV n'est possible que lors d'un import/export de type CSV ou EXCEL

Il est nécessaire de disposer d'un serveur FTP et/ou WebDAV suivant le protocole utilisé.

PARAMÉTRAGE

Lors de la définition d'un contexte d'import/export  de ressources ou d'import/export d'événements, le paramètre Chemin doit être renseigné de la manière suivante :

  • Cliquer sur le bouton .

  • Saisir le lien FTP ou WebDAV vers le fichier en saisissant l'utilisateur.

Note

Le mot de passe et le nom du serveur sont définis dans l'Admin Center (c.f. Configuration accès externe).

Exemple FTP :

FTP://bla/blablabla/monfichier.csv

ou FTPS://bla/blablabla/monfichier.csv dans le cas de l'utilisation d'un certificat de sécurité

Exemple WebDAV :

webdav://bla/blablabla/monfichier.csv

ou webdavs://bla/blablabla/monfichier.csv dans le cas de l'utilisation d'un certificat de sécurité

Note

Le Username et Password sont fournis par le client.

Le certificat de sécurité est installé sur la machine virtuelle JAVA utilisée par le serveur VISUAL PLANNING

FONCTIONNALITÉS

Les fonctionnalités post-traitement ne sont pas possibles via protocole HTTP car celui-ci rend impossible la manipulation des fichiers sources.

Voici un tableau qui clarifie ces notions :

Fonctionnalité

Répertoire Local

Protocole HTTP

Protocole WebDAV

Protocole FTP

Export

Oui

Non

Oui

Oui

Traitement du fichier après import (suppression/archivage)

Oui

Non

Oui

Oui

Enchaînements

DÉFINITION

Les contextes d'import ou d'export peuvent être déclenchés par l'aboutissement d'un autre contexte, éventuellement avec utilisation d'une procédure stockée.

Les cas possibles sont :

Premier contexte

Procédure stockée

Contexte déclenché à la suite

Export de ressources

avec ou sans

Import de ressources

Export d'événements

avec ou sans

Import d'événements

Import de ressources

avec ou sans

Import d'événements

Import d'événements

avec ou sans

aucun

PRÉREQUIS

Ce type de déclencheur ne fonctionne qu'avec les contextes d'Imports/exports via base de données.

PARAMÉTRAGE

Le paramétrage des contextes d'import ou d'export doit être effectué au préalable.

Le déclencheur du second contexte se paramètre dans l'onglet Définition du premier contexte.

UTILISATION

L'utilisation est aussi transparente pour l'utilisateur que le déclenchement du premier contexte peut l'être.

Import d'Export ou Export d'Import

Dans ce cas, le contexte d'import ou d'export est déclenché par l'utilisation comme source ou destination d'un autre contexte.

ghostghostghostghostghost
loading table of contents...