Contrôle de version avec les espaces de travail
Sur cette page
Un espace de travail de contrôle de version est un dossier sur le disque, à côté de votre projet TIA Portal ou à tout autre endroit de votre choix, qui contient des objets du projet sous forme de fichiers ordinaires : blocs, types de données PLC, tables de variables, objets technologiques et types de bibliothèque, un fichier par objet. Comme il s'agit d'un dossier ordinaire, vous pouvez le versionner avec Git, SVN ou tout autre outil que vous utilisez déjà. Studio et TIA Portal gardent le projet et les fichiers en phase : vous connectez les objets à leurs fichiers, écrivez les modifications du projet dans les fichiers, reprenez les fichiers modifiés dans le projet et voyez d'un coup d'œil quel côté a changé.
Les espaces de travail appartiennent au projet. TIA Portal les enregistre, ainsi que leurs dossiers et chaque connexion, dans le projet, si bien qu'ils sont de retour à la prochaine ouverture. Un espace de travail créé ou modifié dans un projet que vous fermez ensuite sans l'enregistrer est perdu, comme toute autre modification.
Prérequis
- Une connexion à TIA Portal avec un projet ouvert. Dans un projet ouvert hors ligne, les espaces de travail ne sont pas affichés.
- TIA Portal V17 ou plus récent pour voir et gérer les espaces de travail et les groupes. La langue des fichiers peut être choisie à partir de TIA Portal V18, les paramètres d'importation de bibliothèque à partir de TIA Portal V20.
- TIA Portal V20 ou plus récent pour connecter des objets, les exporter, lire l'état et synchroniser. Sur V17, V18 et V19, vous ne faites que gérer les espaces de travail, et l'état de l'espace de travail l'indique.
- Le fait qu'une installation TIA Portal propose ou non le contrôle de version dépend de sa version et de sa mise à jour. Si ce n'est pas le cas, la branche Espaces de travail de contrôle de version n'apparaît pas.
- L'affichage des espaces de travail et de leur état fonctionne avec tous les forfaits. Créer, modifier et supprimer des espaces de travail, connecter, exporter, importer et déconnecter nécessitent le forfait Pro ; sans lui, la boîte de dialogue de mise à niveau s'ouvre et rien n'est modifié.
La branche des espaces de travail de contrôle de version
L'Explorateur de projet affiche la branche Espaces de travail de contrôle de version à la fin de l'arborescence, après Bibliothèque de projet et Bibliothèques globales :
- Les groupes d'espaces de travail organisent vos espaces de travail, par exemple par ligne ou par station. Un groupe peut contenir des espaces de travail et d'autres groupes. Les groupes sont listés avant les espaces de travail, chacun trié par nom.
- Les Espaces de travail affichent leur dossier racine comme description, ou Aucun dossier racine. Survolez un espace de travail pour voir son dossier racine, sa langue et, à partir de TIA Portal V20, le nombre d'objets qui lui sont connectés.
- Double-cliquez sur un espace de travail pour ouvrir son État de l'espace de travail.
Les objets connectés eux-mêmes ne sont pas des lignes de l'arborescence, car leur état change à chaque modification. Vous les voyez dans l'état de l'espace de travail.
La branche est lue lorsque vous cliquez dessus ou la dépliez, comme Hardware, HMI et la bibliothèque de projet : jusque-là, le dossier affiche une petite icône de chargement. Si vous souhaitez qu'elle soit lue dès que le projet se connecte, activez Charger les espaces de travail de contrôle de version sous Explorateur de projet dans les paramètres. Actualiser dans l'Explorateur de projet relit la branche avec le reste de l'arborescence.
Toutes les entrées relatives aux espaces de travail se trouvent dans le sous-menu Espaces de travail de contrôle de version du menu contextuel.
Créer et gérer des espaces de travail
Nouvel espace de travail
- Cliquez avec le bouton droit sur Espaces de travail de contrôle de version ou sur un groupe et choisissez New Workspace.... Sur un groupe, l'espace de travail est placé dans ce groupe ; depuis la palette de commandes, il est placé au niveau supérieur
- Saisissez le nom. Les noms d'espaces de travail sont uniques dans tout le projet, y compris entre les groupes, et peuvent compter jusqu'à 128 caractères, sans barre oblique, barre oblique inverse ni caractère de contrôle
- Choisissez le dossier racine de l'espace de travail. La boîte de dialogue s'ouvre dans le dossier du projet TIA Portal, comme TIA Portal le propose ; si vous choisissez le dossier du projet lui-même, Studio utilise un sous-dossier portant le nom de l'espace de travail, afin que les fichiers ne se retrouvent jamais à côté du fichier de projet. Tout autre dossier existant convient également
- À partir de TIA Portal V18, choisissez la langue des fichiers : Langue d'édition du projet, ou Other Language... puis saisissez un code de langue tel que
de-DE. La langue doit être active dans le projet et ne peut plus être modifiée par la suite - Le message confirme le nouvel espace de travail avec son dossier racine, et la nouvelle ligne est sélectionnée
À partir de TIA Portal V18, un petit dossier .vci apparaît dans le dossier racine ; TIA Portal y conserve les paramètres de l'espace de travail. Plusieurs espaces de travail peuvent partager un même dossier racine.
Nouveau groupe
Cliquez avec le bouton droit sur Espaces de travail de contrôle de version ou sur un groupe et choisissez New Group..., puis saisissez le nom. Les noms de groupes sont uniques au sein de leur groupe parent.
Renommer
Renommer sur un groupe ou un espace de travail demande le nouveau nom. Un état de l'espace de travail ouvert suit l'espace de travail sous son nouveau nom.
Supprimer
Supprimer confirme d'abord et dit ce qui part :
- Supprimer un espace de travail retire l'espace de travail et les connexions de ses objets. Les objets restent dans le projet, et les fichiers ainsi que le dossier
.vcirestent dans le dossier racine sur le disque. Confirmez avec Supprimer l'espace de travail - Supprimer un groupe retire tous les espaces de travail et tous les groupes qu'il contient, avec leurs connexions. Les objets restent dans le projet et les fichiers restent sur le disque. Confirmez avec Supprimer le groupe et les espaces de travail
Le message indique combien de connexions ont été retirées. L'état de l'espace de travail d'un espace de travail supprimé se ferme s'il est ouvert.
Définir le dossier racine
Set Root Folder... sur un espace de travail choisit un autre dossier racine. Lorsque l'espace de travail a un dossier racine, vous pouvez aussi, à partir de TIA Portal V20, choisir Supprimer le dossier racine : l'espace de travail conserve ses connexions mais n'a plus de dossier jusqu'à ce que vous en définissiez un à nouveau. Connecter et exporter nécessitent un dossier racine.
Paramètres d'importation de bibliothèque
À partir de TIA Portal V20, Library Import Settings... sur un espace de travail définit comment les types de bibliothèque de cet espace de travail sont repris dans le projet :
- Choose Global Library for Type Imports... sélectionne le fichier de bibliothèque globale dans lequel vont les types de bibliothèque importés, et Supprimer la bibliothèque globale pour l'importation de types l'efface à nouveau
- Supprimer les versions de type inutilisées après une importation ou Conserver les versions de type inutilisées après une importation décide de ce qu'il advient des versions de type qui ne sont plus utilisées après une importation
L'en-tête de l'état de l'espace de travail affiche les deux paramètres.
Afficher le dossier de l'espace de travail
Afficher le dossier de l'espace de travail ouvre le dossier racine dans l'explorateur de fichiers Windows. Si vous ouvrez ce dossier dans Studio comme un dossier à vous, le contrôle de source intégré de Studio prend en charge les fichiers, et vous pouvez les committer, les comparer et les pousser comme n'importe quels autres fichiers ; voir Client Git.
Placer des objets dans un espace de travail
Il existe deux façons d'amener un objet dans un espace de travail. Connect to Workspace... relie des objets à des fichiers qui existent déjà dans le dossier, par exemple après avoir cloné un dépôt. Export to Workspace... écrit les fichiers à partir du projet et les relie en une seule étape. Les deux nécessitent TIA Portal V20 ou plus récent.
Cliquez avec le bouton droit sur une ou plusieurs de ces lignes, ou sur un dossier qui les contient, et ouvrez le sous-menu Espaces de travail de contrôle de version :
- blocs (FB, FC, OB, DB, blocs de sécurité inclus)
- types de données PLC
- tables de variables PLC
- objets technologiques
- les dossiers Blocs de programme, un groupe de blocs, Types de données PLC, Variables PLC et Objets technologiques ; un dossier représente les objets qu'il contient
Les types de la bibliothèque de projet sont conservés dans un espace de travail par l'intermédiaire de l'assistant, voir Prise en charge par l'assistant IA.
Exporter vers l'espace de travail
- Choisissez Export to Workspace...
- Sélectionnez l'espace de travail. Si le projet n'en a encore aucun, Studio propose New Workspace... ; un espace de travail sans dossier racine vous demande d'abord d'en définir un
- Choisissez le format de fichier (voir ci-dessous)
- Saisissez le dossier sous le dossier racine qui reçoit les fichiers, par exemple
Blocks\Main, ou laissez le champ vide pour écrire dans le dossier racine. Un dossier manquant est créé. Un chemin complet ou..n'est pas accepté - Choisissez Conserver la structure des dossiers du projet (la valeur par défaut, comme dans TIA Portal : sous ce dossier, les fichiers vont dans des sous-dossiers qui reproduisent les groupes de blocs du projet, par exemple
Blocks\Functions\fbAgitator.scl) ou Placer tous les fichiers dans ce dossier - Confirmez avec Exporter. TIA Portal écrit un fichier par objet et y connecte l'objet. Un fichier portant le même nom dans le même dossier est écrasé
Connecter à l'espace de travail
- Choisissez Connect to Workspace...
- Sélectionnez l'espace de travail et le format de fichier, comme pour une exportation
- Choisissez le dossier qui contient les fichiers. La boîte de dialogue de dossier s'ouvre sur le dossier racine, et le dossier doit être le dossier racine ou se trouver en dessous
- Indiquez si les fichiers se trouvent dans des sous-dossiers qui reproduisent les groupes de blocs du projet (par défaut) ou tous dans ce dossier
- Chaque objet est connecté au fichier portant son nom dans le dossier correspondant. Les fichiers doivent déjà exister ; rien n'est écrit
Formats de fichier
Avant le choix du format, Studio demande à TIA Portal quels formats chaque objet prend en charge. Les objets que TIA Portal ne peut pas conserver dans un espace de travail sont signalés comme non pris en charge. La sélection propose Format préféré de chaque objet et chaque format proposé par TIA Portal, chacun avec le nombre d'objets auxquels il s'applique ; les objets qui ne proposent pas le format choisi utilisent leur format préféré.
Bloc SCL
- Formats proposés par TIA Portal
- SCL, SimaticML, SimaticSD
- Fichier
-
.sclou.xml
Bloc LAD ou FBD, OB, bloc de sécurité
- Formats proposés par TIA Portal
- SimaticML, SimaticSD
- Fichier
-
.xml
Bloc STL
- Formats proposés par TIA Portal
- AWL, SimaticML
- Fichier
-
.awlou.xml
Bloc de données
- Formats proposés par TIA Portal
- DB, SimaticML, SimaticSD
- Fichier
-
.dbou.xml
Type de données PLC
- Formats proposés par TIA Portal
- UDT, SimaticML, SimaticSD
- Fichier
-
.udtou.xml
Table de variables PLC, objet technologique
- Formats proposés par TIA Portal
- SimaticML
- Fichier
-
.xml
Format préféré de chaque objet prend SCL lorsqu'il est proposé, sinon SimaticML, sinon SimaticSD, sinon le premier format proposé par TIA Portal. Un type de bibliothèque est écrit sous forme de trois fichiers : sa source et deux petits fichiers de description dont TIA Portal a besoin pour le relire.
Le résultat
Un message résume l'opération, par exemple 12 objets sur 14 exportés vers l'espace de travail "Station_A"., indique combien étaient déjà identiques des deux côtés et nomme chaque objet qui n'a pas été traité, avec la raison : un objet que TIA Portal ne peut pas conserver dans un espace de travail, un format que l'objet ne propose pas, un fichier manquant, un fichier déjà connecté, un fichier en lecture seule, un bloc protégé par know-how ou, sous TIA Portal V21, un objet qui doit d'abord être compilé. Lorsqu'un objet a échoué, le message est un avertissement et propose Ouvrir l'état de l'espace de travail.
L'état de l'espace de travail
Ouvrir l'état de l'espace de travail sur un espace de travail, un double-clic sur sa ligne ou le bouton du message d'exportation ouvre un onglet par espace de travail. Il affiche l'état de chaque objet connecté.
En-tête. L'espace de travail et son groupe, le dossier racine, la langue des fichiers et le commentaire de l'espace de travail s'il en a un ; à partir de TIA Portal V20, également la bibliothèque globale pour l'importation de types et l'indication de la suppression ou non des versions de type inutilisées après une importation.
Résumé. Le nombre d'objets connectés et combien se trouvent dans chaque état.
Tableau. Une ligne par objet connecté avec une case à cocher, l'Objet (sa place dans le projet), le Fichier (son chemin sous le dossier racine), le Format, l'État et, en cas de conflit, les boutons Résoudre. Sélectionner tous les objets dans l'en-tête du tableau coche toutes les lignes.
| État | Signification |
|---|---|
| Identique | L'objet dans le projet et son fichier ont le même contenu |
| Projet modifié | L'objet a été modifié dans le projet. Exportez-le pour écrire la modification dans le fichier |
| Fichier modifié | Le fichier a été modifié en dehors de TIA Portal, par exemple par un pull depuis Git. Importez-le pour reprendre la modification dans le projet |
| Modifiés des deux côtés | L'objet et son fichier ont tous deux été modifiés. Choisissez le côté qui l'emporte ; l'autre côté est écrasé |
| Fichier manquant | Le fichier est absent du dossier de l'espace de travail. Exportez l'objet pour réécrire le fichier |
| Inconnu | TIA Portal n'a pas pu déterminer l'état. Actualisez pour le relire |
La barre d'outils propose :
- Actualiser demande à TIA Portal l'état actuel de chaque objet connecté
- Exporter la sélection vers l'espace de travail écrit dans leurs fichiers les objets cochés qui ont été modifiés dans le projet ou dont le fichier est manquant. Les autres lignes cochées sont ignorées
- Importer la sélection depuis l'espace de travail reprend dans le projet les fichiers cochés qui ont été modifiés dans le dossier. Il demande toujours confirmation, Importer ... objets de l'espace de travail "..." dans le projet ?, car TIA Portal remplace chaque objet du projet par le contenu de son fichier. Enregistrez le projet auparavant si vous voulez garder un moyen de revenir en arrière. Confirmez avec Importer
- Déconnecter retire la connexion des objets cochés après confirmation. Les objets restent dans le projet et leurs fichiers restent dans le dossier
TIA Portal lit les fichiers d'un espace de travail tels quels, sans les mettre en forme au préalable. Si vous modifiez des fichiers SCL d'un espace de travail dans Studio, exécutez Mettre en forme le document avant de les importer, afin qu'ils arrivent dans la mise en page TIA Portal avec les valeurs de la section Mise en forme SCL des paramètres.
Modifiés des deux côtés. Un objet modifié des deux côtés ne fait jamais partie d'une exportation ou d'une importation de la sélection. Décidez plutôt dans sa ligne :
- Conserver la version du projet écrit la version du projet dans le fichier ; les modifications du fichier sont perdues. Confirmez avec Écraser le fichier
- Conserver la version du fichier importe le fichier dans le projet ; les modifications apportées dans le projet sont perdues. Confirmez avec Écraser l'objet du projet
Éditeurs ouverts. Un bloc, un type de données ou une table de variables ouvert dans un éditeur de Studio pendant que vous importez son fichier affiche immédiatement le contenu importé. Un éditeur contenant des modifications non enregistrées conserve votre texte ; lorsque vous l'enregistrez, Studio vous signale que le projet contient une version plus récente et vous laisse décider.
Objets identiques. Un objet identique des deux côtés ne peut pas être synchronisé ; TIA Portal le refuse, et Studio indique qu'il n'y a rien à synchroniser.
Enregistrer un bloc connecté dans Studio. Lorsque vous ouvrez un bloc connecté depuis l'Explorateur de projet, le modifiez et l'enregistrez, le bloc reste connecté : Studio compile l'automate du bloc enregistré, conserve sa connexion et écrit immédiatement la version enregistrée dans son fichier du dossier de l'espace de travail, si bien que la ligne reste Identique. Un message nomme le fichier écrit. Si le fichier n'a pas pu être écrit, par exemple parce qu'il est en lecture seule, un avertissement vous demande d'exporter l'objet depuis l'état de l'espace de travail avant d'importer quoi que ce soit, car l'espace de travail l'afficherait sinon comme Fichier modifié.
Fichiers en lecture seule. Si votre système de contrôle de version garde les fichiers en lecture seule jusqu'à ce que vous les extrayiez, une exportation dans un tel fichier est refusée. Rendez le fichier accessible en écriture, par exemple en l'extrayant, puis réessayez.
Après chaque action, le pied de page affiche l'opération en cours, un message résume le résultat et nomme chaque objet qui n'a pas été traité, et la vue relit l'état. Lorsque les fichiers du dossier changent pendant que l'onglet est ouvert, par exemple après un pull, la bannière Les fichiers du dossier de l'espace de travail ont changé. Cliquez sur Actualiser pour lire l'état actuel. apparaît ; la vue n'interroge jamais TIA Portal d'elle-même.
Lorsqu'aucun objet n'est encore connecté, la vue vous invite à utiliser Connecter à l'espace de travail ou Exporter vers l'espace de travail dans l'Explorateur de projet.
Un flux de travail typique avec Git
- Créez un espace de travail dont le dossier racine est le dossier de votre dépôt, ou un dossier qu'il contient
- Sélectionnez le dossier Blocs de programme et le dossier Types de données PLC, puis lancez Export to Workspace...
- Committez les fichiers avec Git, dans le contrôle de code source de Studio ou dans tout autre client
- Après un pull, ouvrez l'État de l'espace de travail : les objets dont les fichiers sont arrivés modifiés affichent Fichier modifié. Cochez-les et lancez Importer la sélection depuis l'espace de travail
- Après avoir travaillé dans TIA Portal, les objets modifiés affichent Projet modifié. Exportez-les et committez à nouveau
Ce que fait TIA Portal
- TIA Portal écrit un fichier par objet, nommé d'après l'objet, et, à partir de TIA Portal V18, un dossier
.vcicontenant les paramètres de l'espace de travail dans le dossier racine - Une exportation vers un fichier de même nom qui n'est pas encore connecté écrase ce fichier sans demander ; la confirmation de Studio le signale avant que vous ne commenciez
- Les deux sens écrasent l'autre côté : une exportation remplace le fichier, une importation remplace l'objet dans le projet. Studio demande confirmation avant chaque importation et avant de résoudre un conflit
- Un objet identique des deux côtés ne peut pas être synchronisé
- Supprimer un espace de travail ou un groupe, ou déconnecter des objets, ne supprime jamais de fichiers et ne modifie jamais les objets du projet
- Les espaces de travail sont enregistrés avec le projet
Limitations connues
- Connecter, exporter, l'état et la synchronisation nécessitent TIA Portal V20 ou plus récent. De V17 à V19, les espaces de travail peuvent seulement être gérés
- Le contenu des Software Units n'est pas couvert : les blocs, types de données PLC et tables de variables d'une Software Unit ne peuvent pas être connectés ni exportés depuis Studio, et un objet d'une Software Unit connecté dans TIA Portal lui-même apparaît dans l'état de l'espace de travail sans son type
- TIA Portal propose le format SimaticML pour les objets technologiques, mais peut refuser d'en exporter un ; le message nomme l'objet et la raison donnée par TIA Portal
- Sous TIA Portal V21, un objet non compilé ne peut pas être exporté ; compilez-le dans le projet et réessayez
- L'importation d'un fichier de type de bibliothèque modifié n'est pas proposée sous TIA Portal V20, car elle fermerait TIA Portal. Importez-le avec TIA Portal V21 ou plus récent. L'exportation de types de bibliothèque fonctionne sur les deux
- La langue d'un espace de travail est choisie une seule fois, lors de sa création
- La disponibilité de l'interface de contrôle de version dépend de la version et de la mise à jour de TIA Portal installées
Prise en charge par l'assistant IA
L'assistant accède aux espaces de travail via l'outil Gérer les espaces de travail de contrôle de version TIA. Il liste les groupes et les espaces de travail, lit l'état d'un espace de travail et les formats de fichier des objets, crée, modifie et supprime des espaces de travail et des groupes (un nouvel espace de travail peut se trouver dans le dossier du projet TIA Portal connecté, dans votre dossier Documents ou Bureau, dans le dossier d'exportation ou dans un dossier ouvert), connecte des objets à des fichiers existants, exporte des objets dans un espace de travail (vous pouvez nommer un dossier entier de l'Explorateur de projet, comme Blocs de programme ou un groupe de blocs, et les fichiers conservent la structure des dossiers du projet, sauf si vous demandez un dossier à plat ; un dossier racine qui n'existe pas encore est créé après votre accord), les déconnecte et synchronise dans le sens que vous demandez. Par exemple : « Quels espaces de travail le projet contient-il ? », « Exportez tous les blocs de PLC1 dans l'espace de travail StationA, dossier Blocks » ou « Reprenez les fichiers modifiés de Station_A dans le projet ».
Lister et lire l'état ne modifient rien et s'exécutent sans demander. Avant toute autre action, l'assistant vous montre une carte indiquant ce qu'il va faire, et ne l'exécute qu'après votre accord : la carte d'une importation indique que TIA Portal remplace les objets du projet, celle d'une exportation que le contenu précédent de chaque fichier est perdu à moins que votre système de contrôle de version ne le conserve, et celle d'une suppression ce qui est retiré et que les fichiers restent. Un objet modifié des deux côtés n'est touché que si vous le nommez et indiquez quel côté l'emporte. Ensuite, l'assistant signale chaque objet qui n'a pas été traité, avec la raison. L'outil nécessite le forfait Pro. Pour savoir comment le chat IA accède aux outils, voir Intégration IA.