Description des fichiers APPINFOS et de leur utilisation

Edit me

Introduction

Cet article vise à préciser les bonnes pratiques concernant l’utilisation du fichier APPINFOS pour la configuration des applications Voozanoo 4 ou du noyau lui-même.

Généralités

  • Les fichiers APPINFOS sont des fichiers au format JSON.
  • Dans le noyau VOOZANOO4 ce fichier se trouve dans /src/configs/
  • Dans les applications ce fichier se trouve généralement dans le dossier configs/

Le fichier APPINFOS du noyau Voozanoo 4

Voici un exemple de fichier APPINFOS tel que vous pouvez le trouver dans le noyau VOOZANOO4. Les différentes lignes de ce fichier sont détaillées ici

{
	"PACKAGING": {
		"INF_PACKAGE":"VOOZANOO4",
		"INF_VERSION":"2.26",
		"INF_PRIORITY":"optional",
		"INF_ARCHITECTURE":"all",
		"INF_DEPENDS":[
			"epi-zendframework-1.13.1",
			"epi-yui-3.10.2",
			"epi-yui-2.9.0",
			"epi-jquery",
			"epi-bootstrap",
			"epi-fontawesome",
			"epiconcept-arborescence",
			"epi-ckeditor",
			"epi-datepicker"
		],
		"INF_SECTION":"base",
		"INF_MAINTENER":"Team FrameWork <framework@epiconcept.fr>",
		"INF_DESCRIPTION":"Core Voozanoo4",
		"INF_HOMEPAGE":"http://www.epiconcept.fr"
	},
	"DEPENDENCIES":{
		"ZF":"1.13.1",
		"YUI3": "3.10.2",
		"YUI2": "2.9.0"
	}
}

Le fichier APPINFOS d’une application métier

Voici un exemple de fichier APPINFOS tel que vous pouvez le trouver dans une application VOOZANOO4 (ici Epifiles). Les différentes lignes de ce fichier sont détaillées ici

{
  "PACKAGING":{
      "INF_PACKAGE":"epifiles",
      "INF_VERSION":"1.13",
      "INF_PRIORITY":"optional",
      "INF_ARCHITECTURE":"all",
      "INF_DEPENDS":"voozanoo4-2.26",
      "INF_SECTION":"base",
      "INF_MAINTENER":"team_fwk",
      "INF_DESCRIPTION":"A secure file exchange platform.",
      "INF_HOMEPAGE":"https://epifiles.voozanoo.net/",
      "INF_MAILTO":"fwk-restreint@epiconcept.fr"
  },
  "DEPENDENCIES":{
      "VOOZANOO4":"2.26"
  }
}

Les directives du APPINFOS

PACKAGING

Dans le but de cartographier nos applications, en temps réel, et de trouver qui est le propriétaire d’une application sans avoir besoin de chercher dans des e-mails, il a été décidé d’ajouter des informations de contexte dans les fichiers APPINFOS.

Directive Description
INF_PACKAGE Ce champ sera rempli automatiquement avec le nom du paquet, en respectant la casse. Celui-ci est récupérable dans le chemin de fichier du APPINFOS
INF_VERSION Version du paquet
INF_PRIORITY  
INF_ARCHITECTURE  
INF_DEPENDS Liste des dépendances du paquet. Lors de l’installation du noyau ou d’une application, cette liste est vérifiée et tous les paquets manquants sur le serveur sont installés également
INF_SECTION  
INF_MAINTENER Champs contenant l’équipe d’Epiconcept responsable d’un projet
INF_DESCRIPTION Description du paquet. La description devrait fournir de l’information sur le projet, ce qu’il fait ou ce que c’est, quel organisme l’utilise etc.
INF_HOMEPAGE URL de l’application installée via ce paquet
INF_MAILTO Adresse mail à contacter en cas de problème avec le paquet

DEPENDENCIES

Ces directives sont utilisées pendant le fonctionnement de l’application et fournissent les chemins vers les dépendances de l’application

Directive Surchargeable Description
VOOZANOO4   Version du noyau Voozanoo4 utilisée par l’application
ZF X Version de ZendFramework utilisée par l’application. Si cette directive est utilisée dans le APPINFOS d’une application mais qu’elle est différente de la directive du noyau (celui utilisé par l’application) alors c’est la directive de l’application qui sera prise en compte
YUI3   Version de YUI 3 utilisée par l’application
YUI2   Version de YUI 2 utilisée par l’application