【テクニカル・上級編】【中級】ステンシル内のマスターシェイプに「独自のメタデータ」をVBAで付与する – Visio VBA解析バイブル

スポンサーリンク
スポンサーリンク

Visio Metadata Engineering: Master Shapesへの不可逆的なメタデータ注入とスキーマ管理の極意

図面とは、単なる視覚的な表現ではない。エンタープライズ・アーキテクチャにおける図面とは、「視覚化されたデータモデル」である。

多くの開発者は、Visioを「綺麗な図を描くためのツール」と誤解している。しかし、真のシステムアーキテクトにとって、Visioは構造化データを格納し、その整合性を視覚的に担保するための「グラフィカルなデータベース」だ。

本稿では、配布用ステンシル内の「マスターシェイプ」に対して、VBAを用いてプログラム的にカスタムプロパティ(Shape Data)を定義し、初期値を埋め込む手法について解説する。単なるプロパティの追加ではない。オブジェクトのライフサイクル、メモリ管理、そして再利用可能なデータスキーマの構築という、プロフェッショナルが直面する実戦的な課題に焦点を当てる。

1. アーキテクチャの設計思想:InstanceではなくMasterを制御せよ

初学者が犯す最大の過ちは、キャンバス上に配置された「Shape(インスタンス)」に対してメタデータを付与しようとすることだ。それでは、設計図そのものの定義が書き換わらない。

我々が制御すべきは、ステンシル(`.vssx`)の中に格納されている「Master(マスターシェイプ)」である。マスターに対してメタデータ(Shape Data Section)を定義することで、そのマスターから生成されるすべてのインスタンスは、自動的に同一のデータスキーマを継承する。これが、エンタープライズ規模でのデータ整合性を保つための唯一の解である。

制御すべきオブジェクト階層

1. Application: Visio実行環境
2. Document (Stencil): メタデータの定義を保持するコンテナ
3. Master: データのスキーマ(構造)を定義するテンプレート
4. ShapeData Section: マスター内のShapeSheetにおけるデータ格納領域

2. 実装の核心:Idempotency(冪等性)を担保したプロパティ注入

ステンシルへの操作は、破壊的な変更を伴う。一度実行したコードを再度走らせた際に、同じプロパティが二重に作成されるような設計は、レガシーな、質の低いコードの典型である。

プロフェッショナルな実装には、「セクションの存在確認」と「行の重複チェック」という、冪等性(Idempotency)を確保するためのロジックが不可欠だ。

実装コード:Masterへのカスタムプロパティ注入エンジン

'***
' Module: MetadataEngine
' Description: マスターシェイプに構造化されたメタデータを注入する
' Author: Chief Architect
'***

Option Explicit

' 定数定義:マジックナンバーを排除し、保守性を高める
Private Const SECTION_CUSTOMER_PROPERTIES As Long = 12 ' visSectionCustomerProperties

''' <summary>
''' 指定したマスターシェイプに対し、カスタムプロパティ(Shape Data)を定義する。
''' </summary>
''' <param name="master">操作対象のMasterオブジェクト</param>
''' <param name="propName">追加するプロパティ名</param>
''' <param name="defaultValue">初期値</param>
Public Sub InjectMetadataToMaster(ByRef master As Visio.Master, _
                                 ByVal propName As String, _
                                 ByVal defaultValue As String)
    
    Dim shapeSection As Visio.ShapeSection
    Dim targetRow As Visio.ShapeRow
    Dim cell As Visio.Cell
    Dim i As Long
    Dim rowExists As Boolean
    
    On Error GoTo ErrorHandler

    ' 1. ShapeDataセクション(Customer Properties)の存在確認と取得
    ' セクションが存在しない場合は新規作成する
    On Error Resume Next
    Set shapeSection = master.Drop(master.Application.Documents.Item(1).Shapes.Item(1)) ' ダミー操作回避のため
    ' 正しくは以下のようにセクションを取得を試みる
    Set shapeSection = master.Section(SECTION_CUSTOMER_PROPERTIES)
    
    If Err.Number <> 0 Then
        ' セクションが存在しない場合は追加
        master.AddSection SECTION_CUSTOMER_PROPERTIES, visSectionAddAfter
        Set shapeSection = master.Section(SECTION_CUSTOMER_PROPERTIES)
        Err.Clear
    End If
    On Error GoTo ErrorHandler

    ' 2. 冪等性の確保:既に同名のプロパティが存在するか走査
    rowExists = False
    For i = 1 To shapeSection.RowCount
        ' プロパティ名は ShapeSheet のラベルに相当する
        ' ここでは簡略化のため、行のラベルをチェックするロジックを想定
        If shapeSection.Row(i).Label = propName Then
            rowExists = True
            Set targetRow = shapeSection.Row(i)
            Exit For
        End If
    Next i

    ' 3. プロパティの追加または更新
    If Not rowExists Then
        ' 新規行の追加
        Set targetRow = shapeSection.Add(visSectionAddLast)
        targetRow.Label = propName
    End If

    ' 4. 値の注入(ShapeSheetへのFormula書き込み)
    ' 文字列を注入する場合、ShapeSheetの構文ルールに従いダブルクォーテーションで囲む必要がある
    ' 例: "Value" -> """Value"""
    Set cell = targetRow.CellsC(visSectionCustomerProperties, 1) ' LabelではなくValueセルを指定
    cell.Formula = """" & defaultValue & """"

    Debug.Print "Successfully injected: " & propName & " = " & defaultValue

CleanUp:
    ' 明示的なオブジェクト解放は、ループ内や大量のオブジェクトを扱う際に極めて重要
    Set cell = Nothing
    Set targetRow = Nothing
    Set shapeSection = Nothing
    Exit Sub

ErrorHandler:
    Debug.Print "Critical Error in InjectMetadataToMaster: " & Err.Description
    Resume CleanUp
End Sub

''' <summary>
''' エントリポイント:ステンシル内の全マスターに対してスキーマを適用する
''' </summary>
Public Sub ApplySchemaToStencil(ByVal stencilPath As String)
    Dim vApp As Visio.Application
    Dim vDoc As Visio.Document
    Dim vMaster As Visio.Master
    
    Set vApp = Visio.Application
    
    ' 1. ステンシルの読み込み
    ' 既存のステンシルを開く。ReadOnlyモードでの読み込みは避ける(書き込みが必要なため)
    On Error Resume Next
    Set vDoc = vApp.Documents.Open(stencilPath)
    If vDoc Is Nothing Then
        Msg.Critical "ステンシルファイルが見つかりません: " & stencilPath
        Exit Sub
    End If
    On Error GoTo 0

    ' 2. 全マスターの走査
    ' マスターの変更は、ドキュメント(ステンシル)全体の変更となる
    For Each vMaster In vDoc.Masters
        ' 特定のマスターのみを対象とするフィルタリング(例:名前による判定)
        If InStr(1, vMaster.Name, "Network_Device", vbTextCompare) > 0 Then
            ' 独自のメタデータスキーマを注入
            InjectMetadataToMaster vMaster, "Device_ID", "UNASSIGNED"
            InjectMetadataToMaster vMaster, "Firmware_Ver", "1.0.0"
            InjectMetadataToMaster vMaster, "Criticality", "Low"
        End If
    Next vMaster

    ' 3. 変更の保存
    ' 重要なのは、メモリ上の変更を物理ファイルにコミットすること
    vDoc.Save
    Debug.Print "Schema application completed and saved."

CleanUp:
    ' COMオブジェクトのライフサイクル管理
    ' 大規模な自動化では、これを行わないとVisioプロセスがメモリに居座り続ける
    Set vMaster = Nothing
    Set vDoc = Nothing
    Set vApp = Nothing
End Sub

3. 深層解説:エンジニアが意識すべき3つの技術的境界

3.1. ShapeSheetの構文規則と文字列の「三連引用符」

VBAから`Cell.Formula`に文字列を書き込む際、最も多くのエンジニアが躓くのが、`”””Value”””`という記述だ。Visioの内部エンジンであるShapeSheetは、式(Formula)を評価する。文字列リテラルとして認識させるには、`”Value”`という形式でセルに書き込む必要がある。VBAの文字列内でダブルクォーテーションをエスケープするには、2つ重ねる必要があるため、結果として3つ(あるいはそれ以上)の引用符が必要になる。この挙動を理解していないと、実行時エラーではなく「不正な式」としてサイレントに失敗する。

3.2. メモリ管理とCOMオブジェクトのリーク

Visio VBAはCOM(Component Object Model)の上で動作している。`Set obj = Nothing`を怠ると、たとえプロシージャが終了しても、Visioのバックグラウンドプロセス(`visio.exe`)がメモリを保持し続ける。特に、ステンシルをループで開き、大量のマスターを操作するスクリプトでは、メモリリークが指数関数的に増大し、システム全体のパフォーマンスを低下させる。
プロフェッショナルは、「オブジェクトのスコープを最小限に抑え、明示的に解放する」という原則を徹底しなければならない。

3.3. システム間連携への布石:メタデータの活用

なぜマスターにメタデータを埋め込むのか? それは、Visioを「データソース」に変えるためだ。
一度マスターにスキーマが定義されれば、後続のプロセス(Pythonによる解析、Excelへのエクスポート、あるいはカスタムアドインによるDB同期)において、以下のような操作が極めて容易になる。

  • `Shape.DataRecord` を参照し、図面内の全デバイスのファームウェアバージョンを一括抽出する。
  • 特定の`Criticality`を持つシェイプのみを、自動的に赤色に変更する。

これは、図面を「絵」から「構造化された資産」へと昇華させる行為である。

4. 結論

ステンシル内のマスターシェイプにメタデータを注入する技術は、単なる自動化のテクニックではない。それは、図面という非構造的な表現形式に対し、プログラムによる「規律(Discipline)」をもたらすエンジニアリングである。

冪等性を保ち、メモリを管理し、ShapeSheetの仕様を完全に掌握すること。これらを通じて初めて、あなたはVisioを単なる描画ツールから、エンタープライズ・アーキテクチャの強力な武器へと変貌させることができるのだ。

タイトルとURLをコピーしました