ONYX - 9.0 - Utilisation - Connecteur OnBase
Différence entre versions
(→Préparation de l’export : Le fichier modèle) (Balise : Éditeur visuel) |
|||
(9 révisions intermédiaires par le même utilisateur non affichées) | |||
Ligne 1 : | Ligne 1 : | ||
− | ===Prérequis et | + | ===Prérequis et concept=== |
Cette partie décrit les procédures de paramétrage et d’utilisation du connecteur OnBase.Le fonctionnement de ce connecteur est assuré avec DESIGNER et ONYX Server.Le principe du connecteur OnBase est de produire des flux PDF et CSV en fonction des informations demandées par l’utilisateur, à destination de l’outil de GED édité par Hyland. Les informations exportées sont basées sur les métadonnées positionnées dans le modèle DESIGNER. | Cette partie décrit les procédures de paramétrage et d’utilisation du connecteur OnBase.Le fonctionnement de ce connecteur est assuré avec DESIGNER et ONYX Server.Le principe du connecteur OnBase est de produire des flux PDF et CSV en fonction des informations demandées par l’utilisateur, à destination de l’outil de GED édité par Hyland. Les informations exportées sont basées sur les métadonnées positionnées dans le modèle DESIGNER. | ||
Ligne 16 : | Ligne 16 : | ||
Le séparateur de colonnes dans le fichier modèle doit correspondre au séparateur configuré dans OnBase.ONYX Server génèrera le fichier PDF et le fichier CSV dans un même répertoire. C’est pourquoi seul le nom du fichier PDF (sans le chemin) apparaît dans le fichier CSV. | Le séparateur de colonnes dans le fichier modèle doit correspondre au séparateur configuré dans OnBase.ONYX Server génèrera le fichier PDF et le fichier CSV dans un même répertoire. C’est pourquoi seul le nom du fichier PDF (sans le chemin) apparaît dans le fichier CSV. | ||
− | + | ||
+ | |||
[[Fichier:OX S Utilisation fileCnnc.png|centré|sans_cadre|848x848px]] | [[Fichier:OX S Utilisation fileCnnc.png|centré|sans_cadre|848x848px]] | ||
− | Figure 1 Contenu d'un fichier modèle | + | |
− | Plusieurs fichiers XML patrons peuvent être nécessaires pour des appels dynamiques en fonction des types de documents à archiver. Ils devront être stockés localement dans un dossier du serveur hébergeant la solution | + | Figure 1 Contenu d'un fichier modèle : |
+ | |||
+ | Plusieurs fichiers XML patrons peuvent être nécessaires pour des appels dynamiques en fonction des types de documents à archiver. Ils devront être stockés localement dans un dossier du serveur hébergeant la solution MONYX Server. La variable d’environnement <code>PATH_DOC_CLASS</code> permet de renseigner le chemin du dossier local. Sur les plateformes Windows et Linux, cette variable peut être renseignée dans le Menu d’Administration/Gestion de la configuration : | ||
+ | |||
+ | <br /> | ||
+ | [[Fichier:OX S Utilisation VARIABLE configOnBase.png|centré|sans_cadre|854x854px]] | ||
+ | <br /> | ||
===Mise en œuvre en ligne de commande=== | ===Mise en œuvre en ligne de commande=== | ||
+ | L’export de fichiers PDF se fait suite à une conversion au format PDF grâce à la commande MAP_XPS. Plusieurs conditions sont nécessaires pour déclencher la génération du fichier CSV attaché au fichier converti. | ||
+ | |||
+ | 1. Renseigner le format d’export dans la configuration du serveur. Pour cela, créer la variable d’environnement <code>DMS_PROVIDER</code> et lui donner la valeur « OnBase ». | ||
+ | |||
+ | 2. Préciser le fichier modèle pour l’export : paramètre exporttemplate sur la ligne de commande. | ||
+ | |||
+ | 3. Préciser le nom du fichier CSV résultant de l’export : paramètre indexfile sur la ligne de commande. | ||
+ | |||
+ | |||
+ | Exemple : <code>map_xps.exe infile:C:\Temp\in.xps outfile:C:\Temp\out.pdf toPDF indexfile:C:\temp\out.csv exporttemplate:bill_template.csv</code> | ||
+ | |||
+ | La ligne de commande en exemple exporte les critères placés dans le document infile dans le fichier indexfile d’après le fichier modèle construit avec <code>PATH_DOC_CLASS</code> et exporttemplate. | ||
===Mise en œuvre dans les Workflows=== | ===Mise en œuvre dans les Workflows=== | ||
+ | |||
+ | L’appel au connecteur OnBase est placé dans la section ‘XPS to Web Format’ : | ||
+ | |||
+ | [[Fichier:OX S OnBase WRKFLOW.png|centré|sans_cadre|952x952px]] | ||
+ | |||
+ | |||
+ | Les paramètres présentés dans la ligne de commande sont repris dans cette boite. Les variables <code>PATH_DOC_TEMP</code> et <code>DMS_PROVIDER</code> sont toujours à renseigner dans l’environnement. |
Version actuelle datée du 29 avril 2019 à 07:24
Sommaire
Prérequis et concept
Cette partie décrit les procédures de paramétrage et d’utilisation du connecteur OnBase.Le fonctionnement de ce connecteur est assuré avec DESIGNER et ONYX Server.Le principe du connecteur OnBase est de produire des flux PDF et CSV en fonction des informations demandées par l’utilisateur, à destination de l’outil de GED édité par Hyland. Les informations exportées sont basées sur les métadonnées positionnées dans le modèle DESIGNER.
- Le PDF généré est à la norme PDF/A.
- Le flux XML au format OnBase s’appuie sur un fichier modèle (ou patron) renseigné lors de l’appel de la commande d’export.
Ce guide détaille les étapes et éléments nécessaires à la production de documents vers l’outil de GED OnBase : l’apport des fichiers CSV modèles et la définition de variables spécifiques de l’environnement d’exécution.
Ce guide s’adresse à un public maîtrisant la conception de modèles de documents avec DESIGNER, et la conversion de documents via la commande map_xps.
Préparation de l’export : Le fichier modèle
L’export de document vers la solution de GED OnBase s’effectue au format CSV, à partir d’un fichier modèle défini par l’utilisateur. Ce fichier contient :
- (1) Les métadonnées : le nom des index positionnés dans la maquette M-Designer, dans l’ordre attendu par OnBase
- (2) Le nom du fichier à exporter au format PDF
Le séparateur de colonnes dans le fichier modèle doit correspondre au séparateur configuré dans OnBase.ONYX Server génèrera le fichier PDF et le fichier CSV dans un même répertoire. C’est pourquoi seul le nom du fichier PDF (sans le chemin) apparaît dans le fichier CSV.
Figure 1 Contenu d'un fichier modèle :
Plusieurs fichiers XML patrons peuvent être nécessaires pour des appels dynamiques en fonction des types de documents à archiver. Ils devront être stockés localement dans un dossier du serveur hébergeant la solution MONYX Server. La variable d’environnement PATH_DOC_CLASS
permet de renseigner le chemin du dossier local. Sur les plateformes Windows et Linux, cette variable peut être renseignée dans le Menu d’Administration/Gestion de la configuration :
Mise en œuvre en ligne de commande
L’export de fichiers PDF se fait suite à une conversion au format PDF grâce à la commande MAP_XPS. Plusieurs conditions sont nécessaires pour déclencher la génération du fichier CSV attaché au fichier converti.
1. Renseigner le format d’export dans la configuration du serveur. Pour cela, créer la variable d’environnement DMS_PROVIDER
et lui donner la valeur « OnBase ».
2. Préciser le fichier modèle pour l’export : paramètre exporttemplate sur la ligne de commande.
3. Préciser le nom du fichier CSV résultant de l’export : paramètre indexfile sur la ligne de commande.
Exemple : map_xps.exe infile:C:\Temp\in.xps outfile:C:\Temp\out.pdf toPDF indexfile:C:\temp\out.csv exporttemplate:bill_template.csv
La ligne de commande en exemple exporte les critères placés dans le document infile dans le fichier indexfile d’après le fichier modèle construit avec PATH_DOC_CLASS
et exporttemplate.
Mise en œuvre dans les Workflows
L’appel au connecteur OnBase est placé dans la section ‘XPS to Web Format’ :
Les paramètres présentés dans la ligne de commande sont repris dans cette boite. Les variables PATH_DOC_TEMP
et DMS_PROVIDER
sont toujours à renseigner dans l’environnement.