WEBVUE

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Gère la connexion aux clients WebVue.

Support WebVue - Oui.

Mode

Mnémonique

Syntaxe
1 LIST 1, 6
4 CONNECTURL 2
6 USERNAME 3
7 WEBVUE_CONTEXT 5
8 MULTIMEDIA 4
9 CONTEXT 3
10 HYPERLINK 7

A partir de la version 12 du logiciel PcVue, les modes suivants ne sont plus supportés car ils ne sont plus applicables :

  • SETWINDOW - Sélectionnait la fenêtre de démarrage d'un client Web.

  • RESTOREWINDOW - Restaurait le synoptique de démarrage à partir de la configuration du profil.

  • RESTOREURL - Permettait de fournir le nom d'utilisateur pour la connexion à une Url.

Ces modes ont été conçus à l'origine pour l'intégration de l'applet WebVue au sein de portails web tiers. Une telle intégration se réalise désormais différemment avec l'API REST.

Les modes suivants sont obsolètes, et des instructions de remplacement sont disponibles. Ils sont toujours supportés en exécution pour compatibilité mais seront supprimés dans une version ultérieure :

  • CONNECTURL - Redéfinit l'url de démarrage d'un client web.
    Il est remplacé par l'instruction WEBVUE("HYPERLINK").

  • USERNAME - Récupère le nom de l'utilisateur du client Web.
    Il est remplacé par l'instruction SYSTEM("USER").

  • WEBVUE_CONTEXT - Renvoie le contexte dans lequel le programme a été exécuté.
    Il est remplacé par l'instruction SESSION("GETTYPE").

  • CONTEXT - Renvoie le nom de la variable contextuelle lorsque le programme est lancé à partir d'une fenêtre contextuelle.
    Il est remplacé par la variable système @SYSTEM.CONTEXT.NAME.

Syntaxe 1

IntVal = WEBVUE(Mode, Handle);

Type de retour : INTEGER.

Argument

Définition

Handle

Contient la liste de couples (poste, utilisateur) des clients web connectés. Type LONG.

Le format de la liste est :

Username1,,

Username2,,

...

Le second champs était utilisé pour inclure des informations du type nom d'hôte et adresse IP du client, adresse du routeur. A partir de la version 12, il est toujours vide.

Exécution

Mode

Mnémonique

Action

1

LIST

Récupère la liste des sessions clients Web.

Retour : Nombre de clients connectés, ou

-1 si l'allocation pour Handle n'est pas assez grande. Voir l'instruction ALLOC_BUFFER.

Syntaxe 2

IntVal = WEBVUE(Mode, UserName, HtmlPage , BitVariableName, Reconnect, NewBrowser);

Type de retour : INTEGER.

Argument

Définition

UserName

Laisser vide (""). Type STR.

HtmlPage

L'Url vers laquelle rediriger le client web lors de la connexion sous la forme "https//...". Type STR.

BitVariableName

Variable état mise à 1 lorsque le routage a été réalisé. Type STR.

Reconnect

Délai de commutation : délai avant que la reconnexion soit tentée de nouveau. Type INTEGER

0: Reconnexion immédiate.
1 : Délai de commutation (en secondes) après inactivité de la souris et du clavier.

NewBrowser

Ouverture d'une nouvelle instance du navigateur ou pas. Type INTEGER.

0 : Nouvel onglet dans la même instance du navigateur web.
1 : Nouvelle instance du navigateur web.

Exécution

Mode

Mnémonique

Action

4

CONNECTURL

Ce mode est obsolète, utilisez WEBVUE("HYPERLINK") à la place. Appliquer les paramètres de connexion.

Retour : 1 si OK, 0 sinon (variable introuvable ou type incorrect).

Si l'Url ne commence pas par le protocole (http:// ou https://), alors elle est considérée comme relative par le navigateur, et le celui-ci redirigera vers la ressource web relative au répertoire virtuel /WebClient sur le serveur Web WebVue.

Syntaxe 3

IntVal = WEBVUE(Mode, WebSession, UserHandle);

Type de retour : INTEGER.

Argument

Définition

WebSession

Type de session Web. Type INTEGER Pour plus de détails, voir l'instruction GETARG mode 29 : WEB.

UserHandle

Handle pour le nom de l'utilisateur du login WEB. Type LONG.

Exécution

Mode

Mnémonique

Action

6

USERNAME

Ce mode est obsolète, veuillez utiliser SYSTEM("USER").

Récupère le nom de l'utilisateur du client Web.

Retour : 0 si OK, sinon :

-1: WebSessionis n'est pas un INTEGER.

-2: WebSession est vide.

-3: UserHandle n'est pas un LONG.

-4 : UserHandle a une taille de 0 (c'est-à-dire qu'aucun tampon n'a été alloué).

-5: UserHandle est vide. Normalement, ceci est impossible.

-6 : La longueur de l'utilisateur est plus grande que la taille allouée par ALLOC_BUFFER.

9 CONTEXT

Ce mode est obsolète, utilisez la variable système @SYSTEM.CONTEXT.NAME à la place. Récupère le nom de la variable contextuelle lorsque le programme est lancé à partir d'une fenêtre contextuelle.

Retour : 1 si OK, sinon 0.

Ces 2 modes retournent une chaîne de caractères vide lorsqu'ils sont lancés à partir du client desktop PcVue. Vous pouvez récupérer la liste des sessions WebVue actives en utilisant le mode 1 (LIST).

Syntaxe 4

IntVal = WEBVUE(Mode, Sub-mode);

Type de retour : INTEGER.

Argument

Définition

Sub-mode

Le sous-mode. Type STR.

BEEP - Joue un fichier audio.

Exécution

Mode

Mnémonique

Action

8

MULTIMEDIA

Joue un fichier multimédia sur le client WebVue.

Retour : 1 si OK, sinon 0.

Le fonctionnement du mode MULTIMEDIA sous-mode BEEP, dépend du contexte d'exécution du programme appelant :

  • Le fichier audio est joué sur tous les clients WebVue connectés si le programme appelant N'EST PAS un contexte web ; par exemple si le programme appelant est exécuté sur le serveur back end web, déclenché par un événement sur une variable à portée Partagée.

  • Si le programme appelant est exécuté dans le contexte d'une session WebVue particulière, alors le fichier audio n'est joué que dans cette session WebVue; par exemple, si le programme est déclenché par un clic sur un bouton dans un synoptique affiché sur ce client WebVue.

La capacité d'un client WebVue à jouer un fichier multimédia dépend du paramétrage de la propriété Autoriser les opérations multimédia dans le profil de l'utilisateur qui démarre la session WebVue. Voir la rubrique Ajouter un utilisateur WebVue dans l'aide principale.

Il n'est pas possible de configurer le fichier son joué par le mode MULTIMEDIA, sous-mode BEEP. Toutefois, il est possible de remplacer le fichier audio manuellement.

Le fichier son joué est appelé beep.wav et est localisé dans le répertoire suivant :

<Installation folder>\usr\<MyProject>\WEB\audios\beep.wav

Changement du son joué par WEBVUE

Syntaxe 5

IntVal = WEBVUE(Mode);

Type de retour : INTEGER.

Exécution

Mode

Mnémonique

Action

7

WEBVUE_CONTEXT

Ce mode est obsolète, utilisez SESSION("GETTYPE") à la place. Renvoie le contexte dans lequel le programme a été exécuté.

Retour : 0 lorsque le programme est exécuté dans le contexte du client desktop du logiciel PcVue, sinon !=0 lorsqu'il est exécuté sur un client Web.

Syntaxe 6

IntVal = WEBVUE(Mode);

Type de retour : INTEGER.

Exécution

Mode

Mnémonique

Action

1

LIST

Récupère la liste des sessions client web dans un fragment XML.

Cette information comprend :

  • clientip : L'adresse IP du client. Si le client n'est pas sur le même réseau que le serveur, retournera l'adresse IP du routeur ou de l'équipement NAT le plus proche du serveur.

  • clienthost : Lors de la connexion, une recherche DNS inversés est effectuée pour obtenir le nom d'hôte du client. La même limitation que pour l'IP est applicable, si le client est sur un réseau différent, l'hôte du routeur le plus proche est affiché.

  • useragent : La chaîne complète de l'agent utilisateur du client. Ceci est utilisé pour remplir les données des autres nœuds.

  • navigateur : Le nom du navigateur (par exemple, Chrome, Edge, etc).

  • os : Le nom du système d'exploitation client (par exemple, Windows, Mac, etc.)

  • devicetype : Le type d'appareil, que ce soit sur le bureau ou sur le mobile.

Pour plus d'informations, voir les exemples ci-dessous et XMLPATH.

Syntaxe 7

IntVal = WEBVUE(Mode, Url, NewTab);

Type de retour : INTEGER.

Argument

Définition

Url

Une Url sous la forme "https://...". Type STR.

NewTab

Ouverture dans un nouvel onglet du navigateur ou pas. Type INTEGER.

0 : Ouvre dans l'onglet actuel du navigateur web.
1 : Ouvre dans un nouvel onglet du navigateur Web.

Exécution

Mode

Mnémonique

Action

10

HYPERLINK

Redirige le client web appelant vers une page web définie par Url.

Retour : 1 si OK, sinon 0.

Si l'Url ne commence pas par le protocole (http:// ou https://), alors elle est considérée comme relative par le navigateur, et celui-ci ouvrira la ressource web relative au répertoire virtuel /WebClient du serveur web WebVue.

Exemple

Pour un exemple, sélectionnez le lien exemple ci-dessus.