Gestion des documents – Documentation Efalia

GedDocumentList

GedDocumentList permet de récupérer toutes les données systèmes et métadonnées des documents d’un dossier GED au format XML.

int GedDocumentList(
  char *Armoire,
  char *User,
  char *SaveFile,
  char *Sd,
  char *Ssd,
  char *NomFile
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

SaveFile : Chemin de destination du fichier XML généré

Sd : Nom du sous-dossier de classement (facultatif)

Ssd : Nom du sous-sous-dossier de classement (facultatif)

NomFile : Nom du fichier dans la GED (facultatif)

Codes retour

0 ou code erreur

Information

Les paramètres Sd, Ssd et File permettent de filtrer les résultats.

Exemple (C++)

// Récupération du contenu du dossier
// Le fichier XML généré est enregistré dans c:\Mes Documents\111545.xml
// – Armoire MDPH, DOSSIERGED=111545
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », »111545″);
RetValue = GedDocumentList( « MDPH »,
                           « PAUL »,
                           « c:\Mes documents\111545.xml »,
                           «  »,
                           «  »,
                           «  »);

GedDocumentExist

GedDocumentExist permet de vérifier l’existence d’un document dans un dossier GED identifié.

Cette recherche peut s’effectuer de deux manières :

En fonction du classement du document recherché (Sd / Ssd / NomFile)
- Dans ce contexte, c’est l’identifiant du document le plus récent correspondant au Plan De Classement transmis qui est retourné
A partir de la référence du document préalablement renseignée

int GedDocumentExist(
  char *Armoire,
  char *User,
  char *Sd,
  char *Ssd,
  char *NomFile,
  char *RefDoc,
  char *TypeDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

Sd : Nom du sous-dossier de classement (facultatif)

Ssd : Nom du sous-sous-dossier de classement (facultatif)

NomFile : Nom du fichier dans la GED (facultatif)

RefDoc : Référence du document (donnée par l’application métier)

TypeDoc : Autre référence du document (donnée par l’application métier)

Codes retour

Numéro système Multigest du document trouvé ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Codes retour :

UID du document trouvé ou code erreur

Information

Le numéro système du document (IdDoc) est toujours positif.

Information

La recherche est prioritaire sur la référence du document.
Dans le cas d’une recherche sur classement, plusieurs documents peuvent être identifiés. Dans ce cas, c’est le plus récent qui est retourné.

Exemple (C++)

// Recherche un document par sa référence REF322
// – Armoire MDPH, DOSSIERGED=111545
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », »111545″);
IdDoc = GedDocumentExist( « MDPH »,
                         « PAUL »,
                         «  »,
                         «  »,
                         «  »,
                         « REF322 »);

GedDocumentConsult

GedDocumentConsult permet de générer une url (Multigest) de consultation d’un document identifié par son numéro système Multigest.

char *GedDocumentConsult(
  char *Armoire,
  char *User,
  long IdDoc,
  int ReadOnly
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

ReadOnly : Document ouvert en lecture seule (0 / 1) : 1 par défaut

Codes retour

Numéro de session ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Information

Le numéro de session retourné par cette fonction permet de construire l’url de connexion.
A la connexion, le numéro de session généré est détruit pour des raisons de sécurité.
URL : http://[Serveur]:[Port]/consultation/VisioDocRedirect.php?session=

Information

L’interface pourra prendre 2 états différents en fonction de l’argument ReadOnly

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

// Consultation du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
RetValue = GedDocumentExist( « MDPH »,
                            « PAUL »,
                            « 365 »,
                            0);

Version MG à partir de 9.6.0 SVN16297

// Consultation du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentExist( « MDPH »,
                            « PAUL »,
                            « 365 »,
                            0);

GedDocumentDelete

GedDocumentDelete permet de générer supprimer un document identifié par son numéro système Multigest.

char *GedDocumentDelete(
  char *Armoire,
  char *User,
  long IdDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Codes retour

0 ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Information

La suppression d’un document implique la suppression de tous les indices associés au document.
Si la corbeille est activée sur l’armoire, le document est déplacé dans la corbeille.

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

// suppression du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
RetValue = GedDocumentDelete( « MDPH »,
                             « PAUL »,
                             « 365 »);

Version MG à partir de 9.6.0 SVN16297

// suppression du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentDelete( « MDPH »,
                             « PAUL »,
                             « 365 »);

GedDocumentDownload

GedDocumentDownload permet de récupérer un document identifié par son numéro système Multigest.

char *GedDocumentDownload(
  char *Armoire,
  char *User,
  long IdDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Codes retour

Nom complet (extension comprise) du document à télécharger ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Information

Le nom du document à télécharger, retourné par cette fonction permet de construire l’url de téléchargement suivante.
URL : http://[Serveur]:[Port]/tmpimg/
Ex: http://localhost:80/tmpimg/Facture_001.pdf

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

GedInitConnection([SERVEURGED],[PORT],0);
// Recherche un document par sa référence REF322
// – Armoire MDPH, DOSSIERGED=111545
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
IdDoc = GedDocumentExist( « MDPH »,
                         « PAUL »,
                         «  »,
                         «  »,
                         «  »,
                         « REF322 »);
// Récupération du document précédemment retrouvé (IdDoc)
// – Armoire MDPH, DOSSIERGED=111545
RetValue = GedDocumentDownload( « MDPH »,
                               « PAUL »,
                               IdDoc);
// L'url à construire est http://[Serveur]:[Port]/tmpimg/RetValue

Version MG à partir de 9.6.0 SVN16297

GedInitConnection([SERVEURGED],[PORT],0);
// Recherche un document par sa référence REF322
// – Armoire MDPH
IdDoc = GedDocumentExist( « MDPH »,
                         « PAUL »,
                         «  »,
                         «  »,
                         «  »,
                         « REF322 »);
// Récupération du document précédemment retrouvé (IdDoc)
// – Armoire MDPH
RetValue = GedDocumentDownload( « MDPH »,
                               « PAUL »,
                               IdDoc);
// L'url à construire est http://[Serveur]:[Port]/tmpimg/RetValue

GedDocumentOcrDownload

GedDocumentOcrDownload permet de récupérer un document identifié par son numéro système Multigest.

Renvoi le fichier OCR si existant (uniquement pour les PDF).

char *GedDocumentOcrDownload(
  char *Armoire,
  char *User,
  long IdDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Codes retour

Nom complet (extension comprise) du document à télécharger ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Information

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

GedInitConnection([SERVEURGED],[PORT],0);
// Recherche un document par sa référence REF322
// – Armoire MDPH, DOSSIERGED=111545
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
IdDoc = GedDocumentExist( « MDPH »,
                         « PAUL »,
                         «  »,
                         «  »,
                         «  »,
                         « REF322 »);
// Récupération du document précédemment retrouvé (IdDoc)
// – Armoire MDPH, DOSSIERGED=111545
RetValue = GedDocumentDownload( « MDPH »,
                               « PAUL »,
                               IdDoc);
// L'url à construire est http://[Serveur]:[Port]/tmpimg/RetValue

Version MG à partir de 9.6.0 SVN16297

GedInitConnection([SERVEURGED],[PORT],0);
// Recherche un document par sa référence REF322
// – Armoire MDPH
IdDoc = GedDocumentExist(« MDPH »,
                         « PAUL »,
                         «  »,
                         «  »,
                         «  »,
                         « REF322 »);
// Récupération du document précédemment retrouvé (IdDoc)
// – Armoire MDPH, DOSSIERGED=111545
RetValue = GedDocumentDownload( « MDPH »,
                               « PAUL »,
                               IdDoc);

GedDocumentStreamDownload

GedDocumentStreamDownload permet de récupérer un document identifié par son numéro système Multigest.

char *GedDocumentStreamDownload(
  char *Armoire,
  char *User,
  long IdDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Codes retour

Flux du fichier à télécharger (au format base64) ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

// récupération du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
RetValue = GedDocumentStreamDownload( « MDPH »,
                                     « PAUL »,
                                     IdDoc);

Version MG à partir de 9.6.0 SVN16297

// récupération du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentStreamDownload( « MDPH »,
                                     « PAUL »,
                                     IdDoc);

GedDocumentStreamDownloadFromRef

GedDocumentStreamDownloadFromRef permet de récupérer un document identifié par son numéro système Multigest.

char *GedDocumentStreamDownloadFromRef(
  char *User,
  long RefDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

RefDoc : Identifiant du document

Codes retour

Flux du fichier à télécharger (au format base64) ou code erreur

Exemple (C++)

// récupération du document avec REFDOC=A001521458
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentStreamDownloadFromRef(« PAUL »,
                                            « A001521458 »);

GedDocumentMove

GedDocumentMove permet de reclasser (déplacer) un document identifié par son numéro système Multigest.

char *GedDocumentMove(
  char *Armoire,
  char *User,
  long IdDoc,
  char *Sd,
  char *Ssd,
  char *NomFile
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Sd : Nom du sous-dossier de classement (facultatif)

Ssd : Nom du sous-sous-dossier de classement (facultatif)

NomFile : Nom du fichier dans la GED (obligatoire)

Codes retour

0 ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

// Reclassement du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
// – Nouveau classement : Demande/Formulaire
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
RetValue = GedDocumentMove( « MDPH »,
                           « PAUL »,
                           « 365 »,
                           « Demande »,
                           «  »,
                           « Formulaire »);

Version MG à partir de 9.6.0 SVN16297

// Reclassement du document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH
// – Nouveau classement : Demande/Formulaire
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentMove( « MDPH »,
                           « PAUL »,
                           « 365 »,
                           « Demande »,
                           «  »,
                           « Formulaire »);

GedDocumentGetProperties

GedDocumentGetProperties permet de récupérer toutes les données systèmes et métadonnées du document identifié au format XML.

int GedDocumentGetProperties(
  char *Armoire,
  char *User,
  char *SaveFile,
  long IdDoc
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

SaveFile : Chemin de destination du fichier XML généré

IdDoc : Numéro système Multigest du document

Codes retour

0 ou code erreur

Exemple (C++)

// Informations sur le document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
// Le fichier XML généré est enregistré dans c:\Mes Documents\365.xml
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », »111545″);
RetValue = GedDocumentGetProperties( « MDPH », « PAUL »,
                                    « c:\Mes Documents\365.xml »,
                                    « 365 »);

GedDocumentSetProperty

GedDocumentSetProperty permet modifier une métadonnée du document (par exemple sa référence).

int GedDocumentSetProperty(
  char *Armoire,
  char *User,
  long IdDoc,
  char *Property,
  char *Value
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Property : Nom de la propriété

Value : Valeur de la propriété

Codes retour

0 ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Liste des propriétés

Les propriétés accessibles sont aujourd’hui au nombre de 2 :

« REFDOC » : référence du document
« TYPEDOC » : champ libre pour ajouter une seconde référence ou autre

Exemple (C++)

Version MG inférieure à 9.6.0 SVN16297

// Modifie la référence d'un document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH, DOSSIERGED=111545
// – Nouvelle référence : REFDOC=REF365
GedInitConnection([SERVEURGED],[PORT],0);
GedAddChampRecherche(« DOSSIERGED », « 111545 »);
RetValue = GedDocumentGetProperties( « MDPH », « PAUL »,
                                    « 365 »,
                                    « REFDOC »,
                                    « REF365 »);

Version MG à partir de 9.6.0 SVN16297

// Modifie la référence d'un document précédemment retrouvé (IdDoc=365)
// – Armoire MDPH
// – Nouvelle référence : REFDOC=REF365
GedInitConnection([SERVEURGED],[PORT],0);
RetValue = GedDocumentGetProperties( « MDPH », « PAUL »,
                                    « 365 »,
                                    « REFDOC »,
                                    « REF365 »);

GedDocumentMdatasUpdate

GedDocumentMdatasUpdate permet modifier des métadonnées de la fiche nature du document.

int GedDocumentMdatasUpdate(
  char *Armoire,
  char *User,
  long IdDoc,
  char *Fields,
  char *Value
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

IdDoc : Numéro système Multigest du document

Fields : Nom des propriétés (séparateur |)

Value : Valeur des propriétés (séparateur |)

Codes retour

1 ou code erreur

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)

Exemple (php/SOAP)

$ApiGed = new SoapClient('http://srvGED/Interconnexion/SoapService.php?wsdl');
$result = $ApiGed->GedDocumentMdatasUpdate('PAIE', 'admin', 1234, 'ANNEE|MOIS|NOM', '2018|01|Durand');
echo $result;

GedOpenViewer

GedOpenViewer permet d’ouvrir un document dans les visionneuses de la GED.

char* GedOpenArmoire(
  char *Armoire,
  char *User,
  char * EditMode ,
  char * IdDoc,
  char * RefDoc,
  char * GetUrl ,
  char * WindowSize
  );

Paramètres

Armoire : Nom physique de l’armoire

User : Login de l’utilisateur

EditMode : Mode d’Edition d’ouverture de la visionneuse. 0 => lecture seule uniquement, 1 => fonction des droits utilisateurs, 2 => Mode édition forcée indépendant des droits utilisateurs

IdDoc : Identifiant du document dans l’armoire de Multigest. Si le paramètre RefDoc est transmis non vide => définir IdDoc à 0

RefDoc : Optionnel (défaut = chaine vide).Référence du document dans l’armoire de Multigest utilisé pour trouver l’identifiant du doc à la place du paramètre IdDoc

GetUrl : Optionnel (défaut = 0).Activation de la transmission de l’url complète dans la valeur de retour. 1 => url complète, 0 => n° session

WindowSize : Optionnel (défaut = chaine vide) .Taille et position d’ouverture de la popup (format chaine = top,left,width,height. Ex: « 20,20,200,300 »). Nombre uniquement (unité utilisé le pixel)

Codes retour

Cette fonction retourne un Numéro de session ou Url complète (selon le paramètre GetUrl) ou un code erreur.

Information

Mode UID activé

Ce paragraphe surcharge les indications données précédemment.

Paramètres :

Armoire : Laisser vide

IdDoc : Identifiant Unique du document (UID)