Siemens SIMATIC HMI WinCC Unified Manuel Système

Masquer les pouces

page de 76

/ 76
Signets

Liens rapides

Télécharger ce manuel

SIMATIC HMI

WinCC Unified

WinCC Unified GraphQL

Manuel système

Documentation en ligne

11/2023

Documentation en ligne

Introduction

Notions de base

Démarrage rapide

Schéma

Référence de l'API GraphQL

Exemples de code

Marches à suivre

recommandées

Correction d'erreurs

Sommaire des Matières pour Siemens SIMATIC HMI WinCC Unified

Page 1 Introduction Notions de base Démarrage rapide SIMATIC HMI Schéma WinCC Unified WinCC Unified GraphQL Référence de l'API GraphQL Exemples de code Manuel système Marches à suivre recommandées Correction d'erreurs Documentation en ligne 11/2023 Documentation en ligne...
Page 2 Tenez compte des points suivants: ATTENTION Les produits Siemens ne doivent être utilisés que pour les cas d'application prévus dans le catalogue et dans la documentation technique correspondante. S'ils sont utilisés en liaison avec des produits et composants d'autres marques, ceux-ci doivent être recommandés ou agréés par Siemens. Le fonctionnement correct et sûr des produits suppose un transport, un entreposage, une mise en place, un montage, une mise en service, une utilisation et une maintenance dans les règles de l'art.
Page 3 Sommaire Introduction ............................5 Notions de base ............................. 7 Restrictions.......................... 7 Sécurité ..........................7 Escaping ..........................8 Informations complémentaires..................... 9 Démarrage rapide..........................11 Objectif de ce démarrage rapide..................11 Conditions ......................... 11 Configurer un GraphQL Client..................... 12 Connexion au serveur GraphQL..................14 Exécuter une opération GraphQL..................
Page 4 Sommaire 5.5.3 Mutation "extendSession" ....................50 5.5.4 Requête "session"....................... 51 5.5.5 Requête "nonce" ........................ 52 5.5.6 Souscription "reduState"..................... 52 Référence des types et énumérations spécifiques à Unified..........53 5.6.1 Introduction........................53 5.6.2 Types "ActiveAlarm" et "ActiveAlarmNotification"..............53 5.6.3 Type "AlarmIdentifierInput"....................57 5.6.4 Type "AlarmInvalidFlags"...
Page 5 Introduction API WinCC Unified GraphQL Une API GraphQL est une interface basée sur le Web utilisée pour l'implémentation d'applications (clients GraphQL) qui ont un accès en lecture et en écriture aux données Runtime. Fonctions disponibles GraphQL met à votre disposition les fonctions suivantes pour l'accès au Runtime : Variables Alarmes actives Alarmes archivées...
Page 6 Introduction • Les structures des requêtes du client et les réponses du serveur sont décrites par un schéma. • Chaque opération définit un jeu de sélection. La réponse du serveur ne contient que les attributs spécifiés dans ce jeu de sélection. WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 7 Notions de base Restrictions L'API Unified GraphQL est soumise aux restrictions suivantes : • L'interface GraphQL prend uniquement en charge Unified PC. • L'accès est limité au Runtime dans lequel est connecté le GraphQL Client. Il n'est pas possible d'accéder aux appareils IHM connectés via Runtime Collaboration. •...
Page 8 Notions de base 2.3 Escaping Fermer toutes les sessions d'un utilisateur Vous disposez des possibilités suivantes : • L'utilisateur se déconnecte de l'une de ses sessions et transmet la valeur True pour le paramètre allSessions. • L'administrateur modifie le mot de passe de l'utilisateur dans le système d'ingénierie. L'administrateur se connecte avec les données de connexion modifiées de l'utilisateur dans GraphQL.
Page 9 Notions de base 2.4 Informations complémentaires Exemple Le caractère " est une séquence Escape dans le système Runtime et dans Apollo Studio. Pour adresser p. ex. une variable avec le nom MOT1", saisissez la chaîne de caractères suivante : MOT1$\" Informations complémentaires Vous trouverez plus d'informations sur GraphQL ici : •...
Page 10 Notions de base 2.4 Informations complémentaires WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 11 Démarrage rapide Objectif de ce démarrage rapide Ce démarrage rapide démontre à l'aide d'un GraphQL Client prêt à l'emploi et librement disponible dans Apollo Studio comment établir une connexion au serveur Unified GraphQL, vous connecter au Runtime puis interroger, gérer et souscrire des données Runtime. Le démarrage rapide vous permet ensuite de tester le GraphQL Client d'Apollo et de vous familiariser plus facilement avec le travail avec WinCC Unified GraphQL.
Page 12 Démarrage rapide 3.3 Configurer un GraphQL Client Configurer un GraphQL Client Marche à suivre 1. Démarrez un navigateur web sur un appareil qui a un accès au serveur Runtime. 2. Dans la ligne d'adresse, saisissez l'adresse suivante et appuyez sur Entrée : https://studio.apollographql.com/sandbox/explorer (https://studio.apollographql.com/ sandbox/explorer)
Page 13 Démarrage rapide 3.3 Configurer un GraphQL Client L'introspection de schéma est activée pour le serveur Unified GraphQL. Une fois le GraphQL Client configuré, vous voyez par conséquent un point vert dans la ligne d'adresse. La documentation de l'API GraphQL est en outre disponible dans le client : Voir aussi Conditions (Page 11) Principes de base du schéma (Page 23)
Page 14 Démarrage rapide 3.4 Connexion au serveur GraphQL Connexion au serveur GraphQL Remarque Vous trouverez des informations sur la connexion SWAC au chapitre Mutation "loginSWAC" (Page 49). L'accès d'un GraphQL Client aux données Runtime requiert que le client soit connecté avec un utilisateur au Runtime. Condition La condition suivante s'applique en plus des conditions générales : •...
Page 15 Démarrage rapide 3.5 Exécuter une opération GraphQL Utilisez cette ID de jeton pour les appels suivants des opérations GraphQL. Si le client a été inactif pendant un moment, le jeton expire. Le client doit se connecter à nouveau. Remarque L'appel de la mutation extendSession permet d'éviter que la session se termine malgré une inactivité.
Page 16 Démarrage rapide 3.5 Exécuter une opération GraphQL Marche à suivre Pour exécuter des opérations Unified GraphQL pour un GraphQL Client, procédez comme décrit ci-dessous. La marche à suivre fondamentale est identique pour les trois types d'opération. 1. Dans Apollo Studio, sélectionnez la vue de l'explorateur et saisissez l'opération souhaitée dans le Panel "Operation".
Page 17 Démarrage rapide 3.5 Exécuter une opération GraphQL – Dans le Panel "Variables", créez une variable et utilisez-la dans le Panel "Operation". Pour cela, saisissez dans le Panel "Operation" le caractère "$", suivi du nom de la variable : Remarque Variable comme paramètre de saisie Assurez-vous que la variable existe au Runtime connecté...
Page 18 Démarrage rapide 3.5 Exécuter une opération GraphQL Exemples des différents types d'opération • Type Requête : • Type Mutation : Si vous exécutez une requête pour la variable après la mutation, vous recevez la valeur modifiée. • Type Souscription : WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 19 Démarrage rapide 3.5 Exécuter une opération GraphQL Si vous exécutez une mutation pour la variable après la souscription, vous recevez une notification. Terminer la souscription Pour terminer une souscription, cliquez sur le bouton "X" dans le Panel "Subscriptions". Remarque Souscriptions dans Apollo Studio Il n'existe qu'une seule souscription active dans le GraphQL Client dans Apollo Studio.
Page 20 Démarrage rapide 3.6 Autoriser un appel d'opération Autoriser un appel d'opération Condition La condition suivante s'applique en plus des conditions générales : • Le serveur GraphQL a été configuré. • Le GraphQL Client est connecté au serveur. Le jeton d'autorisation émis lors de la connexion est encore valide.
Page 21 Démarrage rapide 3.7 Utilisation de la mise en valeur de la syntaxe et du complètement automatique d'Apollo Utilisation de la mise en valeur de la syntaxe et du complètement automatique d'Apollo Introduction Le présent chapitre décrit comment intégrer l'extension GraphQL Apollo à la mise en valeur de la syntaxe et au complètement automatique dans Visual Studio Code.
Page 22 Démarrage rapide 3.7 Utilisation de la mise en valeur de la syntaxe et du complètement automatique d'Apollo Exemple : • Faites flotter le pointeur de la souris au-dessus d'un code GraphQL. Un texte d'aide contenant des informations supplémentaires s'ouvre : • Lorsque vous saisissez un code GraphQL, des propositions de complètement automatique s'affichent : WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 23 Schéma Principes de base du schéma Le schéma GraphQL est un objet au format JSON compréhensible, aussi bien par les personnes que par les applications, qui décrit l'API GraphQL. Si le GraphQL Client connaît le schéma du serveur GraphQL, il vous assiste, par exemple, par le biais d'un complètement automatique et d'un contrôle de la syntaxe.
Page 24 Schéma 4.2 Structure d'une requête de client Mise en valeur de la syntaxe et complètement automatique dans des éditeurs Pour utiliser la mise en valeur de la syntaxe et le complètement automatique lors de l'implémentation d'un GraphQL Client dans des éditeurs, les extensions adaptées à l'environnement de développement doivent être installées.
Page 25 Schéma 4.2 Structure d'une requête de client Structure du jeu de sélection Lors de l'appel d'une opération, indiquez dans le jeu de sélection les attributs que retourne le serveur. Vous pouvez demander tous les attributs définis dans le type en retour de l'opération. Notation : Nom de l'opération ( <paramètre de saisie>) { <jeu de sélection>...
Page 26 Schéma 4.2 Structure d'une requête de client WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 27 Référence de l'API GraphQL Généralités sur l'API GraphQL La grande convivialité de l'API GraphQL est un aspect essentiel. Les principes suivants s'appliquent à l'API Unified GraphQL : • Le nom, et non l'ID, des variables et des alarmes actives de Runtime permet d'y accéder. Les noms sont configurés dans l'ingénierie.
Page 28 Référence de l'API GraphQL 5.3 Opérations pour variables Souscriptions Vous utilisez des souscriptions afin que votre GraphQL Client puisse réagir immédiatement aux événements Runtime, sans devoir interroger l'état Runtime en permanence. La souscription génère une connexion WebSocket permanente entre le serveur GraphQL et le client. Si un client souscrit à...
Page 29 Référence de l'API GraphQL 5.3 Opérations pour variables Paramètre de saisie names • Paramètre obligatoire • Type de données : chaîne de caractères • Liste des noms de variables dont vous souhaitez lire les propriétés Notation : names:["<nom variable1>", "<nom variable2>", "<...>"] Exemple : names:["motor1.tempMax", "motor1.tempMin"] Adressage de variables : –...
Page 30 Référence de l'API GraphQL 5.3 Opérations pour variables code Voir aussi Type "TagValueResult" (Page 63) 5.3.2 Mutation "writeTags" Conditions • L'utilisateur connecté au Runtime pour le client GraphQL possède le droit "GraphQL - Accès en lecture/écriture" au Runtime. Description writeTagValues( input: [TagValueInput], timestamp: Timestamp quality: QualityInput ): [WriteTagValuesResult]...
Page 31 Référence de l'API GraphQL 5.3 Opérations pour variables Paramètre de saisie input • Paramètre obligatoire • Type de données : chaîne de caractères • Liste des variables et des valeurs que vous souhaitez écrire Notation : input:[ {<indications sur la variable 1>}, {<indications sur la variable 2>},{<...>}] Exemple : input: [{name: "motor1.speed", value: "100"}, {name: "motor2.speed", value: "140"}]...
Page 32 Référence de l'API GraphQL 5.3 Opérations pour variables Exemple mutation exampleTagValueWrite { writeTagValues(input:[ name:"ExampleStringTag", value: "Example value text” name:"ExampleIntegerTag", value: 42, timestamp:"2022-07-26T06:25:15Z" ], quality:{quality: GOOD_NON_CASCADE}){ name error{ code description Voir aussi Type "WriteTagValueResult" (Page 66) Type "QualityInput" (Page 61) WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 33 Référence de l'API GraphQL 5.3 Opérations pour variables 5.3.3 Souscription "tagValues" Conditions • L'utilisateur connecté au Runtime pour le client GraphQL possède les droits "GraphQL - Accès en lecture" ou "GraphQL - Accès en lecture/écriture" au Runtime. • Le protocole WebSocket a été activé. Remarque Le protocole WebSocket n'est pas activé...
Page 34 Référence de l'API GraphQL 5.3 Opérations pour variables Terminer la souscription La souscription à une variable prend fin de manière implicite : • Lorsque la variable est renommée. • Lorsque la variable est supprimée. Si vous terminez la souscription de manière explicite dans le GraphQL Client, toutes les variables précédemment souscrites ne seront plus souscrites.
Page 35 Référence de l'API GraphQL 5.4 Opérations pour alarmes Opérations pour alarmes 5.4.1 Requête "activeAlarms" Conditions • L'utilisateur connecté au Runtime pour le client GraphQL possède les droits "GraphQL - Accès en lecture" ou "GraphQL - Accès en lecture/écriture" au Runtime. Description activeAlarms( systemNames: [String] filterString: String...
Page 36 Référence de l'API GraphQL 5.4 Opérations pour alarmes Paramètre de saisie systemNames • Optionnel • Type de données : chaîne de caractères • Réservé pour les versions ultérieures. • Indique le Runtime dont les alarmes sont interrogées. Dans la version actuelle, il s'agit toujours des alarmes du Runtime connecté avec le serveur GraphQL.
Page 37 Référence de l'API GraphQL 5.4 Opérations pour alarmes Exemple query exampleAlarmQuery activeAlarms(languages:["en-US", "de-DE"], filterLanguage:"en-US", filterString:(raiseTime <= '2022-07-26T09:00' AND userName LIKE '* Doe') OR priority > 2") name eventText alarmText1 alarmClassName state raiseTime priority Voir aussi Types "ActiveAlarm" et "ActiveAlarmNotification" (Page 53) Type "Error" (Page 59) 5.4.2 Requête "loggedAlarms"...
Page 38 Référence de l'API GraphQL 5.4 Opérations pour alarmes Nom de l'opération loggedAlarms Type d'opération query Fonction Interroge les alarmes archivées sur le serveur. Paramètres de saisie systemNames : • Optionnel • Correspond à la requête activeAlarms filterString, filterLanguage, languages: • Optionnel • Correspond à...
Page 39 Référence de l'API GraphQL 5.4 Opérations pour alarmes 5.4.3 Mutations "acknowledgeAlarms" et "resetAlarms" Introduction Vous disposez des possibilités suivantes : • Acquitter ou réinitialiser toutes les alarmes actives d'une ou plusieurs alarmes configurées • Acquitter ou réinitialiser des instances d'alarme spécifiques d'une ou plusieurs alarmes configurées Remarque Alarmes sans acquittement groupé...
Page 40 Référence de l'API GraphQL 5.4 Opérations pour alarmes Jeu de sélection Saisie obligatoire Indiquez les attributs que le serveur retourne pour les alarmes interrogées. Vous pouvez demander les attributs définis dans le type ActiveAlarm. Vous trouverez des informations sur la notation au chapitre Structure d'une requête de client (Page 24). Réponse du serveur Renvoie les attributs demandés dans le jeu de sélection sous forme de paires de valeurs clés d'un enregistrement JSON pour les alarmes.
Page 41 Référence de l'API GraphQL 5.4 Opérations pour alarmes Nom de l'opération disableAlarms enableAlarms Type d'opération mutation Fonction Désactive les alarmes spécifiées dans le paramètre Active les alarmes spécifiées dans le paramètre de de saisie names. saisie names. Paramètres de saisie names : •...
Page 42 Référence de l'API GraphQL 5.4 Opérations pour alarmes names: [String] ): [AlarmMutationResult] Nom de l'opération shelveAlarms unshelveAlarms Type d'opération mutation Fonction Ajourne l'alarme. L'attribut suppressionState Annule l'ajournement des alarmes. Cela génère de l'alarme est réglé sur 0x2 Shelved. une entrée d'archive. Lorsque le client GraphQL a souscrit à...
Page 43 Référence de l'API GraphQL 5.4 Opérations pour alarmes Réponse du serveur Renvoie les attributs demandés dans le jeu de sélection sous forme de paires de valeurs clés d'un enregistrement JSON pour les alarmes. Messages d'erreur • 0 : Success (code • 2 : Cannot resolve provided name et description) Voir aussi...
Page 44 Référence de l'API GraphQL 5.4 Opérations pour alarmes Paramètre de saisie systemNames • Optionnel • Type de données : chaîne de caractères • Réservé pour les versions ultérieures. • Indique le Runtime dont les alarmes sont souscrites. Dans la version actuelle, il s'agit toujours des alarmes du Runtime connecté avec le serveur GraphQL.
Page 45 Référence de l'API GraphQL 5.4 Opérations pour alarmes Indiquer les langues dans le format de code de langue ISO (par ex. "en-US", "de-DE"). Tenez compte de la casse. Exemple subscription exampleAlarmSubscription activeAlarms(languages:["en-US", "de-DE"], filterLanguage:"en-US", filterString:(raiseTime <= '2022-07-26T09:00' AND userName LIKE '* Doe') OR priority > 2") name notificationReason eventText...
Page 46 Référence de l'API GraphQL 5.4 Opérations pour alarmes Restriction Dans la présente version de Unified GraphQL, vous ne pouvez pas filtrer selon les propriétés d'alarme suivantes : • state • stateMachine • changeReason • sourceType • suppressionState • invalidFlags • producer •...
Page 47 Référence de l'API GraphQL 5.4 Opérations pour alarmes Remarque Filtrer par propriété "path" path est le nom complet de l'alarme. Il se compose des éléments suivants : • Alarme d'une variable : <nom du système>::<nom de la variable>:<nom de l'alarme> • Alarme d'un élément d'une variable de structure ou d'un tableau : <nom du système>::<nom de la variable>.<chemin d'élément>:<nom de l'alarme>...
Page 48 Référence de l'API GraphQL 5.5 Autres opérations Autres opérations 5.5.1 Mutation "login" Conditions • Les données de connexion d'un utilisateur UMC configuré pour Runtime sont connues. Description "login" login ( username: String password: String ): Session Nom de l'opération login Type d'opération mutation Fonction Connecte le GraphQL Client avec les données de connexion d'un utilisateur UMC configuré...
Page 49 Référence de l'API GraphQL 5.5 Autres opérations Voir aussi Interruption de la connexion par le serveur (Page 71) Mutation "extendSession" (Page 50) Connexion au serveur GraphQL (Page 14) Type "Session" (Page 62) 5.5.2 Mutation "loginSWAC" Conditions • Les données de connexion d'un utilisateur UMC configuré pour Runtime sont connues. •...
Page 50 Référence de l'API GraphQL 5.5 Autres opérations Jeu de sélection Entrée obligatoire Indiquez les attributs que retourne le serveur. Vous pouvez demander les attributs définis dans le type Session. Vous trouverez des informations sur la notation au chapitre Structure d'une requête de client (Page 24). Demandez au moins un token.
Page 51 Référence de l'API GraphQL 5.5 Autres opérations Voir aussi Mutation "login" (Page 48) Type "Session" (Page 62) Requête "session" (Page 51) 5.5.4 Requête "session" Condition • Le GraphQL Client est connecté au serveur. Description session( allSessions: Boolean ): [Session] Nom de l'opération session Type d'opération query Description Interroge les données de session actuelles du serveur.
Page 52 Référence de l'API GraphQL 5.5 Autres opérations 5.5.5 Requête "nonce" Description nonce: Nonce Nom de l'opération nonce Type d'opération query Fonction Interroge le serveur GraphQL sur une instance Nonce. Le nombre aléatoire est requis pour la connexion SWAC. Paramètre de saisie Jeu de sélection Entrée obligatoire Indiquez les attributs que retourne le serveur.
Page 53 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Jeu de sélection Saisie obligatoire Indiquez les attributs que le serveur retourne pour les alarmes interrogées. Vous pouvez demander les attributs définis dans le type ReduStateNotification. Vous trouverez des informations sur la notation au chapitre Structure d'une requête de client (Page 24). Réponse du serveur Renvoie les attributs demandés dans le jeu de sélection sous forme de paires de valeurs clés d'un enregistrement JSON.
Page 54 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified En font partie : • Les propriétés des alarmes actives Le tableau ci-après présente la référence des propriétés d'alarme. Les propriétés traduisibles sont retournées sous forme d'un tableau de chaînes de caractères. Le tableau contient les textes de la propriété...
Page 55 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Type de données Description L'intervalle entre l'heure de l'activation de l'alarme et l'heure du duration Timespan dernier changement d'e l'état de l'alarme Texte principal de l'alarme, décrit généralement la cause de l'alarme eventText [String] Propriété...
Page 56 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Type de données Description Produit Siemens ou fonction d'un domaine dont fait partie la source producer AlarmProducer de l'alarme, comme défini dans l'énumération AlarmProducer Qualité de state en tant qu'instance Quality...
Page 57 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Voir aussi Requête "activeAlarms" (Page 35) Souscription "activeAlarms" (Page 43) Type "AlarmInvalidFlags" (Page 58) Type "Timespan" (Page 64) Type "Timestamp" (Page 64) Type "Quality" (Page 60) 5.6.3 Type "AlarmIdentifierInput" Description Le type AlarmIdentifierInput définit des attributs pour la spécification des alarmes à acquitter ou à...
Page 58 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified 5.6.4 Type "AlarmInvalidFlags" Description Le type AlarmInvalidFlags définit des attributs pour des attributs ou des configurations invalides d'alarmes. Type de données Description L'alarme a une configuration invalide. invalidConfigura Boolean tion L'alarme a un horodatage invalide.
Page 59 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified 5.6.6 Type "Error" Description Le type Error définit les attributs des erreurs Item Level. Pour les opérations GraphQL avec des erreurs Item Level, vous pouvez demander ces attributs au serveur via le jeu de sélection lors de l'appel de l'opération. Attributs : Type de données Description...
Page 60 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Ces attributs d'alarme ne sont pas archivés. Voir aussi Requête "loggedAlarms" (Page 37) 5.6.8 Type "Nonce" Description Le type Nonce définit les attributs d'un nombre aléatoire requis pour la connexion d'un GraphQL Client via une connexion SWAC.
Page 61 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Type de données Description La source qui a défini value a également défini l'instance sourceQuality Boolean Quality. La source qui a défini value a également défini un horodata‐ sourceTime Boolean L'horodatage défini par la source a été...
Page 62 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Description du type "ReduStateValue" Le type ReduStateValue possède les attributs suivants : Type de données Description L'état de redondance, comme défini dans l'énumération ReduState : value ReduStateValue • ACTIVE L'hôte du serveur GraphQL actuellement connecté au client GraphQL est actif.
Page 63 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified 5.6.13 Type "TagValueNotification" Description Le type TagValueNotification définit les attributs que peuvent contenir les notifications des variables souscrites. Attributs : Type de données Description Nom de la variable souscrite name String Instance Value des variables...
Page 64 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Voir aussi Requête "tagValues" (Page 28) Type "Error" (Page 59) Type "Value" (Page 65) 5.6.15 Type "Timespan" Description Type permettant de définir un intervalle de temps. Type de données de l'ntervalle de temps : RAW (entier en 100 ns) Voir aussi Types "ActiveAlarm"...
Page 65 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Type de données Description Langue paramétrée pour l'utilisateur dans UMC language String Peut être vide. Intervalle de temps en secondes pendant lequel l'utilisateur peut être inactif autoLoggOffSec avant que son jeton d'autorisation n'expire Voir aussi Type "Session"...
Page 66 Référence de l'API GraphQL 5.6 Référence des types et énumérations spécifiques à Unified Voir aussi Type "TagValueResult" (Page 63) Type "Quality" (Page 60) Type "TagValueNotification" (Page 63) 5.6.20 Type "WriteTagValueResult" Description Une instance du type WriteTagValueResult représente un retour pour l'accès en écriture à une variable.
Page 67 Exemples de code Un grand nombre d'exemples de code disponibles en plusieurs langages de programmation sont fournis avec WinCC Unified GraphQL. Vue d'ensemble Langage de programmation Thèmes couverts Python Connexion Interroger et modifier des données Souscrire à des données HTML et JavaScript Souscrire à...
Page 68 Exemples de code WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 69 Marches à suivre recommandées Optimisation de la performance La performance d'un GraphQL Client dépend de l'utilisation de l'API GraphQL. Vous trouverez ci-après des conseils pour optimiser la performance de votre application GraphQL. Restriction de la sélection Le serveur GraphQL transmet dans sa réponse au client les champs indiqués par ce dernier lors de l'appel de l'opération dans le jeu de sélection.
Page 70 Marches à suivre recommandées 7.1 Optimisation de la performance Exemple Objectif Lire l'horodatage de plusieurs variables Requête query{ tagValues(names: ["Tag_1"],["Tag_2"],["Tag_3"]) {value {value timestamp} error { description }} Réponse {"data": {"tagValues": [ {"value": {"value": 75, "timestamp": "2022-07-20T07:50:46.476" }, "error": {"description": "Succeeded" }}, {"value": {"value": false, "timestamp": "1970-01-01T00:00:00.000Z"...
Page 71 Marches à suivre recommandées 7.2 Interruption de la connexion par le serveur Interruption de la connexion par le serveur Vue d'ensemble Le client interrompt normalement la connexion au serveur GraphQL par le biais d'un appel de la mutation logout. Dans de rares cas, le serveur interrompt la connexion, par exemple, lorsqu'il est arrêté.
Page 72 Marches à suivre recommandées 7.2 Interruption de la connexion par le serveur WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...
Page 73 Correction d'erreurs Erreurs Top Level et Item Level Groupes d'erreurs Les groupes d'erreurs suivants existent dans GraphQL : • Erreurs Top Level L'appel de méthode complet a échoué. Seul le message d'erreur est renvoyé, pas les données de résultat. • Erreur Item Level La méthode a pu être appelée, mais des parties de l'appel de méthode ont échoué.
Page 74 Correction d'erreurs 8.1 Erreurs Top Level et Item Level "activeAlarms": null Attributs : • message : Description de l'erreur facile à comprendre • locations et path : Partie erronée de la requête • code : Code d'erreur général ou spécifique INTERNAL_SERVER_ERROR est le code d'erreur standard en l'absence d'un code d'erreur spécifique.
Page 75 Correction d'erreurs 8.2 Le serveur GraphQL ne démarre pas Le serveur GraphQL ne démarre pas Problème Le serveur GraphQL ne démarre pas Identification de la cau‐ 1. Dans le dossier d'installation de WinCC Unified sous "WinCCUnified\bin", double-cliquez sur le fichier "RTILtraceViewer.exe". L'application "TraceViewer"...
Page 76 Correction d'erreurs 8.2 Le serveur GraphQL ne démarre pas WinCC Unified GraphQL Manuel système, 11/2023, Documentation en ligne...

Ce manuel est également adapté pour:

Simatic hmi wincc unified graphql