« Guide des formats » : différence entre les versions

Dernière version du 4 novembre 2017 à 09:57

stock}}

Les formats de fichier permettent de décrire les correspondances entre une structure de données variable et un modèle métier.

Une fois cette correspondance établie il est possible d'importer ou d'exporter des fichiers correspondants à cette structure.

Vue globale

Administration

Les formats sont stockés dans le référentiel.

Filtres de caractères

Pour les formats de génération, il est possible de filtrer les données écrites dans le fichier généré.

Pour cela, quatre choix sont possibles.

Aucun
CFONB

Voir le fonctionnement du filtre

EDI

Voir le fonctionnement du filtre

Personnalisé

Pour chaque caractère de la chaîne à filtrer:

si le caractère appartient à la liste des caractères autorisés il n’est pas filtré.

sinon on enlève ses éventuels accents.

si le caractère sans accent n’appartient toujours pas à la liste des caractères autorisés, il est remplacé par un blanc.

Exemple de filtre personnalisé, caractères autorisés "abcde" :

"aa" donne "aa"

"azza" donne "a a"

"aéèêa" donne "aeeea"

Schémas

Pour les formats de type xml, un schéma (fichier xsd) est requis à l'exécution.

Lorsque le schéma est chargé, il apparaît dans les documents xml associés (lui ainsi que les schémas qu'il référence)

Mise en œuvre

Importer un fichier

L'importation d'un fichier en utilisant un format de définition peut s'effectuer

Dans un processus métier par script métier

Utiliser la méthode d'importation de fichier en utilisant un format.

A partir de l'assistant d'importation

Cochez "Format de fichier" puis sélectionner le format de définition souhaité.

Tip : En général l'importation de fichier structuré complexe nécessite un processus pour transformer et compléter les informations de sorte que cette méthode utilisant l'assistant d'importation est rarement utilisable.

Exporter un fichier

Utiliser la méthode de génération de fichier en utilisant un format.

Gestion des formats

Si les formats sont stockés sous forme xml dans le référentiel pour des raisons de performance, la définition des formats s'effectue dans une base métier. (La conception d'un format peut ainsi s'effectuer en web).

Ainsi, il est nécessaire d'enregistrer le format dans le référentiel pour que les modifications apportées soient prises en compte lors de l'exécution.

Utiliser les interfaces utilisateurs situées dans le menu "Outils/Définition des formats"

Pour créer un format utilisez l'assistant de création de format :

Tip : La duplication est une solution simple pour apporter des modifications à format système

Voir aussi :

Référence des formats de fichiers

@@ Ligne 1 : / Ligne 1 : @@
-=Définition=
+{{new|650}}
-Les formats décrivent un format de fichier et les correspondances entre les données à générer et le modèle métier.
+Les formats de fichier permettent de décrire les correspondances entre une structure de données variable et un modèle métier.
-La conception des formats s'effectue en mode projet.
+Une fois cette correspondance établie il est possible d'importer ou d'exporter des fichiers correspondants à cette structure.
+==Vue globale==
+{{#images:apres_tahoe.jpg|formats}}
-=Mise en œuvre=
+==Administration==
+Les formats sont stockés dans le référentiel.
-==Intégrer un fichier==
+{{#images:formats_admin.png|formats}}
-'''procedure IntegrateByFormatDef(const aCodeFormat:string;const aData:TStrings;aRefObject:TitObject;const aLogLevel:integer);'''
+===Filtres de caractères ===
+{{#images:formats_filtres_car.png|formats}}
-'''aCodeFormat''' : code du format
+Pour les formats de génération, il est possible de filtrer les données écrites dans le fichier généré.
-'''aData''' : fichier à intégrer
+Pour cela, quatre choix sont possibles.
+* Aucun
+* CFONB
+: [[TextToCFONBText_(rtl)|Voir le fonctionnement du filtre]]
+* EDI
+: [[TextToEDIText_(rtl)|Voir le fonctionnement du filtre]]
+* Personnalisé
+: Pour chaque caractère de la chaîne à filtrer:
+:: si le caractère appartient à la liste des caractères autorisés il n’est pas filtré.
+:: sinon on enlève ses éventuels accents.
+:: si le caractère sans accent n’appartient toujours pas à la liste des caractères autorisés, il est remplacé par un blanc.
-'''aRefObject''' : objet qui tient les objets qui seront créés
+Exemple de filtre personnalisé, caractères autorisés "abcde" :
-'''aLogLevel''' : niveau de log
+: "aa" donne "aa"
+: "azza" donne "a  a"
+: "aéèêa" donne "aeeea"
-==Générer==
+===Schémas===
+Pour les formats de type xml, un schéma (fichier xsd) est requis à l'exécution.
-'''function GenerateByFormatDef(const aCodeFormat:string;aRefObject:TitObject ; var aRes:String ; const aLogLevel:FormatLogLevel):boolean'''
+Lorsque le schéma est chargé, il apparaît dans les documents xml associés (lui ainsi que les schémas qu'il référence)
-retourne vrai si aucune donnée obligatoire n'est absente, faux sinon.
+==Mise en œuvre==
-'''aCodeFormat''' : code du format
+===Importer un fichier===
+L'importation d'un fichier en utilisant un format de définition peut s'effectuer
-'''aRefObject''' : l'objet à générer
+* Dans un processus métier par script métier
-'''aRes''' : si la fonction retourne vrai, aRes est la chaine retournée représentant le contenu généré que l'on pourra ensuite enregistrer sinon aRes contient les erreurs rencontrées
+Utiliser la méthode d'[[ImportByFormatDef (rtl)|importation de fichier en utilisant un format]].
-'''aLogLevel''' : niveau de log
+* A partir de l'assistant d'importation
+Cochez "Format de fichier" puis sélectionner le format de définition souhaité.
-==La trace==
+{{#images:format7.png|formats}}
-La trace générée se situe dans [container L1000]/logs
+{{tip|En général l'importation de fichier structuré complexe nécessite un processus pour transformer et compléter les informations de sorte que cette méthode utilisant l'assistant d'importation est rarement utilisable.}}
-Trois niveaux de trace sont disponibles
+===Exporter un fichier===
+Utiliser la méthode de [[ExportByFormatDef (rtl)|génération de fichier en utilisant un format]].
-* '''Format_Log_Level_None''' : aucune trace
+==Gestion des formats==
-* '''Format_Log_Level_Data_Errors''' : trace les erreurs d'accès au données (formule erronée...) utile pour la mise au point des nouveaux formats
+Si les formats sont stockés sous forme xml dans le référentiel pour des raisons de performance, la définition des formats s'effectue dans une base métier. (La conception d'un format peut ainsi s'effectuer en web).
-* '''Format_Log_Level_Verbose''' : trace l'exploration du fichier / du modèle (trace importante en taille) + Format_Log_Level_Data_Errors
+Ainsi, il est nécessaire d'enregistrer le format dans le référentiel pour que les modifications apportées soient prises en compte lors de l'exécution.
+{{#images:SCRFORMGENXML_ACTION.png|formats}}
-=Vue globale=
+Utiliser les interfaces utilisateurs situées dans le menu "Outils/Définition des formats"
+{{#images:format1.png|formats}}
-{{#images:apres_tahoe.jpg|formats}}
+{{#images:format2.png|formats}}
+Pour créer un format utilisez l'assistant de création de format :
+{{#images:format6.png|formats}}
+{{tip|La duplication est une solution simple pour apporter des modifications à format système}}
-=Administration=
+Voir aussi :
+[[Reference_format_fichier|Référence des formats de fichiers]]
-{{#images:admin1.jpg|formats}}
+[[Category:RTL Format de fichier]]
+[[Category:Version650]]