Mode

Mnémonique

Syntaxe

Argument

Définition

VarName

Nom du fichier contenant les données à importer. Type STR

TimeStart

Horodate de début de l'extraction. Type DOUBLE. Voir l'instruction DATETIMEVALUE pour la conversion des horodates.

TimeEnd

Horodate de fin de l'extraction. Type DOUBLE. Voir l'instruction DATETIMEVALUE pour la conversion des horodates.

FileName

Nom du fichier contenant les données à importer. Type STR.

Si exécutée dans le contexte d'une session WebVue, cette instruction est traitée par le back end web, en conséquence de quoi le fichier référencé est sur la machine back end web.

FileMode

Type d'ouverture du fichier résultat de l'extraction lorsque ce dernier existe déjà. La valeur 0 permet d'ouvrir le fichier en effaçant son précédant contenu (valeur par défaut du paramètre). La valeur 1 permet d'ouvrir le fichier en se positionnant à la fin (mode ajout).

Format

Format des lignes ajoutées dans le fichier de l'extraction. Les chaînes de caractères suivantes sont utilisables dans le format :

Element

Description

###Y

Année sur 4 chiffres (exemple : 1994).

#Y

Année sur 2 chiffres (exemple : 94).

#M

Mois (01 à 12).

#D

Jour (01 à 31).

#h

Heures (00 à 23).

#m

Minutes (00 à 59).

#s

Secondes (00 à 59).

##l

Millisecondes (000 à 999).

#V

Valeur de la variable.

Si Format est omis ou égal à une chaîne de caractères vide "", le format par défaut est "#Y#M#D#h#m#s##l,#V".

StateVar

Nom d'une variable état. Cet état est initialisé à 0. Puis il est mis à 1 lorsque l'extraction est terminée. Ceci permet de déclencher l'exécution d'une fonction à la fin d'une extraction (voir l'instruction EVENT).

Ce paramètre est facultatif et ignoré s'il est égal à une chaîne de caractères vide "". Type STR.

NbVar

Nom d'une variable mesure. Cette variable contient le nombre de valeurs extraites lorsque l'extraction s'est terminée correctement.

Ce paramètre est facultatif et ignoré s'il est égal à une chaîne de caractères vide "". Type STR.

Mode

Mnémonique

Action

1

GETTREND

Importation de données historiques pour une variable définie en tendance.

Retour : 0 si erreur, différent de 0 si OK.

Argument

Définition

FileName

Nom de l'unité d'archivage. Type STR.

Si exécutée dans le contexte d'une session WebVue, cette instruction est traitée par le back end web, en conséquence de quoi le fichier référencé est sur la machine back end web.

StateVar

Nom d'une variable état. Cet état est initialisé à 0. Puis elle est mise à 1 lorsque l'extraction est terminée. Ceci permet de déclencher l'exécution d'une fonction à la fin d'une extraction (voir l'instruction EVENT).

Ce paramètre est facultatif et ignoré s'il est égal à une chaîne de caractères vide "". Type STR.

NbVar

Nom d'une variable mesure. Cette variable contient le nombre de valeurs extraites lorsque l'extraction s'est terminée correctement. Ce paramètre est facultatif et ignoré s'il est égal à une chaîne de caractères vide "". Type STR.

FORMAT

Une chaîne de caractères définissant le nom de la variable pour laquelle les données historiques doivent être importées. Si non fourni, le format doit être spécifié dans le fichier d'import lui-même. Type STR.

VARNAME

Format par défaut des points tendances stockés dans le fichier d'importation (voir la syntaxe du mot clé FORMAT). Si non fourni, le format doit être spécifié dans le fichier d'import lui-même. Type STR.

Chaîne FORMAT

Définition

MsFlag

Flag indiquant si les millisecondes sont utilisées dans l'horodate :

0 les millisecondes ne sont pas utilisées.

1 les millisecondes sont utilisées.

VarFlag

Flag spécifiant si le nom de la variable est présent sur chaque ligne du fichier d'importation :

0 pas d'identifiant de variable.

1 l'identifiant de la variable est le nom de la variable

2 l'identifiant de la variable est l'identifiant interne de la variable.

TSFormat

Format temporaire de l'horodate du fichier d'import :

0 YYMMDDhhmmss[ms]
1 MM/DD/YY,hh:mm:ss[:ms]
2 DD/MM/YY,hh:mm:ss[:ms]
3 YY/MM/DD,hh:mm:ss[:ms]
4 MM/DD/YYYY,hh:mm:ss[:ms]
5 DD/MM/YYYY,hh:mm:ss[:ms]
6 YYYY/MM/DD,hh:mm:ss[:ms]
YYYY est l'année sur 4 chiffres.
YY est l'année sur 2 chiffres.
DD est le jour (1 à 31).
MM est le mois (1 à 12).
hh est l'heure (0 à 23).
mm sont les minutes (0 à 59).
ss sont les secondes (0 à 59).
ms sont les millisecondes (0 à 999).

Argument

Définition

VarName

Nom de la variable concernée.

Données

Définition

TimeStamp

L'horodatage dans le format sélectionné.

Value

Valeur de la variable correspondant à l'horodate.

VarName

Nom de la variable concernée.

Mode

Mnémonique

Action

2

IMPORTTREND

Importation de données historiques pour une variablée définie en tendance.

Retour : différent de 0 si OK, 0 si erreur.

Argument

Définition

UnitName

Nom de l'unité d'archivage. Type STR.

Operation

Chaîne représentant le type d'opération. Type STR.

Mode

Mnémonique

Action

3

UNIT

Manipulation de l'unité d'archivage Nom_Unité. La chaîne de caractères contenue dans le paramètre Operation détermine l'action.

Flush

Ecriture de tous les buffers sur le disque (pour tous les types d'unité).

Retour : différent de 0 si OK, 0 si erreur.

Next

Continue l'archivage dans le fichier suivant dans la séquence (unités d'archivage propriétaires et format libre).

Retour : différent de 0 si OK, 0 si erreur.

Enable

Autorise l'archivage (pour les unités libres uniquement).

Retour : différent de 0 si OK, 0 si erreur.

Disable

Interdit l'archivage (pour les unités libres uniquement).

Retour : différent de 0 si OK, 0 si erreur.

Isreadonly

Vérifie la propriété en lecture seule de l'unité d'archive (unités d'archive propriétaires et de format libre).

Retour : -1 si erreur, 1 si en lecture seule, 0 sinon.

Lock

Inhibition temporaire.

Retour : différent de 0 si OK, 0 si erreur.

Unlock

Fin de l'inhibition temporaire appliquée à une unité d'archives en utilisant l'action 'LOCK'.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

UnitName

Nom de l'unité principale. Type STR.

Flag

Modification de la propriété lecture seulement de l'unité d'archivage. Tout type numérique.

Mode

Mnémonique

Action

3

UNIT

Modifie la propriété lecture-seule de l'unité d'archivage.

Si le flag est à 0 alors la propriété lecture-seule est désactivée (vous pouvez écrire dans l'unité d'archivage). Si le flag est à 1 alors la propriété lecture-seule est activée.

Argument

Définition

UnitName

Nom de l'unité d'archivage. Type STR.

Operation

Chaîne représentant le type d'opération. Type STR.

StateVar

Nom de la variable état en tendance. Type STR.

Flag

Un flag (0 ou 1)

Mode

Mnémonique

Action

3

UNIT

Manipulation de l'unité d'archivage Nom_Unité. La chaîne contenue dans le paramètre "Operation" détermine l'action. Voir la syntaxe 3 pour plus de détails.

La variable état StateVar sera positionnée à la valeur du flag lorsque l'opération est complète.

Argument

Définition

VarName

Nom d'unité d'archivage secondaire sur laquelle est historisée la tendance. Type STR.

UnitName

Nom d'unité d’archivage secondaire. Type STR.

Mode

Mnémonique

Action

4

TREND

Permet de spécifier une unité d'archivage secondaire utilisée lors de la relecture pour des variables configurées pour être enregistrées sur plus d'une unité d'archivage. Lorsque le logiciel PcVue extrait des données pour n'importe laquelle de ces variables (par exemple pour les utiliser dans une fenêtre de tendance) les données sont extraites de l'unité d'archivage secondaire.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

VarName

Nom d'unité d'archivage primaire sur laquelle est historisée la tendance. Type STR.

Mode

Mnémonique

Action

4

TREND

Permet de sélectionner l'unité d'archivage principale suite à des affectations par verbe (sous mode SETPRIMARY). Le sous-mode CLEARPRIMARY permet d'affecter comme unité principale, l'unité qui a été configurée comme telle. Lorsque le logiciel PcVue extrait des données pour n'importe laquelle de ces variables (par exemple pour les utiliser dans une fenêtre de tendance) les données sont extraites de l'unité d'archivage primaire.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

PrimaryUnit

Nom de l'unité d'archivage principale. Type STR.

SecondaryUnit

Nom de l'unité d'archivage. Type STR.

Mode

Mnémonique

Action

4

TREND

Permet de sélectionner une unité d'archivage secondaire comme unité principale. Lorsque le logiciel PcVue extrait des données pour n'importe laquelle de ces variables (par exemple pour les utiliser dans une fenêtre de tendance) les données sont extraites de l'unité d'archivage secondaire.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

PrimaryUnit

Nom d'unité d'archivage primaire sur laquelle est historisée la tendance. Type STR.

Mode

Mnémonique

Action

4

TREND

Permet de sélectionner l'unité d'archivage principale suite à des affectations par verbe (sous mode SETPRIMARY ou SETPRIMARY_UNIT). Le sous-mode CLEARPRIMARY_UNIT permet d'affecter comme unité d'archivage principale l'unité configurée comme telle. Lorsque le logiciel PcVue extrait des données pour n'importe laquelle de ces variables (par exemple pour les utiliser dans une fenêtre de tendance) les données sont extraites de l'unité d'archivage primaire.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

VarName

Nom de la variable en tendance. Type STR.

UnitName

Nom de la variable état. Type STR.

SampleRate

Période de filtrage (entier compris entre 0 et 32000).

Mode

Mnémonique

Action

4

TREND

Permet de changer dynamiquement la période de filtrage d'une tendance sur l'unité spécifiée.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

UnitName

Nom de l'unité à rediriger. Type STR.

ServerName

Nom du poste serveur d'historique vers lequel on veut rediriger les demandes de lectures effectuées par le poste local. Le poste doit faire partie d'une association de serveurs d'historiques.

Mode

Mnémonique

Sous-mode

Mnémonique

Action

3

UNIT

10

SETREADSERVER

Pour une unité, réaffecte dynamiquement le poste serveur d'archives qui réalisera les requêtes de lecture.

Retour : différent de 0 si OK, 0 si erreur.

Argument

Définition

UnitName

Nom de l'unité à restaurer. Type STR.

Mode

Mnémonique

Sous-mode

Mnémonique

Action

3

UNIT

11

RESTOREREADSERVER

Restaure la configuration d'origine de l'unité.

Retour : 0 si erreur, 1 sinon.

Argument

Définition

PrimaryUnit

Nom d'unité d'archivage primaire sur laquelle est historisée la tendance. Type STR.

Mode

Mnémonique

Sous-mode

Mnémonique

Action

4

TREND

-

FORCEPRIMARY_UNIT

Permet de spécifier une unité d'archivage primaire pour relecture.

Retour : 0 si erreur, 1 sinon.