Documentation en ligne

En général (en tout cas, c'est que nous faisons à Entr'ouvert;-), vous disposez d'une plate-forme de production et d'une plate-forme de test, voici quelques règles pour gérer correctement ces deux installations.

En premier lieu, sachez qu'il n'y a pas de magie, il n'est pas possible de copier une partie d'une plate-forme vers l'autre sans intervention humaine, le fonctionnement de base étant une copie complète et écrasement des données pré-existantes.

Il faut distinguer les modes opératoires préalablement à la première mise en production des mises à jour, de la plate-forme de production, ultérieures.

  • Première mise en production : il est possible de créer la plate-forme de production par la copie complète de l'installation de test ; pour ce faire, il aura été nécessaire de nettoyer préalablement la plate-forme de test des essais temporaires (qui auront été précisément identifiés au préalable pour pouvoir les supprimer sans hésitation). Nota bene : il pourra être nécessaire d'adapter des liens URL en dur (liens vers des formulaires, liens vers des ressources graphiques sur les portails Combo)
  • Mises à jour ultérieures : il s'agit du cas où la plate-forme est déjà ouverte, un certain nombre de démarches en ligne déjà utilisées par les usagers et qu'il est souhaité modifier ces démarches ou en ajouter de nouvelles. Dans ce cas de figure, il n'est plus possible de faire une copie de masse mais uniquement des copies partielles, il est préférable de copier les éléments dans l'ordre suivant : connecteurs vers des logiciels tiers, sources de données, rôles, workflow puis enfin formulaire (vous pourrez vérifier sur la page de détail du formulaire la bonne prise en compte des rôles et variables du workflow.

Première mise en production

  • Récupérer les éléments de la charte graphique validés
  • Noms de domaine (CNAME vers *.entrouvert.org en mode SaaS)
  • Certificats
  • Adresse de l'expéditeur de mail
  • Configuration du serveur mail pour échapper aux antispam (règle SPF en mode SaaS)

Mises à jour ultérieures de la production

Formulaires et workflows

Une fois une démarche (formulaire et workflow) en ligne en production, il est indispensable de conserver celle-ci à l'identique sur la pré-production afin de pouvoir effectuer des tests valables :

  • s'il s'agit d'ajustements mineurs, ceux-ci peuvent être réalisés sur le formulaire ou le workflow de test, validés puis reproduits en production (soit par modification en production, soit par export du workflow de test puis ré-import sur la production).
  • s'il s'agit de modifications importantes, tels par exemple une modification de workflow en relation avec l'évolution d'un connecteur, il est préférable de réaliser préalablement ses tests sur des copies (clairement identifiées par un suffixe [TEST] ou rangées dans une catégorie "test"), puisqu'il est possible que cette version alternative ne doive pas être gardée. Après validation, il est alors possible d'écraser la version opérationnelle puis la passer en production.

Rôles et utilisateurs

Il est nécessaire de s'assurer que les rôles appelés dans la démarche existent bien sur la plateforme de production et que les utilisateurs ad-hoc les aient d'attribués. Afin de faciliter ce contrôle par une vue globale, il est vivement conseillé de n'utiliser que des fonctions et non pas des rôles directement dans les workflows, l'intégralité des rôles agissant dans le cours du workflow étant alors listés sur la page de détail du formulaire.

Sources de données

Les sources de données (tables csv) doivent être copiés ou mises à jour sur l'installation de production préalablement à la mise en production d'un formulaire qui y ferait appel.

Connecteurs

Fixme : rédaction Victor, cf #14141

Dernière mise à jour le 21 mai 2019 16:32 — Éditer