Expliquer comment importer des familles dans Freedom en utilisant l'interface Web ou la ligne de commandes.
Expliquer comment construire un fichier OpenOffice.org ou .csv permettant de définir les attributs d'une famille à importer.

Masque de création d'une famille sous OpenOffice.org

Vous trouverez dans les chapitres suivants toutes les explications pour créer un fichier .csv ou OpenOffice.org permettant de définir les attributs d'une famille.

Mais pour vous éviter de construire complètement ce fichier, vous pouvez partir de ce fichier OpenOffice.org pour définir vos familles et les importer dans freedom et les exporter depuis freedom.

Si vous voulez juste spécifier les structures de familles pour les importer dans freedom vous pouvez utiliser ce fichier : Spécification des structures

En complément vous pouvez mémoriser cette macro Fdl Color dans votre tableur openoffice afin de mettre en évidence les différents types d'attributs.

Importer des familles en utilisant l'interface Web

Avant d'importer une famille, il est conseillé de suivre le chapitre concernant l'importation de documents en général.

Mais en résumé, voici ce qu'il faut faire :

Construire un fichier OpenOffice.org ou .cvs en suivant les instructions des chapitres suivants
Se placer dans le module “Gestion documentaire” de Freedom
Utiliser le menu “Outils / Importer des documents”
Cliquer sur le bouton “Parcourir” et sélectionner le document .csv ou OpenOffice.org
Cliquer sur le bouton “Analyse” pour détecter les anomalies
Cliquer sur le bouton “Importer les document”

Importer des familles en utilisant la ligne de commandes

Pour importer des familles en utilisant la ligne de commandes, , il est conseillé de lire ce chapitre pour avoir plus d'explications sur l'utilisation de scripts dans Freedom.

Mais en résumé, voici la commande qu'il faut utiliser pour importer un document dans Freedom :

/usr/share/what/wsh.php --api=freedom_import --file=VotreFichier.ods

Remarque : Vous pouvez importer directement un fichier OpenOffice.org .ods ou un fichier .csv

Supprimer une famille

Une fois l'importation d'une famille effectuée, il n'est plus possible de supprimer des attributs ni de les renommer. Vous serez donc certainement amené pendant votre phase de mise au point à supprimer des familles.

ATTENTION : La suppression d'une famille entraîne la suppression de tous les documents de cette famille.

Pour supprimer une famille, vous pouvez consulter ce chapitre

Pour savoir ce qu'il est possible de faire comme modifications sur une famille, il faut suivre ce chapitre.

Description du fichier d'importation

Dans les chapitres suivants, vous trouverez la description complète d'un fichier d'importation. Ce fichier peut-être au format OpenOffice.org ou au format .csv.

Remarque : Une ligne vide ou une ligne commençant par // ne sera pas prise en compte lors de l'importation.

Entête

L'entête défini le titre, le nom et l'héritage de la famille.

// famille portail url		titre	id	class	name
1	2	3	4	5	6
BEGIN	GATE_SERVICE	service url			GATESERVICE_URL

Définition des colonnes :

BEGIN
identifiant numérique ou logique de la famille père. Mettre vide s'il n'y a pas d'héritage.
titre de la famille.
identifiant numérique de la famille. Le laisser à vide pour utiliser un identifiant logique. S'il est valué il faut que cet identifiant ne soit pas déjà pris par un autre document. Les valeurs entre 900 et 999 peuvent être utilisée pour vos besoins spécifiques.
le nom d'un fichier de définition de classe PHP qui doit être présent sur le serveur (/home/httpd/what/FDL). Ne sert que pour des documents systèmes. Permet un héritage autre que celui prévu par défaut par les classes documentaire.
nom logique de la famille. Ne doit contenir que des caractères alphanumériques (pas d'espace, ni de ponctuation).

Caractéristiques générales

Les caractéristiques permettent d'affecter les propriétés du documents. La syntaxe est toujours la même : 1^ère colonne : nom de la propriété, 2^ème colonne valeur de la propriété.

propriété	description
TYPE	toujours mettre C. Défini la propriété doctype du document. 'C' signifie famille de document.
ICON	nom du fichier image définissant l'icône de la famille. Cette icône doit être une image de taille 48×48 pixels. Elle doit être présente sur le serveur. Cette icône peut être modifié à postériori par l'interface. Si une icône est déjà présente pour cette famille, elle ne sera pas modifiée.
PROFID	identifiant du document profil pour cette famille. Ce document doit être de la famille 'profil de famille'.
CPROFID	identifiant de profil qui sera affecté à tout nouveau document crée par cette famille. Ce document doit être de la famille profil de document. Si la famille hérité de dossier, le document doit être de la famille profil de dossier. Si la famille hérite de recherche, le document doit être de la famille profil de recherche.
DFLDID	identifiant du dossier par défaut dans lequel tout nouveau document de la famille sera crée. Peut être égal au 'auto', ce qui a pour effet de créer un dossier par défaut automatiquement. Si cette propriété est déjà renseignée, la nouvelle valeur ne sera pas prise en compte.
METHOD	Indique le nom du fichier contenant les méthodes supplémentaires de la famille. Cette propriété peut être utilisé sur plusieurs lignes. Dans ce cas les valeurs de lignes suivant devront être précédée du caractère '+'. Si on précède le valeur par '*', cela indique que ce fichier n'est pas intégré directement dans la famille; mais qu'il est utilisé comme méthodes héritées. Cela implique que les méthodes définies dans ce fichier peuvent être redéfinies dans un autre fichier méthodes.
WID	identifiant du cycle de vie associé à la famille
CVID	identifiant du contrôle de vue associé à la famille
SCHAR	caractéristique spéciale pour le révision : 'R' : signifie auto révision à chaque modification 'S' : signifie document non révisable
USEFOR	caractère désignant une utilisation spéciale. Seulement pour les documents systèmes : 'W' : pour les cycles de vie 'G' : pour les intercalaires de chemise 'P' : pour les profils
TAG	caractère désignant une marque applicative. Cette marque peut être utilisé sur plusieurs lignes ce qui a effet d'ajouter une marque. Les documents crées auront aussi cette marque.

Attributs

Les caractéristiques des attributs suivent les explications données au paragraphe 5.1

	idattr	idframe	label	T	A	type	ord	vis	need	link	phpfile	phpfunc	elink	constraint	option
1	2	3	4	5	6	7	8	9	10	11	12	13	14	15	16
ATTR	US_FR_SEARCHLDAP		LDAP Recherche	N	N	frame	0	W
ATTR	LDAP_GETINFO	US_FR_SEARCHLDAP	login LDAP	N	N	text	500	O			nu.php	searchLDAPinfo(LDAP_GETINFO): US_LOGIN,US_FNAME,US_LNAME			esize=20

Définition des colonnes :

ATTR
identifiant de l'attribut
identifiant du cadre ou du tableau englobant
désignation de l'attribut
'Y' signifie qu'il fait partie du titre, 'N' il ne fait pas partie du titre
'Y' signifie qu'il fait partie du résumé, 'N' il ne fait pas partie du résumé
type de l'attribut
ordre de l'attribut
visibilité de l'attribut
'Y' signifie qu'il est obligatoire, 'N' il ne fait pas obligatoire
définition de l'hyperlien
nom du fichier php pour l'aide à la saisie
nom et attributs de la fonction pour l'aide à la saisie ou nom et attributs de la méthode de calcul (précédé de ::) s'il s'agit d'un attribut calculé (visibilité W)
extra lien
nom et attribut de la méthode de contrainte
options de présentation séparées par des '|'.

Pour modifier la définition d'un attribut d'une famille mère, on utilisera MODATTR au lieu de ATTR. Cela indique que toute propriété non valué aura la valeur de l'attribut défini dans la famille mère.

Types Spéciaux

Options

:!: A reprendre (obsolète) La définition d'un attribut option est identique à celle d'un attributs normal. Il suffit de mettre OPTION dans la première colonne au lieu de ATTR.

//	idattr	idframe	label	T	A	type	ord	vis
OPTION	USGATE_URL	SGATE_FR_PARAM	url	N	N	text	60	W

//	idattr	idframe	label	T	A	type	ord	vis	Link
ATTR	GGATE_IDSERV1	GGATE_FR_SERV1	id service	N	N	docid	10	N
ATTR	GGATE_SERV1	GGATE_FR_SERV1	service	N	N	text	10	N	%S%app=FDL&action=IMPCARD&id=%GGATE_IDSERV1%&opt=%GGATE_IDENT1%
ATTR	GGATE_IDENT1	GGATE_FR_SERV1	l'option	N	N	option (“GGATE_IDSERV1”)	30	N

Ces attributs sont utilisables par les documents qui référencent les documents avec options à l'aide des attributs de type 'option'. Ne pas confondre les attributs normaux de type 'option' qui référence des options avec les attributs 'option' qui définissent les possibles options du documents lors du lien.

IATTR

Copie d'attributs d'une frame d'une autre familles.

famille portail			id	name
BEGIN	DIR	dossier événements		SCALENDAR
TYPE	C
	idattr	idframe	id famille
IATTR	DCAL_FR_PRESENT		DCALENDAR
END

Cette exemple copie les attributs et le frame DCAL_FR_PRESENT de la famille DCALENDAR dans la famille SCALENDAR que l'on défini. Cela est utile dans la cas de ressemblance de famille mais sans héritage souhaité.

Paramètres

La définition d'un paramètre est identique à celle d'un attribut normal. Il suffit de mettre PARAM dans la première colonne au lien de ATTR.

//	idattr	idframe	label	T	A	type	ord
PARAM	WSGAT_FR_PAR		météo	N	N	frame	10
PARAM	WSGATE_URL	WSGAT_FR_PAR	url site météo	N	N	text	20

Valeurs par défaut

Les valeurs par défaut sont déclarées à l'aide du mot-clef DEFAULT dans la première colonne.

1	2	3
DEFAULT	SGATE_ACTION	GATE_WEATHER
DEFAULT	SGATE_IDRED	::userDocId()
DEFAULT	SGATE_RED	::getTitle(SGATE_IDRED)
DEFAULT	SGATE_DATE	::getDate()
DEFAULT	SGATE_ARRAY	ligne1\nligne2\nligne3

Définition des colonnes :

DEFAULT
identifiant de l'attribut
valeur par défaut. Soit du texte statique. Soit l'appel à une méthode connue de la famille. Pour les attributs à l'intérieur d'un tableau (array), il est possible d'initialiser plusieurs lignes du tableau en séparant chaque ligne par un '\n'