Fichiers et accès disques
Cette catégorie contient toutes les actions disponibles sur les fichiers en input et en output. Il est possible de
Copier un fichier local
Cette action permet de copier un fichier source vers une destination définie. Cette action est uniquement disponible dans un environement packagé qui rend disponible le système de fichier de la machine. Elle n’est donc pas disponible en web.
<action type="copy_file" sourcePath="C:\some_file.txt" destPath="C:\some_other_file.txt"></action>
Dans cet exemple, l’action copie le fichier C:\some_file.txt vers C:\some_other_file.txt
sourcePath : string
Le chemin vers le fichier source à copier. Ce chemin doit exister sur le disque.
destPath : string
Le chemin vers le fichier destination. Ce fichier n’est pas obligé d’exister sur le disque. Si il existe déjà, il sera écrasé
Il n’y a pas d’output particulier dans le contexte pour cet action
Télécharger depuis le serveur
L’action download_file permet de télécharger un fichier depuis le serveur. Le fichier doit être présent dans l’un des emplacements gérés par les protocoles de document sur SAINET
<action type="download_file" fileId="edms://0213.zip" localFileId="C:\file.zip" metadata="dummy" open="false">
<key>
<datafield datafieldId="CRMPRJ.ID_PK">15-00091</datafield>
</key>
</action>
Cette action va downloader le fichier 0213.zip dans la ged et l’enregistrer sur la machine de l’utilisateur comme C:\file.zip. L’appel au serveur reçoit comme indication que le record ciblé est dans la table crmprj et a pour identifiant 15-00091. le serveur reçoit également comme paramètre supplémentaire dummy en tant que metadata.
Si le téléchargement réussit, l’action n’ouvrira pas automatiquement le fichier avec l’action windows par default, car l’attribut open est à false.
fileId : string
L’id du fichier permettant au serveur de le localiser. Contient le protocole sauf si le downloadfile a été overridé sur le serveur, auquel cas c’est au business developper de définir le format.
localFileId : string
Le path vers le fichier de destination en local. Si ce path existe déja, le fichier local existant sera écrasé par la nouvelle version.
metadata : string
Dans le cas de traitement particulier, des données supplémentaires peuvent être fournies au serveur. Cet attribut contient une ligne de texte custom qui doit être interprétable par le business developper. Le format à fournir est défini au cas par cas.
open : boolean
Cet attribut définit si le fichier téléchargé doit être immédiatement ouvert par le système d’exploitation. Dans le cas d’un environnement web non packagé, cet attribut n’est pas pris en compte.
key : node xml
Ce noeud xml représente une clé d’un record dans la base suivant la structure standard d’une clé dans le framework SAINET (detail)
downloaded_file_path : string
Le chemin absolu vers le fichier téléchargé. Ce chemin peut être directement réinjecté dans des actions demandant un path comme input
Définir la date de dernière modification
Cette action récupère la date de dernière modification du fichier ciblé.
<action type="get_file_last_modification" filePath="C:\my_directory\myfile.txt" ></action>
Dans cet exemple, l’action récupère la date de dernière modification du fichier C:\my_directory\myfile.txt
filePath : string
Le fichier ciblé
file_last_modification : date
Contient la date de dernière modification du fichier en format date SAINET
Ouvrir un fichier local
Dans le cas d’une application packagée ou sur le client riche SAINETV4, cette action ouvre le fichier specifié avec le programme par defaut du système. Dans le cas d’une version web non packagée, cette action ne peut pas fonctionner car le système ne donne pas les droits au browser d’ouvrir automatiquement.
<action type="open_file" filePath="C:\some_file.txt" ></action>
Le système essayera d’ouvrir C:\some_file.txt avec le programme par default.
filePath : string
Le chemin vers le fichier à ouvrir
Aucun output inséré dans le contexte suite à cette action
Scanner
Cette action est disponible uniquement sur le client riche SAINETV4. Elle ouvre le panneau permettant de scanner un document et de le traiter. Si l’utilisateur valide son document scannée, la procédure continue avec dans le contexte le chemin vers le fichier scanné. Si l’utilisateur annule l’action, tout la procédure se termine immédiatement.
<action type="scan_file" tmpScanFilePath="C:\some_file.jpg" ></action>
Dans cet exemple, l’utilisateur scannera son document qui sera enregistré en tant que C:\some_file.jpg
tmpScanFilePath : string
Le chemin vers le fichier temporaire sur le disque qui contiendra le resultat du scan
Cette action n’a pas d’output. En effet, comme le fichier d’output est donné en input, il n’est pas nécéssaire de répéter dans le contexte une information qui est déja disponible pour le developpeur.
Selectionner un fichier local
Cette action ouvre une fenetre native de choix de fichier. Il est possible de préciser le format du fichier attendu. Dans le cas d’une réussite, le chemin vers le fichier selectionné est disponible. Dans le cas ou l’utilisateur annule et ne selectionne aucun fichier, le processus complet d’actions est annulé.
<action type="select_file" baseDir="C:\my_directory" fileFilter="All Files |*.*" ></action>
Dans cet exemple l’utilisateur peut selectionner n’importe quel fichier du disque. Sur le client riche SAINETV4, l’utilisateur commencera la selection dans le dossier C:\my_directory
baseDir : string
Le repertoire de base dans lequel l’utilisateur se trouve lorsque le fenêtre de selection s’ouvre. Cet attribut n’est pas disponible dans le cas d’un browser web car celui çi se basera la plupart du temps automatiquement sur le dernier emplacement visité sur le disque par l’utilisateur.
fileFilter : string Le filtre de fichier format standard windows à appliquer. Il permet de limiter le type de
fichier que l’utilisateur peut selectionner. Par exemple “Fichiers JPG | *.jpg”
selected_file_path : string
Le chemin vers le fichier selectionné. Il peut être ensuite réutilisé par exemple dans l’action d’upload de fichier
Définir la date de dernière modification
Cette action force la date de dernière modification du fichier ciblé. Cette action n’est disponible que dans un système packagé ou le système de fichier est disponible. Elle ne fait rien sinon.
<action type="set_file_last_modification" filePath="C:\my_directory\myfile.txt" fileDate="2016-05-05 10:24" ></action>
Dans cet exemple, le fichier C:\my_directory\myfile.txt aura comme date de modification 2016-05-05 10:24
filePath : string
Le fichier à modifier
fileDate : date
la nouvelle date au format date SAINET qui doit être la nouvelle date de dernière modification du fichier. Il n’est pas autorisé de mettre une date dans le futur
Cette action n’a pas d’output dans le contexte.
Uploader vers le serveur
Cette action va uploader un fichier sur le serveur à partir d’un fichier local défini généralement par l’utilisateur. Le document sera mis en GED. Cette action appelle la fonction uploadFile sur le serveur qui peut être overridée par le developeur.
<action type="upload_file" filePath="C:\some_file.txt" fileMetadata="some data" ></action>
Dans cet exemple, le système va uploader le fichier C:\some_file.txt vers le serveur en lui fournissant la chaine de charactères some data en plus.
filePath : string
Le chemin vers le fichier local à uploader. Il est possible d’utiliser des variables venant du contexte.
fileMetadata : string
Une chaine de caractère qui sera transmise avec l’appel au serveur. Par exemple, il est possible de transmettre des informations sur des records de la base qui serviront au developeur qui attachera le document en note sur ces records par le biais d’un override spécifique du code sur le serveur.
Pas d’output dans le contexte pour cette action