Skip to content
Etienne edited this page Jun 29, 2026 · 9 revisions

WIKI OF ARES

English :

List of commands (Key-in) and the ARES configuration variables each one uses.
Run a command with: macro vba run [ARES]CommandName
Set a variable in MicroStation's configuration variables (or via the Configuration commands below).

Update:

macro vba run [ARES]CheckForUpdate
Manually checks GitHub for a newer ARES release; bypasses the mute / ignore-version preferences.

  • ARES_Update_Mute (default: False) — when True, silences the automatic startup update check. Useful to stop recurring prompts. This key-in ignores it.
  • ARES_Update_Ignore_Version (default: empty) — a specific release the automatic check skips. This key-in ignores it.

Language:

macro vba run [ARES]English
Forces the ARES GUI to English.
macro vba run [ARES]Français
Forces the ARES GUI to French.

  • ARES_Language (default: empty) — language read by ARES. When empty, ARES falls back to MicroStation's CONNECTUSER_LANGUAGE (set by Bentley Connect with your account). The key-ins above set this variable; restart afterwards.

AutoLengths:

macro vba run [ARES]EditAutoLengthsOptions
Opens the AutoLengths options GUI (the place to configure the variables below).

  • ARES_Auto_Lengths (default: True) — master switch: enable automatic length insertion.
  • ARES_Update_Lengths (default: True) — recompute the length when the linked geometry changes (both this and ARES_Auto_Lengths must be True).
  • ARES_Length_Triggers (default: (Xx_m)) — trigger pattern(s) in the text where the length is written; multiple allowed, separated by | (e.g. (Xx_m)|(Xx_cm)).
  • ARES_Length_Trigger_ID (default: Xx_) — placeholder inside the trigger that gets replaced by the value. Must appear in every trigger.
  • ARES_Length_Round (default: 1) — decimal places for the inserted length.
  • ARES_Update_Color_With_Length (default: True) — also sync the text color to the linked geometry's color.
  • ARES_Only_Color_Update (default: True) — color-only mode: sync color without touching the length.
  • ARES_Update_ATLASCellLabel (default: True) — also rebuild ATLAS leader-label cell geometry after a text edit.
  • ARES_Cell_Is_Label_Name (default: ETI076|ETI01E|ETI01F|ETI01K|ETI01M|ETI01N|ETI01O) — cell names treated as ATLAS labels (| separated).

macro vba run [ARES]ForceUpdateLength
Manually pick an element and update the length string on its linked text. Uses the AutoLengths variables above (triggers, rounding, color).

Zoning:

macro vba run [ARES]EditZoningOptions
Opens the Zoning options GUI (the place to configure the variables below).

  • ARES_Zoning_Level (default: empty) — source level name(s) whose elements get buffered (| separated). Empty = nothing is processed.
  • ARES_Zoning_Distance (default: 2.0) — buffer distance in master units for RunZoning.
  • ARES_Zoning_Output_Level (default: ARES_Zoning) — level the generated zones are written to (also the level read by Zone Export).
  • ARES_Zoning_Output_Color (default: 5) — output color index.
  • ARES_Zoning_Output_Style (default: 0) — output line style.
  • ARES_Zoning_Output_Weight (default: 4) — output line weight.
  • ARES_Zoning2_Distance (default: 0.2) — buffer distance for RunZoning2.

macro vba run [ARES]RunZoning
Generates buffer zones around the source-level elements: distance from ARES_Zoning_Distance (2.0 m), rounded caps, all zones merged into one region.

macro vba run [ARES]RunZoning2
Tighter second pass: distance from ARES_Zoning2_Distance (0.2 m), flat (square) caps, per-element sub-zones fused but zones from different elements left unmerged.

Zone Export:

macro vba run [ARES]EditZoneExportOptions
Opens the Zone Export options GUI (the place to configure the variables below).

  • ARES_Zoning_Output_Level (default: ARES_Zoning) — the zone level whose polygons are used as export regions (shared with Zoning output).
  • ARES_Zone_Export_Group_By (default: Style) — grouping key for the exported rows: Style, Level, or Color.
  • ARES_Zone_Export_Round (default: 2) — decimal places for exported lengths.
  • ARES_Zone_Export_Use_Dialog (default: True) — True = prompt with a Save dialog; False = auto-generate a timestamped path next to the design file.
  • ARES_Zone_Export_Sheet_Name (default: Export) — worksheet tab name in the output workbook.
  • ARES_Zone_Export_Excel_Visible (default: False) — True = open the workbook in Excel after export; False = silent/headless export.

macro vba run [ARES]ExportLength
Computes each element's length (full or partial) lying inside the zone polygons on the zone level, aggregates by the chosen key, and writes a per-group summary to a new Excel workbook (.xlsx).

Region Split:

macro vba run [ARES]SplitRegion
Cuts a closed region (Shape / ComplexShape) into two with a single datapoint on its boundary: the cut runs perpendicular to the local edge across the interior. Both halves inherit the original's level + symbology.

  • ARES_RegionSplit_Keep_Original (default: False) — False = the original region is deleted after the two halves are written; True = it is kept alongside them.
  • ARES_RegionSplit_Collinear_Tol (default: 0.000001) — geometric epsilon (degenerate-segment / coincident-point threshold); also drives the cut-knife half-width.
  • ARES_RegionSplit_Stroke_Tol (default: 0.01) — max chordal deviation when densifying a curved boundary into a polyline; smaller = closer-to-radial cut on arcs.

Variable Management:

macro vba run [ARES]ResetARESVariables
Resets all ARES variables to their default values.

macro vba run [ARES]RemoveARESVariables
Removes all ARES variables.

Configuration Management:

macro vba run [ARES]ExportARESConfig
Exports the current ARES configuration to a file.

macro vba run [ARES]ImportARESConfig
Imports an ARES configuration from a file.

macro vba run [ARES]ShowARESConfigSummary
Displays a summary of the current configuration.

Testing:

macro vba run [ARES]RunARESTests
Runs all ARES unit tests.

macro vba run [ARES]RunARESPerformanceTests
Runs the ARES performance tests.

  • ARES_Unit_testing (default: I'm a ARES test unit variable) — sample variable exercised by the test suite.

Documentation:

macro vba run [ARES]OpenARESWiki
Opens this ARES wiki in the default browser.

Automatic behaviors (no key-in):

  • ARES_Bulk_Threshold (default: 10) / ARES_Bulk_Interval (default: 1000 ms) — bulk-operation detection: if this many change events occur within the interval, ARES auto-suspends change tracking (performance during merges/reprojections), then resumes when idle.
  • ARES_License_Recheck_Interval (default: 3600 s, range 60–86400) — how often the license is re-validated in the background; features shut down within one interval of a revocation.
Français :

Liste des commandes (Key-in) et des variables de configuration ARES utilisées par chacune.
Lancer une commande avec : macro vba run [ARES]NomDeCommande
Définir une variable dans les variables de configuration de MicroStation (ou via les commandes de Configuration plus bas).

Mise à jour :

macro vba run [ARES]CheckForUpdate
Vérifie manuellement sur GitHub si une nouvelle version d'ARES existe ; contourne les préférences mute / ignore-version.

  • ARES_Update_Mute (défaut : False) — si True, coupe la vérification automatique au démarrage. Utile pour stopper les rappels répétés. Ce key-in l'ignore.
  • ARES_Update_Ignore_Version (défaut : vide) — une version précise que la vérif automatique ignore. Ce key-in l'ignore.

Langue :

macro vba run [ARES]English
Force l'interface ARES en anglais.
macro vba run [ARES]Français
Force l'interface ARES en français.

  • ARES_Language (défaut : vide) — langue lue par ARES. Si vide, ARES se rabat sur CONNECTUSER_LANGUAGE de MicroStation (définie par Bentley Connect via votre compte). Les key-ins ci-dessus définissent cette variable ; redémarrer ensuite.

AutoLengths :

macro vba run [ARES]EditAutoLengthsOptions
Ouvre l'interface des options AutoLengths (où configurer les variables ci-dessous).

  • ARES_Auto_Lengths (défaut : True) — interrupteur principal : active l'insertion automatique de longueur.
  • ARES_Update_Lengths (défaut : True) — recalcule la longueur quand la géométrie liée change (ARES_Auto_Lengths et celle-ci doivent être True).
  • ARES_Length_Triggers (défaut : (Xx_m)) — motif(s) déclencheur(s) dans le texte où la longueur est écrite ; plusieurs possibles, séparés par | (ex. (Xx_m)|(Xx_cm)).
  • ARES_Length_Trigger_ID (défaut : Xx_) — marqueur dans le déclencheur remplacé par la valeur. Doit être présent dans chaque déclencheur.
  • ARES_Length_Round (défaut : 1) — décimales de la longueur insérée.
  • ARES_Update_Color_With_Length (défaut : True) — synchronise aussi la couleur du texte avec celle de la géométrie liée.
  • ARES_Only_Color_Update (défaut : True) — mode couleur seule : synchronise la couleur sans toucher à la longueur.
  • ARES_Update_ATLASCellLabel (défaut : True) — reconstruit aussi la géométrie des cellules-étiquettes ATLAS après édition du texte.
  • ARES_Cell_Is_Label_Name (défaut : ETI076|ETI01E|ETI01F|ETI01K|ETI01M|ETI01N|ETI01O) — noms de cellules traitées comme étiquettes ATLAS (séparés par |).

macro vba run [ARES]ForceUpdateLength
Sélectionne manuellement un élément et met à jour la chaîne de longueur sur son texte lié. Utilise les variables AutoLengths ci-dessus (déclencheurs, arrondi, couleur).

Zonage :

macro vba run [ARES]EditZoningOptions
Ouvre l'interface des options de zonage (où configurer les variables ci-dessous).

  • ARES_Zoning_Level (défaut : vide) — niveau(x) source dont les éléments sont bufferisés (séparés par |). Vide = rien n'est traité.
  • ARES_Zoning_Distance (défaut : 2.0) — distance de buffer (unités maître) pour RunZoning.
  • ARES_Zoning_Output_Level (défaut : ARES_Zoning) — niveau où les zones générées sont écrites (aussi le niveau lu par Zone Export).
  • ARES_Zoning_Output_Color (défaut : 5) — index de couleur de sortie.
  • ARES_Zoning_Output_Style (défaut : 0) — style de ligne de sortie.
  • ARES_Zoning_Output_Weight (défaut : 4) — épaisseur de ligne de sortie.
  • ARES_Zoning2_Distance (défaut : 0.2) — distance de buffer pour RunZoning2.

macro vba run [ARES]RunZoning
Génère des zones tampon autour des éléments des niveaux source : distance depuis ARES_Zoning_Distance (2.0 m), bouts arrondis, toutes les zones fusionnées en une région.

macro vba run [ARES]RunZoning2
Seconde passe plus serrée : distance depuis ARES_Zoning2_Distance (0.2 m), bouts plats (carrés), sous-zones d'un même élément fusionnées mais zones d'éléments différents non fusionnées.

Export de zone :

macro vba run [ARES]EditZoneExportOptions
Ouvre l'interface des options d'export de zone (où configurer les variables ci-dessous).

  • ARES_Zoning_Output_Level (défaut : ARES_Zoning) — niveau de zone dont les polygones servent de régions d'export (partagé avec la sortie du zonage).
  • ARES_Zone_Export_Group_By (défaut : Style) — clé de regroupement des lignes exportées : Style, Level ou Color.
  • ARES_Zone_Export_Round (défaut : 2) — décimales des longueurs exportées.
  • ARES_Zone_Export_Use_Dialog (défaut : True) — True = boîte de dialogue d'enregistrement ; False = chemin horodaté auto-généré à côté du fichier de dessin.
  • ARES_Zone_Export_Sheet_Name (défaut : Export) — nom de l'onglet dans le classeur de sortie.
  • ARES_Zone_Export_Excel_Visible (défaut : False) — True = ouvre le classeur dans Excel après export ; False = export silencieux.

macro vba run [ARES]ExportLength
Calcule la longueur (totale ou partielle) de chaque élément située à l'intérieur des polygones de zone du niveau de zone, agrège selon la clé choisie, et écrit un résumé par groupe dans un nouveau classeur Excel (.xlsx).

Découpe de région :

macro vba run [ARES]SplitRegion
Coupe une région fermée (Shape / ComplexShape) en deux avec un seul datapoint sur son bord : la coupe part perpendiculairement à l'arête locale à travers l'intérieur. Les deux moitiés héritent du niveau + symbologie de l'originale.

  • ARES_RegionSplit_Keep_Original (défaut : False) — False = la région d'origine est supprimée après écriture des deux moitiés ; True = elle est conservée à côté.
  • ARES_RegionSplit_Collinear_Tol (défaut : 0.000001) — epsilon géométrique (seuil segment dégénéré / points coïncidents) ; pilote aussi la demi-largeur du couteau de coupe.
  • ARES_RegionSplit_Stroke_Tol (défaut : 0.01) — déviation chordale max lors de la densification d'un bord courbe en polyligne ; plus petit = coupe plus proche du radial sur les arcs.

Gestion des variables :

macro vba run [ARES]ResetARESVariables
Remet toutes les variables ARES à leurs valeurs par défaut.

macro vba run [ARES]RemoveARESVariables
Supprime toutes les variables ARES.

Gestion de la configuration :

macro vba run [ARES]ExportARESConfig
Exporte la configuration ARES actuelle vers un fichier.

macro vba run [ARES]ImportARESConfig
Importe une configuration ARES depuis un fichier.

macro vba run [ARES]ShowARESConfigSummary
Affiche un résumé de la configuration actuelle.

Tests :

macro vba run [ARES]RunARESTests
Exécute tous les tests unitaires d'ARES.

macro vba run [ARES]RunARESPerformanceTests
Exécute les tests de performance d'ARES.

  • ARES_Unit_testing (défaut : I'm a ARES test unit variable) — variable d'exemple utilisée par la suite de tests.

Documentation :

macro vba run [ARES]OpenARESWiki
Ouvre ce wiki ARES dans le navigateur par défaut.

Comportements automatiques (sans key-in) :

  • ARES_Bulk_Threshold (défaut : 10) / ARES_Bulk_Interval (défaut : 1000 ms) — détection d'opérations en masse : si ce nombre d'événements de modification survient dans l'intervalle, ARES suspend automatiquement le suivi des modifications (performance lors des fusions/reprojections), puis reprend à l'inactivité.
  • ARES_License_Recheck_Interval (défaut : 3600 s, plage 60–86400) — fréquence de re-validation de la licence en arrière-plan ; les fonctionnalités s'arrêtent dans l'intervalle suivant une révocation.

Clone this wiki locally