Askui

Syntaxe

   Askui retour = "" with action, liste_param

 

Paramètres

Elément	Description	Restrictions
retour	retour d'information sous forme d'une chaîne de caractères
action	code action : chaîne de caractères sous la forme : "UIAsk="+chr$(1)+"valeur_action"
liste_param	Liste de id_param séparés par le caractère ','.	Les expressions doivent être alphanumériques et sont limitées à 255.
id_param	paramètre : chaîne de caractères sous la forme : "cd_param="+chr$(1)+"valeur_param"	Les expressions doivent être alphanumériques et sont limitées à 255.

 

Exemples

# Exemple 1 : copier un fichier excel
# du poste client vers le dossier TMP du serveur
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR(250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskPutFile",
& "UIRemotePath="+ chr$(1) + "TMP",
& "UILocalFileExts="+ chr$(1) + "xls",
& "UILocalPath="+chr$(1) + "#myDocuments"

# Exemple 2 : désigner un fichier word
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR (250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskSelFile",
& "UILocalFileExts="+ chr$(1) + "doc",
& "UILocalPath="+chr$(1) + "#myDocuments"

# Exemple 3 : lire un fichier texte du poste client   
# l'opérateur saisira ou sélectionnera les informations complémentaires (nom fichier, répertoire)
Local Clbfile RETOUR(10)
Setlob RETOUR With ""
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskReadTextFile",
& "UILocalFileExts="+ chr$(1) + "txt"

# Exemple 4 : lancer une commande shell sur le poste client   
Local Clbfile RETOUR(10)
Setlob RETOUR With ""
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskExecShell",
& "UILocalShell="+ chr$(1) + "AdxOfficemodule.hta -cmd xlsinsert -input 'TMP/data.csv'"

# Exemple 5 : copier un fichier "200406.etebac" 
# du dossier BANQ du dossier courant du serveur vers le poste client 
# pré-positionner le dossier courant de la fenêtre de sélection de fichier
# par le dossier "mes documents" du poste client   
Local char RETOUR(250)
Askui RETOUR="" With "UIAsk="+chr$(1) + "AskGetFile",
& "UIRemotePath="+ chr$(1) + "BANQ,200406,etebac",
& "UIRemoteBinary="+ chr$(1) + "0",
& "UILocalFileName="+ chr$(1) + "200406.etebac",
& "UILocalPathFile="+chr$(1) + "#myDocuments"

Description

Askui permet de piloter le client. Le client reçoit (via le moteur) l'ordre d'exécuter un Askui. Il interprète les paramètres associés, et il prend en charge le transfert ou l'ouverture du fichier.

Askui permet de lancer l'une des actions suivantes :

• transférer un fichier du poste client  vers le serveur
• transférer un fichier du serveur vers le poste client
• sélectionner un fichier sur le poste client
• lire le contenu d'un fichier texte sur le poste client
• lancer une commande shell sur le poste client

Une seule action peut être précisée à la fois.

En retour,  nous avons un code nous précisant que l'action s'est bien déroulée ou pas. En cas de transfert ou de sélection de fichier, on aura en retour, le nom et chemin du fichier de destination. En cas de lecture d'un fichier texte, on aura en retour, un clob avec le contenu du fichier texte. En cas de lancement d'une commande shell, on aura en retour, un clob contenant la sortie standard du processus (stdout) et la sorite des erreurs ( stderr). 

 

action :

Ce paramètre permet d'identifier l'action à lancer sur le client.

Les actions disponibles sont les suivantes :

Action	Description
AskPutFile	Transfère un fichier du poste client vers le serveur. Un fenêtre de sélection s'ouvre pour préciser le fichier du poste client à transférer.
AskGetFile	Transfère un fichier du serveur vers le poste client.  en demandant à l'utilisateur de Un fenêtre de sélection s'ouvre pour préciser le nom du fichier à écrire sur le poste client ainsi que le répertoire.
AskSelFile	Sélection d'un fichier du poste client
AskReadTextFile	Lecture d'un fichier texte sur le poste client
AskExecShell	Lancement d'une commande Shell sur le poste client et retourne, dans une chaîne d'au plus 250 caractères, le stdout et le stderr

 

id_param

Les paramètres disponibles par action sont les suivants :

Action	Paramètres	Oblig.
AskPutFile	UILocalFileName		Nom et extension du fichier sur le poste client
	UILocalFileExts		Extension(s) pour filtrer les fichiers à afficher
	UILocalPath		Répertoire sur le poste client
	UIRemoteFileName		Nom du fichier sur le serveur
	UIRemotePath	oui	Répertoire sur le serveur
	UIRemoteOverWrite		Flag autorisant la réécriture du fichier sur le serveur
AskGetFile	UIRemotePathFile	oui	Répertoire et Nom du fichier sur le serveur
	UIRemoteBinary		Flag indiquant que le contenu du fichier est binaire
	UILocalFileName		Nom du fichier sur le poste client
	UILocalPath		Répertoire sur le poste client
AskSelFile AskReadTextFile	UILocalFileName		Nom et extension du fichier sur le poste client.
	UILocalFileExts		Liste des extensions acceptées. (exclusif avec UILocalFileName)
	UILocalPath		Répertoire sur le poste client
AskExecShell	UILocalShell

 

 

 

 

Explication de chaque paramètre : 

Paramètres	Description
UILocalFileName	Paramètre optionnel  Nom et extension du fichier à lire pour désigner explicitement le fichier sur le client Ce nom sert à pré-charger la fenêtre de sélection sur ce fichier. L'utilisateur est libre de choisir un autre fichier.
UILocalFileExts	Paramètre optionnel Liste des extensions acceptées séparées par le caractère";" Permet d'effectuer un filtre des fichiers à afficher dans la fenêtre de sélection Ce paramètre est pris en compte, si le paramètre UILocalFileName n'est pas renseigné.
UILocalPath	Paramètre optionnel Chemin complet ou partiel du dossier ou le fichier sur le client. Ce chemin sert à pré-positionner la fenêtre de sélection dans un dossier. L’utilisateur est libre de se déplacer. Ce chemin est exprimé soit explicitement, soit en faisant référence à une variable d’environnement, soit en faisant référence à un identifiant d’un des dossiers standards (Special Folders) du poste client. ·          « TMP » désigne le sous-dossier « TMP » du dossier d’installation ·         « D:\temp\Adonix » désigne un dossier du disque D du poste ·         « $HOMEPATH » désigne le dossier dont le chemin est contenu dans la variable d’environnement HOMEPATH ·         « #myDocuments » désigne le dossier « mes document »
UIRemoteFileName	Paramètre optionnel  Nom et extension du fichier à écrire sur le serveur. Si ce paramètre est absent, on écrit sur le serveur un fichier de même nom que celui du client.
UIRemotePath	Chemin complet ou partiel du dossier sur le serveur ou doit être stocké le fichier. Accepte la forme canonique Adonix :  « répertoire, nom_fic, extens [, appli [, vol [ , mach ] ] ] » · « TMP » désigne le sous-dossier « TMP » du dossier adonix courant · « /var/adonix/import » désigne un dossier existant dans le filesystem d’un serveur unix · « c:\temp\import » désigne un dossier existant dans le filesystem d’un serveur Windows · « \\groupserver\pub\impot » désigne un dossier existant  dans un volume partagé d’un serveur Windows « TMP,,, X3 » forme canonique du sous dossier TMP du dossier Adonix X3
UIRemoteOverWrite	Paramètre optionnel yes/no, 0/1 Indicateur permettant d’autoriser ou non l’écrasement du fichier sur le serveur.
UIRemotePathFile	Chemin complet ou partiel du fichier à transférer :  · « TMP/toto.txt » désigne le fichier « toto.txt » présent dans le sous-dossier "TMP" du dossier Adonix courant. · « /var/adonix/export/zzz.csv » désigne le fichier "zzz.csv" présent dans le dossier "/var/adonix/export/" du filesystem d’un serveur unix . « répertoire, nom_fic, extens [, appli [, vol [ , mach ] ] ] » forme canonique Adonix désignant le fichier "nom_fic.extens" dans le sous-répertoire "répertoire" du dossier courant.
UIRemoteBinary	Paramètre optionnel yes/no, 0/1 Indique que le contenu du fichier est binaire.  le client windows ne tient pas compte de cet argument.
UILocalshell	La commande à lancer

Identifiants possibles de dossiers standards (Special Folders) du poste client : 

#AllUsersDesktop : 
The file system directory that contains files and folders that appear on the desktop for all users. 
A typical path is C:\Documents and Settings\All Users\Desktop.

#AllUsersStartMenu : 
The file system directory that contains the programs and folders that appear on the Start menu for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu.

#AllUsersPrograms : 
The file system directory that contains the directories for the common program groups that appear on the Start menu for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu\Programs.

#AllUsersStartup : 
The file system directory that contains the programs that appear in the Startup folder for all users. 
A typical path is C:\Documents and Settings\All Users\Start Menu\Programs\Startup.

#Desktop : 
The file system directory used to physically store file OBJects on the desktop (not to be confused with the desktop folder itself). 
A typical path is C:\Documents and Settings\username\Desktop.

#Favorites :
The file system directory that serves as a common repository for the user's favorite items. 
A typical path is C:\Documents and Settings\username\Favorites.

#Fonts : 
A virtual folder containing fonts. 
A typical path is C:\Windows\Fonts.

#MyDocuments : 
The file system directory used to physically store a user's common repository of documents. 
A typical path is C:\Documents and Settings\username\My Documents.

#NetHood : 
A file system directory containing the link OBJects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. 
A typical path is C:\Documents and Settings\username\NetHood.

#PrintHood : 
The file system directory that contains the link OBJects that can exist in the Printers virtual folder. 
A typical path is C:\Documents and Settings\username\PrintHood.

#Programs : 
The file system directory that contains the user's program groups (which are themselves file system directories). 
A typical path is C:\Documents and Settings\username\Start Menu\Programs.

#Recent : 
The file system directory that contains shortcuts to the user's most recently used documents. 
A typical path is C:\Documents and Settings\username\My Recent Documents.

#SendTo : 
The file system directory that contains Send To menu items. 
A typical path is C:\Documents and Settings\username\SendTo.

#StartMenu :
 The file system directory containing Start menu items. 
A typical path is C:\Documents and Settings\username\Start Menu.

#Startup : 
The file system directory that corresponds to the user's Startup program group. The system starts these programs whenever any user logs onto Windows NT or starts Windows 95. 
A typical path is C:\Documents and Settings\username\Start Menu\Programs\Startup.

#Template : 
The file system directory that serves as a common repository for document templates. 
A typical path is C:\Documents and Settings\username\Templates. 

 

retour :

Ce paramètre permet d'identifier la variable qui contiendra les informations de retour de l'instruction.

En retour, l'instruction nous envoie les informations suivantes :

Action	Valeur	Signification
AskPutFile	0	Aucun transfert
	1,répertoire,nom_fic,extens[,appli]	un fichier a été transféré + nom du fichier transféré sur le serveur sous la forme canonique ( cf. Filpath )
	-1	erreur inattendue
	-91	le répertoire indiqué est inexistant
	-92	l'accès au répertoire indiqué n'est pas autorisé
	-93	le fichier désigné existe déjà;opération interdite
	-94	le fichier indiqué est inexistant
	-99	demande de service non supportée
AskGetFile	0	Aucun transfert
	1,chemin local du fichier écrit	un fichier a été transféré + nom du fichier transféré sur le client sous la forme canonique ( cf. Filpath )
	-1	erreur pendant le transfert ou sur l'écriture du fichier sur le poste client
	-91	le répertoire indiqué est inexistant
	-92	l'accès au répertoire indiqué n'est pas autorisé
	-94	le fichier indiqué est inexistant
	-99	demande de service non supportée
AskSelFile
	0	Aucun fichier sélectionné
	1,chemin du fichier désigné	1 fichier a été sélectionné + nom du fichier sélectionné sur le client sous la forme canonique ( cf. Filpath )
	-99	demande de service non supportée
AskReadTextFile
	texte	Texte UTF-8 contenu dans le fichier sélectionné
	-99	demande de service non supportée
AskExecShell
	texte	le stdout et le stderr en UTF-8
	-99	demande de service non supportée

 

Evolutions

C'est une nouvelle instruction.

 

Erreurs associées

Erreur	Description

 

Mots-clés associés

  GETUI - CALLUI