function int MetaDataOpen

• chargement de la dll "DhDivaltoRTFtoHTMLConnector.dll",

• contient le code pour extraire le fichier xml factur-x d'un fichier pdf

• renvoi 0 si ok , sinon renvoi la valeur 1 si le chargement n'a pas aboutit

function int MetaDataClose

• ferme la dll "DhDivaltoRTFtoHTMLConnector.dll", elle renvoi toujours 0

function int MetaDataExtractFacturxToFile(fichier,fichierxml,&txterr,options)

1 fichier A ;fichier pdf a lire avec un chemin windows
1 fichierxml A ;fichier dans lequel la dll va écrire le fichier xmnp qui contient les metadatas au format xml du fichier pdf

1 txterr A ;texte d'erreur si la fonction renvoi <> 0
1 options A ;options pour le futur, pour l'instant mettre un chaine à espace

• extraction du fichier xml facturx d'un fichier pdf

• fichierxml : ! doit déjà exister, et à supprimer ensuite

Le fichierxml doit déjà exister. On peut le créer avec la séquence suivante

puis le supprimer

function int MetaDataExtractMetadataToFile(fichier,fichierxml,&txterr,options)

1 fichier A
1 fichierxml A
1 txterr A
1 options A

• extraction du fichier metadata xmp (xmnp) d'un fichier pdf

• fonctionne exactement comme MetaDataExtractFacturxToFile mais au lieu de renvoyer le fichier factur-x, elle renvoi le fichier metadata xmp (ou xmnp)

Fichier xmp ou xmnp

C'est un fichier xml qui decrit le type de fichier pdf , il contient le titre du fichier, la date de création et certaine informations comme le mode pdf a 3, la liste des mot clés, c'est dans ce fichier que divalto écrit les informations provenant de

err = MetaDataModele("BASIC") ;par défaut BASIC
err = MetaDataTitle("facture_Nebout_125e_du_12/08/2021") ;titre
err = MetaDataSubject("facture client Nebout de 125 euro pour livres du 12/08/2021") ;le sujet
err = MetaDataKeywords("facture Nebout livres") ;mot cles pour la recherche dans les metadatas

et les caractéristiques du fichier pdf

Vous pouvez trouver la définition d'un fichier "xmp metadata pdf" sur internet

Voici un exemple :

Harmony a un modèle de base d'un fichier xmp mais on peut lui fournir un autre modèle s'il faut au moment de la génération du fichier dhvw avec la commande

err = MetaDataFileMetaData( "chemin et fichier xml au format windows a prendre comme modèle xmp")

ou alors de façon globale a toute les impressions en mettant dans regedit
Ordinateur\HKEY_CURRENT_USER\SOFTWARE\Divalto\divalto.ini
chapitre PDF mot cle "metadataXMNPFile" ;il faut mettre le chemin et le nom du fichier a lire

on peut saisir ce paramètre dans divaltoViewer -> menu Options => Paramètres => Convertion PDF

=> bouton Mode PDFA => Prendre le fichier XMNP par défaut sinon prendre ce fichier XMNP

le fichier sera intégré au fichier dhwv et c'est lui qui servira de modèle xmp lors de la conversion du dhvw en pdf
il faut mettre des mots clés que divaltoviewer modifira aves les valeurs title,key words etc au momment de la génération du pdf
voila le code xmp que harmony prend par defaut

les mots clés

• %%metadatasubject%% sera remplacé par la valeur de la fonction MetaDataSubject

• %%metadataTitle%% sera remplacé par la valeur de la fonction MetaDataTitle

• %%metadataProducer%% actuellement toujours le texte "Generateur PDF de DivaltoViewer v1.92"

• %%metadataCreator%% "Divalto"

• %%metadataKeywords%% sera remplacé par la valeur de la fonction MetaDataKeywords

• %%metadataCreationDate%% sera remplacé par la valeur de la date en cours

• %%metadataDocumentFileName%% sera remplacé par la valeur factur-x.xml ou xrechnung.xml

• ( si le modele est "XRECHNUNG" au lieu de BASIC Extended etc dans la fonction MetaDataModele()
  alors le nom du fichier factur-x n'est plus "factur-x.xml" mais doit être "xrechnung.xml"
  c'est une particuliriaté du modèle XRECHNUNG allemand )

• %%metadataVersionDocumentFileName%% actuellement toujours "1.0"

• %%metadataConformanceLevel%% sera remplacé par la valeur de la fonction MetaDataModele

• %%metadataDocumentID%% c'est un guid qui est calculé au moment de la conversion pdf,

• %%metadataInstanceID%% c'est un guid qui est calculé au moment de la conversion pdf
  %%metadataDocumentID%% et %%metadataInstanceID%% identifie de façon unique le document

• %%metadataAuthor%% "ERP Divalto " HARMONY_VERSION " - DivaltoViewer v1.92 11/12/2021" mais on l'a pas mis dans le modèle par défaut
  car certains vérificateurs pdf-A 3b provoque une erreur si

si on personnalise le fichier xmp , vous pouvez ajouter 3 mots clés qui seront remplacés par leurs valeurs

%%metadataParam1%% ce sont 3 valeurs que l'on peut positionner lorsqu'on crée le dhvw dans le code diva en utilisant la fc

%%metadataParam2%% MetaDataOptions("PARAM1","xxxxx") MetaDataOptions("PARAM2","xxxxx") MetaDataOptions("PARAM3","xxxxx")

%%metadataParam3%%

contenu du fichier xmp que prend divaltoviewer et qui intégré dans divaltoviewer

Harmony a aussi un modèle de base d'un ICC (description du modèle des couleurs, par défaut harmony à un fichier de couleur de base de winddows sRGB IEC61966-2-1) mais qu'on peut lui fournir un autre modèle ICC s'il faut au moment de la génération du fichier dhvw avec la commande
err = MetaDataFileICC( "chemin et fichier icc format windows a prendre comme modèle de couleur")
ou alors de façon globale a toute les impressions en mettant dans regedit

Ordinateur\HKEY_CURRENT_USER\SOFTWARE\Divalto\divalto.ini
chapitre PDF mot cle "metadataICCFile" ;il faut mettre le chemin et le nom du fichier a lire

on peut saisir ce paramètre dans DivaltoViewer -> menu Options => Paramètres => Conversion PDF
=> bouton Mode PDFA => Prendre le fichier ICC par défaut sinon prendre ce fichier ICC
=> Prendre l'identifiant ICC par défaut sinon prendre cet identifiant , par défaut harmony utilise le modèle "sRGB IEC61966-2-1"
et donc l'identifiant d’harmony est "sRGB IEC61966-2-1

function int FacturXBegin(option)

Chargement de la dll facturx.

• 0 si ok

• 1 si erreur

• 1 option x = 0 ;pour évolution future

function int FacturXEnd(option)

Déchargement de la dll facturx
1 option x = 0 ;pour évolution future

function int FacturXGetVersion

function int FacturXGetDLLVersion

function char FacturXGetErreur

Cette fonction renvoi la liste des erreurs en cours et supprime a chaque fois le texte de l’erreur qu’elle vient de renvoyer au programme diva.

Le programme reçoit donc toujours les dernières erreurs non lues par lui

function char FacturXReadOpen(fichier,option)

1 fichier A
1 option x = 0 ;pour évolution future

Lecture d'un fichier xml facturx, elle ouvre le fichier et charge la description xml

Retour :

• espace = ok

• sinon texte de l'erreur
  
  

function char FacturXReadClose(option)

1 option x = 0 ;pour évolution future

Fermeture du fichier xml facturx , elle libère le fichier (on peut apres le supprimé par exemple)
Retour:

• espace = ok

• sinon texte de l'erreur
  
  

function char FacturXGetGlobalProps(&liste,option)

1 liste L
1 option x = 0 ;pour évolution future

Renvoi la liste des propriétés globales SAUF les lignes détails, ainsi que les listes de tableaux de dictionnary
Retour :

• espace = ok

• sinon texte de l'erreur
  
  

Attention : cela crée des dictionnary, il faut utiliser la fonction FacturXDictionaryDestroy apres avoir traiter les propriétés.

Pour rechercher si un élément existe , il faut utiliser la fonction DictionarySearch (ident , clé, élément) en fonction de ce que vous traité dans le programme diva

voir aussi les fonctions DictionaryBegin et DictionaryNext pour parcourir une liste de dictionnary.

exemple

On peut donc recevoir une liste de propriétés (voir la page dédiée)

function char FacturXGetGlobalNotes(&liste,option)

Renvoi la liste des notes globales , c’est uniquement si on veut traiter les notes
espace = ok
sinon texte de l'erreur

C’est une fonction a part car cela peut être optionnel si on ne traite pas la gestion des notes dans facturx
et cella peut demander plus de temps cpu pour charger les notes

1 liste L
1 option x = 0 ;pour évolution future

function char FacturXGetGlobalDocumentsInFiles(&liste,option)

Renvoi la liste des documents globaux, c’est uniquement si on veut traiter les fichiers joints
espace = ok
sinon texte de l'erreur

C’est une fonction a part car cela peut être optionnel si on ne traite pas la gestion des fichiers joints dans facturx et cella peut demander plus de temps cpu pour charger les joints et ca crées des fichiers temporaires.

Attention : cela crée des dictionnary, il faut utiliser la fonction FacturXDictionaryDestroy apres avoir traiter les propriétés.

Il faut les supprimés à la fin du traitement en appelant la fonction FacturXDeleteTmpFiles().

Si on les supprimes directement dans le programme diva alors il faut appeler la fonction FacturXClearListTmpFiles() pour vider la liste des fichiers à supprimés qui se trouve dans la dll.

1 liste L
1 option x = 0 ;pour évolution future

function char FacturXGetLineProps(&liste,option)

1 liste L
1 option x = 0 ;pour évolution future

Renvoie la liste des props d'une ligne détail

Retour :

• 1 = ok boucler pour lire la suivante

• espace = fin de la liste

• sinon texte de l'erreur
  
  

Attention : cela crée des dictionnary, il faut utiliser la fonction FacturXDictionaryDestroy apres avoir traiter les propriétés.

function char FacturXGetLineNotes(&liste,option)

1 liste L
1 option x = 0 ;pour évolution future

Renvoie la liste des note de la ligne détail en cours
;"1" = ok boucler pour lire la suivante
;espace = fin de la liste
;sinon texte de l'erreur

Attention : cela crée des dictionnary, il faut utiliser la fonction FacturXDictionaryDestroy apres avoir traiter les propriétés.

function char FacturXGetLineDocumentsInFiles(&liste,option)

1 liste L
1 option x = 0 ;pour évolution future

Renvoie la liste des documents de la ligne détail en cours
Retour :

• 1 = ok boucler pour lire la suivante

• espace = fin de la liste

• sinon le texte de l'erreur
  
  

Attention : cela crée des dictionnary, il faut utiliser la fonction FacturXDictionaryDestroy apres avoir traiter les propriétés.

Il faut les supprimés à la fin du traitement en appelant la fonction FacturXDeleteTmpFiles().

Si on les supprimes directement dans le programme diva alors il faut appeler la fonction FacturXClearListTmpFiles() pour vider la liste des fichiers à supprimés qui se trouve dans la dll.

procedure FacturXDictionaryDestroy

Supprime les dictionary qui sont dans la liste dictionary à supprimer

function char FacturXDeleteTmpFiles

Les fonctions suivantes

• FacturXGetGlobalDocumentsInFiles

• FacturXGetGlobalNotes

• FacturXGetLinesDocumentsInFiles

• FacturXGetLignesNotes

génèrent des fichiers temporaires, à chaque création d'un fichier temporaire (stockés dans un liste interne)

Cette fonction permet de supprimer tous ces fichiers lorsqu'on fini de les traitées

On peut appeler cette fonction quand on veut, si la liste des fichiers temporaires est vide, cette fonction ne fait rien et retourne dans diva

function char FacturXClearListTmpFiles

En alternative à FacturXDeleteTmpFiles, cette fonction permet de vider la liste des fichiers temporaire, dans ce cas c'est au programme diva de traiter ce qu'il doit faire avec ces fichiers temporaires.

On peut appeler cette fonction quand on veut, si la liste des fichiers temporaires est vide, cette fonction ne fait rien et retourne dans diva

procedure FacturXAppendDictonaryDestroy(wliste)

1 wliste L

Ajoute un ident d'un dictionary à la liste des dictionary à supprimer

function int FacturXOption(option,valeur)

1 option A
1 valeur A