ENR-ACT-GED
Cette fonction DIALOG disponible sur tout type de requête permet de gérer toutes les actions de gestion sur les documents GED :
Référencement
Rattachement
Modification Document
Suppression Liens
Suppression Document
Caractéristiques Document
TYPE Caractère
SYNTAXE
Variable = ENR-ACT-GED ( )
PARAMETRES
Aucun.
Le comportement de la fonction dépend de l’initialisation des listes standard suivantes:
WfGEDEnt
Elle décrit les actions de gestion à enregistrer sur un document.
WfGEDLien
Elle décrit les liens Document/Entités (utilisée uniquement pour certaines actions). Le lien avec la liste WfGEDEnt est réalisé par un champ clé (type caractère).
Plusieurs actions peuvent être créées avant d’être enregistrées, chaque action faisant l’objet d’un traitement indépendant de mise à jour (exemple : action de création d’un document, action de rattachement).
Référencer un document (avec import si nécessaire)
Référencement : rendre visible et identifiable de manière unique un document dans DIAPASON.
En fonction du type de stockage renseigné sur la catégorie, le référencement entraînera l’import du document sur le serveur de stockage.
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDSoc | C | Société du document | Prise en compte si non vide, sinon société courante | |
GEDIde | C | Identifiant généré Document | Retourne la référence document créé | |
GEDAct | C | Action sur Document | O | Doit contenir REF |
GEDNor | N | Numéro d’ordre de l’action | Numéro d’ordre de prise en compte de l’action | |
GEDCat | C | Catégorie document | O | Obligatoire et valeur valide. |
GEDCleV | C | Clé versionning du document | Pris en compte si non vide, sinon générée automatiquement. | |
GEDAdr | C | Adresse physique du document | Retourne l’adresse physique du document | |
GEDFicOri | C | Nom Document Origine | O | Nom Document Origine |
GEDFic | C | Nom document | Retourne Nom généré du document | |
GEDIdeEnf | C | Liste des identifiants de documents liés | Pris en compte si non vide et valeur valide. | |
GEDDes | C | Descriptif document | Pris en compte si non vide | |
GEDVer | N | Numéro de version automatique | Retoune le numéro de version | |
GEDIcoFct | C | Icône fonctionnelle | Pris en compte si non vide et valeur valide. | |
GEDMotcle | C | Mots clé indexés | Pris en compte si non vide. | |
GEDCleFct | C | Clé fonctionnelle | Pris en compte si non vide. | |
GEDCleTri1 | C | Clé tri 1 | Pris en compte si non vide. | |
GEDCleTri2 | C | Clé tri 2 | Pris en compte si non vide. | |
GEDCleTri3 | C | Clé tri 3 | Pris en compte si non vide. | |
GEDCleTri4 | C | Clé tri 4 | Pris en compte si non vide. | |
GEDCleTri5 | C | Clé tri 5 | Pris en compte si non vide. | |
GEDRes | C | Retourne le code erreur |
Lors du référencement d’un document, si un document de même catégorie et même clé versionning est déjà référencé alors :
Si le versioning n’est pas géré pour la catégorie de document, le document existant est remplacé par le nouveau
Sinon le document existant est archivé et le nouveau document est référencé avec la même clé de versionning et un numéro de version incrémenté de 1.
Le versioning d’un document n’est possible que si le stockage du document est géré par DIAPASON.
Possibilité de rattacher le document lors du référencement :
La liste WfGEDLien doit être initialisée de la manière suivante :
WfGEDLien T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire. Lien avec WfGEDEnt |
GEDEnt | C | Entité de rattachement | O | Obligatoire et valeur valide. |
GEDCl1 | C | Clé de rattachement | O | Obligatoire et valeur valide. |
GEDCl2 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. | |
GEDCl3 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. |
Rattacher un document
Les documents peuvent être rattachés soit à :
une ou plusieurs occurrences d’entité DIAPASON
à une ou n occurrences d’entité spécifique
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDIde | C | Identifiant généré Document | O | Renseignée pour indentifier le document si GEDCleV et GEDVer non renseignées |
GEDAct | C | Action sur Document | O | Doit contenir RAT |
GEDCleV | C | Clé versionning du document | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDVer | N | Numéro de version automatique | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDRes | C | Retourne le code erreur |
La liste WfGEDLien doit être initialisée de la manière suivante :
WfGEDLien T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire. Lien avec WfGEDEnt |
GEDEnt | C | Entité de rattachement | O | Obligatoire et valeur valide. |
GEDCl1 | C | Clé de rattachement | O | Obligatoire et valeur valide. |
GEDCl2 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. | |
GEDCl3 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. |
Supprimer un document
Supprimer le référencement du document (suppression logique).
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDIde | C | Identifiant généré Document | O | Renseignée pour indentifier le document si GEDCleV et GEDVer non renseignées |
GEDAct | C | Action sur Document | O | Doit contenir SUP |
GEDVer | C | Version document | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDCleV | C | Clé versionning du document | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDRes | C | Retourne le code erreur |
Il faut obligatoirement renseigner soit l’identifiant unique du document, soit la clé versionning et la version du document.
Modifier un document
Modifier les caractéristiques d’un document.
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDIde | C | Identifiant généré Document | O | Obigatoire pour identifier le document. Non modifiable. |
GEDAct | C | Action sur Document | O | Doit contenir MOD |
GEDCat | C | Catégorie document | Pris en compte si non vide et valeur valide. | |
GEDCleV | C | Clé versionning du document | O | Obigatoire pour identifier le document document si GEDIde non renseigné sinon modifiable. |
GEDAdr | C | Adresse physique du document | Pris en compte si non vide. | |
GEDFic | C | Nom document | Pris en compte si non vide. | |
GEDIdeEnf | C | Liste des identifiants de documents liés | Pris en compte si non vide et valeur valide. | |
GEDDesc | C | Descriptif document | Pris en compte si non vide. | |
GEDVer | N | Numéro de version automatique | O | Obigatoire pour identifier le document si GEDIde non renseigné. Non modifiable. |
GEDIcoFct | C | Icône fonctionnelle | Pris en compte si non vide et valeur valide. | |
GEDMotcle | C | Mots clé indexés | Pris en compte si non vide. | |
GEDCleFct | C | Clé fonctionnelle | Pris en compte si non vide. | |
GEDCleTri1 | C | Clé tri 1 | Pris en compte si non vide. | |
GEDCleTri2 | C | Clé tri 2 | Pris en compte si non vide. | |
GEDCleTri3 | C | Clé tri 3 | Pris en compte si non vide. | |
GEDCleTri4 | C | Clé tri 4 | Pris en compte si non vide. | |
GEDCleTri5 | C | Clé tri 5 | Pris en compte si non vide. | |
GEDRes | C | Retourne le code erreur |
Il faut obligatoirement renseigner soit l’identifiant unique du document, soit la clé versionning et la version du document.
Quelques règles lors de la modification de certaines caractéristiques d’un document :
Catégorie : attention si l’on passe d’une version qui gère le versioning à une version qui ne gère plus le versioning et que la version du document est différente de 0 :
Version = 0
Suppression physique et en base des versions précédentes du document.
Clé Versioning :
Si clé versionning existe déjà avec la même catégorie :
le document devient le document référent pour cette clé versionning (niveau de version le plus haut)
Si clé versionning existe déjà avec une catégorie différente :
Message d’erreur
Caractéristiques d’un document
Renvoie les caractéristiques du document dans WfGEDEnt.
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDIde | C | Identifiant généré Document | O | Renseignée pour indentifier le document si GEDCleV et GEDVer non renseignées, sinon renvoyée |
GEDAct | C | Action sur Document | O | Doit contenir CAR |
GEDCat | C | Catégorie document | ||
GEDCleV | C | Clé versionning du document | O | Renseignée pour indentifier le document si GEDIde non renseigné, sinon renvoyée |
GEDAdr | C | Adresse physique du document | ||
GEDFic | C | Nom document | ||
GEDIdeEnf | C | Liste des identifiants de documents liés | Pris en compte si non vide et valeur valide. | |
GEDDesc | C | Descriptif document | ||
GEDVer | N | Numéro de version automatique | O | Renseignée pour indentifier le document si GEDIde non renseigné, sinon renvoyée |
GEDIcoFct | C | Icône fonctionnelle | ||
GEDMotcle | C | Mots clé indexés | ||
GEDCleFct | C | Clé fonctionnelle | ||
GEDCleTri1 | C | Clé tri 1 | ||
GEDCleTri2 | C | Clé tri 2 | ||
GEDCleTri3 | C | Clé tri 3 | ||
GEDCleTri4 | C | Clé tri 4 | ||
GEDCleTri5 | C | Clé tri 5 | ||
GEDRes | C | Retourne le code erreur |
Il faut obligatoirement renseigner soit l’identifiant unique du document, soit la clé versionning et la version du document. Les caractéristiques seront renvoyées dans les champs correspondants de la liste.
Supprimer un LIEN
Supprimer un ou n liens document-entités.
La liste WfGEDEnt doit être initialisée de la manière suivante :
WfGEDEnt T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire |
GEDIde | C | Identifiant généré Document | O | Renseignée pour indentifier le document si GEDCleV et GEDVer non renseignées |
GEDAct | C | Action sur Document | O | Doit contenir SUP-LIEN |
GEDCleV | C | Clé versionning du document | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDVer | N | Numéro de version automatique | O | Renseignée pour indentifier le document si GEDIde non renseignée |
GEDRes | C | Retourne le code erreur |
La liste WfGEDLien doit être initialisée de la manière suivante :
WfGEDLien T : type de la variable; O : indique si obligatoire (valeur o ou non)
Nom | T | Désignation | O | Commentaire |
GEDCle | C | Cle événement mise à jour | O | Identifiant Action Obligatoire. Lien avec WfGEDEnt. |
GEDEnt | C | Entité de rattachement | O | Obligatoire et valeur valide. |
GEDCl1 | C | Clé de rattachement | O | Obligatoire et valeur valide. |
GEDCl2 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. | |
GEDCl3 | C | Clé de rattachement | Pris en compte si non vide et valeur valide. | |
GEDRes | C | Retourne le code erreur |
Gestion des transactions
Il est possible de piloter l’aspect transactionnel des actions, c’est-à-dire de définir des débuts (avec le code DTR) et fin de transaction (avec le code FTR). La notion de transaction permet de gérer l’intégrité de toutes les mises à jour effectuées entre le début transaction et la fin. Si le mot-clé LC-ERREUR est utilisé pendant une transaction, toutes les mises à jour effectuées entre le début et la fin de transaction sont annulées.
La gestion du numéro d’ordre dans la liste WfGEDEnt est importante pour traiter les actions souhaitées entre le début et la fin de transaction.