EXPORT_LOG
Voir égalementGénère des données de consignations d'historiques en utilisant la fonctionnalité fournie par l'Export de données. Pour plus d'informations, voir l'aide sur l'Analyse de données (L'Application Explorer.Analyse de données). Voir également les Notes fonctionnelles importantes ci-dessous.
Support WebVue - Oui.
L'utilisation des verbes EXPORT, EXPORT_LOG et EXPORT_TREND est préférée à celle des verbes SVLOG et SVTREND. Ces derniers ne sont conservés que pour compatibilité.
L’Export de données est protégé par une option de licence dans la clé de protection du logiciel PcVue. Si vous ne possédez pas cette option, l’Export de données ne s’effectuera qu’en mode démonstration.
| Mode | Mnémonique | Syntaxe |
| 1 | GETRECORD | 1 |
| 2 | GETSTATISTIC | 2 |
| 3 | READBUFFER | 3 |
| 4 | CANCEL | 4 |
| 5 | DISPOSE | 4 |
Arguments communs
|
Argument |
Définition |
| LogListName |
Nom de la liste de consignations à partir de laquelle les données sont obtenues. Type STR. |
| StartTime | Heure de début de la requête d'historiques. L'heure de début doit être antérieure à l'heure de fin. Type DOUBLE. |
| EndTime | Heure de fin de la requête d'historiques. L'heure de fin doit être postérieure à l'heure de début. Type DOUBLE. |
| Events |
Nombre, calculé en utilisant des valeurs de poids binaires, représentant les événements à requêter (valeurs décimales entre parenthèses). Type DOUBLE. |
| AlarmLevelMin | Niveau d'alarme minimum (0 à 29). Type INTEGER |
| AlarmLevelMax | Niveau d'alarme maximum (0 à 29). Type INTEGER |
| ExpressionFilter |
Expression de filtre sur attributs. Voir la rubrique : |
| StatusVariable | Nom d'une variable mesure dans laquelle le status de l'export est reporté. Type STR. |
| LineSeparator | Caractère utilisé comme séparateur de ligne dans le buffer de sortie. Type STR. L'utilisation de "\n" (retour chariot) est recommandée pour éviter les erreurs d'analyse syntaxique dues aux paramètres régionaux ou à la valeur des champs (qui peuvent inclure des virgules, des point-virgules ou des points). |
| ColumnSeparator | Caractère utilisé comme séparateur de colonne dans le buffer de sortie. Type STR. L'utilisation de "\t" (tabulation) est recommandée pour éviter les erreurs d'analyse syntaxique dues aux paramètres régionaux ou à la valeur des champs (qui peuvent inclure des virgules, des point-virgules ou des points). |
| MaxRetLines | Nombre maximum de lignes retournées par la requête (surcharge le paramètre global Compteur max pour données générées). 0 = pas de maximum. Type INTEGER |
| MaxValuesToProcess | Nombre maximum de valeurs brutes traitées (surcharge le paramètre global Compteur max pour données brutes). 0 = pas de maximum. Type INTEGER |
Syntaxe 1
IntVal = EXPORT_LOG(Mode, LogListName, StartTime, EndTime, Events, AlarmLevelMin, AlarmLevelMax, ExpressionFilter, StatusVariable, LineSeparator, ColumnSeparator, MaxRetLines, DataFormat, DataHeader)
Type de retour : INTEGER.
|
Argument |
Définition |
|
DataFormat |
Format de données des colonnes. Le format de chaque colonne est séparé par le caractère "|". Type STR. |
| DataHeader | Texte d'entête. Chaque entête de colonne est séparé par le caractère "|". Type STR. Exemple : Date|Time|Event|Title |
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | GETRECORD |
Génère une requête d'historiques pour renvoyer les enregistrements consignés contenues dans une liste de consignations. |
Syntaxe 2
IntVal = EXPORT_LOG(Mode, LogListName, StartTime, EndTime, Events, AlarmLevelMin, AlarmLevelMax, ExpressionFilter, StatusVariable, LineSeparator, ColumnSeparator, MaxValuesToProcess, MaxRetLines, StatFlag, StatSortOrder, StatCountersFormat, StatRounded)
Type de retour : INTEGER.
|
Argument |
Définition |
| StatFlag |
Nombre, calculé en utilisant des valeurs de poids binaires, représentant les statistiques à générer (valeurs décimales entre parenthèses). 0x0000 0000 0001 = Compteur de toutes les transitions (1) |
| StatSortOrder | Statistique utilisée pour trier les résultats. Sélectionné en utilisant une des valeurs utilisées pour StatFlag. 0 = aucun tri. Type LONGLONG. |
| StatCountersFormat | Numéro indiquant l'unités des compteurs de durée. Type INTEGER. 0 = Aucun 1 = Secondes 2 - Minutes 3 = Heures 4 = Jours |
| StatRounded | Type INTEGER. 0 = Aucun arrondi 1 = Arrondi |
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | GETSTATISTIC |
Génère une requête d'historiques pour retourner des valeurs de statistiques depuis la liste de consignations. Retour : Voir Notes fonctionnelles ci-dessous. |
Syntaxe 3
IntVal = EXPORT_LOG(Mode, BufferHandle);
Type de retour : INTEGER.
|
Argument |
Définition |
| BufferHandle |
Handle du buffer précédemment créé en utilisant ALLOC_BUFFER. Type de retour : LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
| 5 | READBUFFER |
Lit le buffer de données après un GETRECORD ou GETSTATISTIC. |
Syntaxe 4
IntVal = EXPORT_LOG(Mode);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | CANCEL |
Annule la requête d'historiques courante. Un CANCEL doit toujours être suivi par un DISPOSE. |
| 7 | DISPOSE | Libère le buffer interne utilisé par une requête d'historiques. Doit toujours être appelé avant de faire une nouvelle demande d'historiques ou après un CANCEL. Retour : Toujours 0. |
Notes fonctionnelles importantes
L'instruction EXPORT_LOG fonctionne de façon asynchrone. Une fois qu'une requête d'historiques a été générée par les modes GETRECORD ou GETSTATISTIC, le script continue d'être exécuté sans attendre les données d'historiques qui seront générées. La valeur de retour de l'instruction indique si la requête d'historiques a été envoyée avec succès, ou non.
Lorsque la requête d'historiques est terminée (avec succès ou non) la valeur de la variable de status est modifiée en conséquence. Sur ce changement, si la valeur de la variable de status indique un succès, le mode READBUFFER doit être utilisé pour récupérer les données dans une mémoire tampon (buffer) à partir duquel un traitement ultérieur peut être effectué (par exemple un export vers Excel en utilisant le verbe BUFTOEXCEL).
Il sera probablement nécessaire d'utiliser plusieurs fois READBUFFER jusqu'à ce que le code retour de READBUFFER soit égal à 0 indiquant que toutes les données ont été traitées.
Si vous utilisez une boucle comprenant READBUFFER, vous devez respecter la limite de 30 secondes autorisée pour une exécution SCADA Basic. Si vous dépassez ceci (ce qui est possible si vous traitez de grandes quantités de données), l'exécution sera annulée avec une erreur.
Une fois terminé, un mode DISPOSE doit être exécuté pour libérer le buffer interne utilisé dans la requête historique.
Valeurs de retour
Toutes les valeurs de retour autres que zéro indiquent une erreur. Notez en particulier un retour de -30 qui indique qu'une requête précédente est toujours en cours et devra être gérée dans le script.
|
Valeur |
Définition |
| 0 | Requête envoyée |
| -1 | LogListName n'est pas un STR |
| -2 | LogList n'existe pas |
| -3 | Start time est indéfini ou invalide |
| -4 | End time est indéfini ou invalide |
| -5 | Event Code ne peut pas être lu |
| -6 | Event Code est plus petit ou égal à 0 |
| -7 | AlarmLevelMin ne peut pas être lu |
| -8 | AlarmLevelMin doit être entre 0 et 29 |
| -9 | AlarmLevelMax ne peut pas être lu |
| -10 | AlarmLevelMax doit être 0 et 29 |
| -11 | AlarmLevelMin doit être plus petit que AlarmLevelMax |
| -12 | ExpressionFilter n'est pas un STR |
| -13 | StatusVariable n'est pas un STR |
| -14 | StatusVariable n'est pas une mesure |
| -15 | LineSeparator ne peut pas être lu |
| -16 | ColumnSeparator ne peut pas être lu |
| -20 | DataFormat n'est pas un STR |
| -21 | DataHeader n'est pas un STR |
| -22 | Format et header ont un nombre de colonnes différents |
| -23 | StatFlag ne peut pas être lu |
| -24 | StatFlag doit être plus petit ou égal à 0 |
| -25 | StatSortingOrder ne peut pas être lu |
| -26 | StatSortingOrder doit être plus petit que 0 |
| -27 | StatCountersFormat ne peut pas être lu |
| -28 | StatCountersFormat doit être entre 0 et 4 |
| -29 | StatRoundedToRequest ne peut pas être lu |
| -30 | Une requête d'historiques précédente est toujours en cours. |
Valeurs de variable de status
L'état de la dernière requête historique.
|
Valeur |
Définition |
| 0 | Terminé avec succès. |
| 1 | En exécution. |
| 3 | Annulé. |
| 4 | Terminé mais le nombre maximum de points a été atteint. |
| 5 | Terminé mais le nombre maximum de valeurs traitées a été atteint. |
| 10 | Échec. |
| 11 | Echec dû à une configuration incorrecte. |
| 12 | Echec dû à un échec de la requête d'historiques. |
Exemples
Pour plus d'exemples, sélectionnez en haut de la rubrique.