Aller au contenu

Aide

Vérifier une maquette à partir d’un dossier surveillé

Le programme local BIMgravity surveille un dossier sur votre ordinateur. Quand une nouvelle maquette d’un corps de métier y arrive, le programme la vérifie et consigne l’exécution, sans que personne soit devant l’écran.

Qui peut le faire
Les propriétaires et les gestionnaires créent la clé API. Toute personne peut ensuite lancer le programme sur l’ordinateur qui contient le dossier.

Avant de commencer

Il vous faut Node.js 20 ou plus récent sur cet ordinateur, les fichiers du programme BIMgravity et un dossier qui reçoit déjà les maquettes (un dossier de projet synchronisé convient).

  1. Dans BIMgravity, ouvrez Réglages, l’onglet Intégrations, puis Clés API, et créez une clé. Nommez-la d’après l’ordinateur qui exécutera le programme. Copiez la clé maintenant : elle ne s’affiche qu’une fois.
  2. Sur cet ordinateur, placez la clé dans la variable d’environnement BIMGRAVITY_API_KEY. Ne l’écrivez pas dans un fichier du dossier surveillé et ne la tapez pas sur la ligne de commande : elle resterait dans l’historique des commandes.
  3. Ouvrez un terminal et lancez le programme sur le dossier. Donnez le projet et le corps de métier auxquels le dossier appartient : bimgravity watch "C:\Projects\Riverside\Mechanical" --project "Riverside Medical Office Building" --trade "Mechanical"
  4. Laissez le programme tourner. Copiez une maquette (.ifc) dans le dossier, ou laissez votre outil de synchronisation en apporter une.
  5. Lisez la ligne que le programme affiche pour le fichier. recorded signifie que l’exécution est enregistrée, avec le score de chaque vérification.
  6. Dans BIMgravity, ouvrez la Bibliothèque. L’exécution est listée avec les autres.

Ce que vous devriez voir

Une ligne au démarrage du programme : « watching » avec le dossier, le projet, le corps de métier et le jeu de règles. Une ligne quand un fichier est repéré : « new file; waiting until it stops changing ». Puis une ligne avec le résultat : recorded RMOB_M_Mechanical_v4.ifc data 85.9 % · code data 93.9 % · handover 79.5 % · run 6f1c…

Comment un dossier correspond à un projet et à un corps de métier

De deux façons. Les options de la ligne de commande l’emportent.

  • Les options : --project et --trade, comme à l’étape 3.
  • Un petit fichier nommé bimgravity.json dans le dossier : { "project": "Riverside Medical Office Building", "trade": "Mechanical", "profile": { "occupancy": "B", "sprinklered": true, "codeEdition": "IBC2021", "phase": "construction", "authoringTool": "revit", "units": "imperial" } } Avec --recursive, chaque sous-dossier peut avoir son propre fichier. Une maquette utilise le fichier le plus proche au-dessus d’elle. Un dossier de projet peut alors contenir un sous-dossier par corps de métier.

Le projet et le corps de métier sont enregistrés avec l’exécution sous forme de simples noms. Donnez l’identifiant du projet au lieu de son nom (affiché sur la page du projet dans l’affichage expert) : chaque vérification applique alors aussi les exigences approuvées du projet et compare la maquette à ses documents, comme une vérification dans le navigateur. La ligne du journal ajoute alors les nombres : concorde, diffère, non comparable.

Ce que le programme fait de chaque fichier

  • Il attend que le fichier cesse de changer. Les outils de synchronisation écrivent un fichier par morceaux. Utilisez --settle 15 si votre outil est lent.
  • Il vérifie un fichier à la fois.
  • Il vérifie une maquette une seule fois. Une copie sous un autre nom n’est pas vérifiée de nouveau. Une nouvelle version du même nom l’est.
  • Il ignore les fichiers cachés et temporaires, et les fichiers qui ne sont pas .ifc.
  • Il ne suit jamais un lien qui sort du dossier et ne lit jamais un fichier de plus de 300 Mo.

Quand quelque chose ne va pas

Messages du programme local, leur sens et ce qu’il faut faire
La ligne ditCe que cela signifieCe qu’il faut faire
refused … is incompleteLe fichier s’arrête avant sa fin. Il est probablement encore en cours de copie.Rien. Le fichier complet est vérifié à son arrivée.
refused … holds no element to checkLe fichier contient un projet et des niveaux, mais aucun élément.Exportez de nouveau la maquette.
refused … is not an IFC modelLe fichier porte l’extension .ifc, mais c’est autre chose.Retirez-le.
refused … a text value longer than 4000 charactersUne propriété contient un texte très long. Il n’est pas envoyé.Raccourcissez la valeur dans l’outil de création.
locked … in use by another programUn autre programme tient le fichier.Rien. Le programme réessaie.
failed … will try once more, puis set-asideLe fichier n’a pas pu être lu deux fois.Exportez de nouveau la maquette. Le fichier n’est réessayé que s’il change.
waiting … trying again in 30 sLe serveur est injoignable ou occupé, ou votre firme n’a plus de vérifications pour le moment.Rien. La pause s’allonge jusqu’à 10 minutes et le fichier n’est pas perdu.
stopped … The API key was refusedLa clé est incorrecte ou a été révoquée.Créez une nouvelle clé et relancez le programme.

Rien n’est consigné pour un fichier refusé, qui n’a pas pu être lu ou qui est mis de côté.

Lancer le programme à l’ouverture de session Windows

Aucune installation n’est nécessaire : le Planificateur de tâches fait partie de Windows.

  1. Ouvrez le Planificateur de tâches et choisissez Créer une tâche.
  2. Sous Général, nommez-la « BIMgravity dossier surveillé ». Choisissez Exécuter uniquement si l’utilisateur est connecté.
  3. Sous Déclencheurs, ajoutez À l’ouverture de session pour votre utilisateur.
  4. Sous Actions, ajoutez Démarrer un programme. Programme : le chemin de node.exe. Arguments : le chemin de bimgravity.mjs, puis watch "C:\Projects\Riverside" --recursive.
  5. Définissez la clé une fois pour votre utilisateur, dans un terminal : setx BIMGRAVITY_API_KEY "votre clé". Définissez aussi BIMGRAVITY_URL avec l’adresse de BIMgravity. Fermez la session et rouvrez-la.

Pour vérifier selon un horaire plutôt qu’en continu, utilisez le déclencheur Quotidien, répété toutes les 15 minutes, et ajoutez --once aux arguments. Le programme vérifie alors ce qui est nouveau, puis se ferme.

Sur macOS ou Linux

Ajoutez une ligne à l’horaire de votre utilisateur avec crontab -e. La clé et l’adresse sont définies dans les lignes au-dessus : */15 * * * * /usr/local/bin/node /opt/bimgravity/bimgravity.mjs watch "/Users/me/Projects/Riverside" --recursive --once >> "$HOME/bimgravity-watch.log" 2>&1

Ce qui quitte votre ordinateur

Votre fichier de maquette ne quitte jamais votre ordinateur. Le nom du fichier, sa taille et les valeurs de propriétés dont les règles ont besoin sont envoyés pour la vérification. L’IA reçoit les résultats de la vérification, jamais votre maquette ni ses éléments.

Le programme envoie aussi les noms du projet et du corps de métier que vous lui avez donnés, ainsi qu’une empreinte du fichier (un nombre SHA-256 qui identifie le fichier sans en contenir rien). Il retient les maquettes déjà vérifiées dans un petit fichier rangé dans votre propre dossier de données d’utilisateur, pas dans le dossier surveillé : quiconque peut écrire dans ce dossier ne peut donc pas marquer une maquette comme vérifiée. Ce fichier ne contient jamais votre clé ni rien de l’intérieur d’une maquette.

Notes

Une vérification du dossier surveillé compte pour une vérification de votre forfait, comme une vérification depuis le navigateur. Si le programme ne tourne pas, rien n’est vérifié : ouvrez Vérifier une maquette et déposez plutôt le fichier dans le navigateur.