【テクニカル・上級編】【初心者向け】カスタムフィールドの値をプロジェクトのプロパティとして保存・復元する – Project VBA解析バイブル

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

【極限の知見】MS Projectにおける状態(State)の永続化:カスタムフィールドのメタデータ化とメモリ制御の真髄

プロジェクト管理の現場において、Microsoft Projectは単なるガントチャート作成ツールではない。それは、複雑な計算ロジック、リソース制約、そして膨大な「一時的な計算状態」を内包する、極めて重厚なステートフル・アプリケーションである。

シニアエンジニアやシステム管理者が直面する真の課題は、「どうやってカスタムフィールドに値を書き込むか」ではない。「計算によって導き出された一時的な状態(State)を、いかにプロジェクトの本体(Task/Resource Object)から切り離し、副作用を最小限に抑えつつ、軽量なメタデータとしてファイルに封印するか」である。

本稿では、カスタムフィールドの値をプロジェクトの「カスタムドキュメントプロパティ」へとシリアライズ(直列化)し、プロジェクトの構造を汚さずに状態を保存・復元する、堅牢なアーキテクチャを解説する。

1. 概念設計:なぜカスタムフィールドに直接保存してはいけないのか

多くの開発者は、計算結果をそのまま `Task.Text1` や `Task.Number1` といったカスタムフィールドに書き込み、それを「バックアップ」として扱う。しかし、これはアーキテクチャとして極めて脆弱である。

1. 再計算の連鎖(Recalculation Cascade): MS Projectのエンジンは、カスタムフィールドの値が変更されると、プロジェクト全体の再計算をトリガーする場合がある。数千タスク規模のプロジェクトでは、このオーバーヘッドが致命的なパフォーマンス低下を招く。
2. データ汚染(Data Pollution): カスタムフィールドは、ユーザーがUI上で直接編集可能な領域である。バックアップとして利用している値が、ユーザーの誤操作によって書き換えられるリスクを排除できない。
3. オブジェクトの責務: カスタックフィールドは「表示・計算用」の属性であり、システムの「状態保存用(Persistence)」として設計されていない。

我々が目指すべきは、「計算結果はカスタムフィールドに一時的に保持するが、永続化する際は、プロジェクトのプロパティ(CustomDocumentProperties)という、オブジェクトモデルの背後にあるメタデータ層へ退避させる」という設計である。

2. 実装:State Manager プロトタイプ

以下に、カスタムフィールドの値を抽出し、プロジェクトのプロパティへシリアライズする、実戦的なコードを示す。ここでは、メモリ管理とエラーハンドリングに一切の妥協を許さない。

Option Explicit

' ==============================================================================
' Module: ProjectStateManager
' Description: カスタムフィールドの状態をプロジェクトプロパティへ保存・復元する
' Author: Legendary Chief Architect
' ==============================================================================

' 定数定義:マジックナンバーを避け、保守性を確保する
Private Const PROP_PREFIX As String = "SYS_STATE_"
Private Const ERR_PREFIX As String = "ERR_STATE_"

''' <summary>
''' 指定されたカスタムフィールドの値を、プロジェクトのカスタムドキュメントプロパティに保存する。
''' </summary>
''' <param name="app">MS Project Application Object</param>
''' <param name="fieldName">保存対象のカスタムフィールド名 (例: "Text1")</param>
Public Sub SaveCustomFieldToProperty(ByRef app As MSProject.Application, ByVal fieldName As String)
    On Error GoTo ErrorHandler

    Dim proj As MSProject.Project
    Set proj = app.ActiveProject
    
    ' オブジェクトの存在確認(防御的プログラミング)
    If proj Is Nothing Then Err.Raise vbObjectError + 513, "StateManager", "ActiveProject is null."

    Dim t As MSProject.Task
    Dim stateBuffer As String
    stateBuffer = ""

    ' 1. データの集約 (Aggregation Phase)
    ' 注意: 大規模プロジェクトでは、このループがボトルネックになる。
    ' 可能な限り、計算エンジンを停止させた状態で実行すべきである。
    For Each t In proj.Tasks
        If Not t Is Nothing Then
            ' タスクの存在を確認し、値を連結(簡易的なCSV形式でシリアライズ)
            ' 本来はJSON等の構造化データが望ましいが、レガシー環境との互換性を考慮
            stateBuffer = stateBuffer & t.ID & ":" & t.Text1 & "|"
        End If
    Next t

    ' 2. メタデータへの書き込み (Persistence Phase)
    ' プロパティの存在確認と作成/更新
    Dim propName As String
    propName = PROP_PREFIX & fieldName

    On Error Resume Next
    Dim prop As MSProject.CustomDocumentProperty
    Set prop = proj.CustomDocumentProperties(propName)
    On Error GoTo ErrorHandler

    If prop Is Nothing Then
        ' プロパティが存在しない場合は新規作成
        proj.CustomDocumentProperties.Add Name:=propName, _
                                         LinkToContent:=False, _
                                         Type:=msoPropertyTypeString, _
                                         Value:=stateBuffer
    Else
        ' 既存プロパティの更新
        prop.Value = stateBuffer
    End If

    Debug.Print "Successfully serialized " & fieldName & " to property " & propName
    
CleanUp:
    ' 3. 明示的なメモリ解放 (Explicit Memory Management)
    ' COMオブジェクトのライフサイクルを制御し、メモリリークを防止する
    Set proj = Nothing
    Exit Sub

ErrorHandler:
    Debug.Print ERR_PREFIX & "SaveCustomFieldToProperty: " & Err.Description
    Resume CleanUp
End Sub

''' <summary>
''' プロパティから保存された値を読み込み、カスタムフィールドへ復元する。
''' </summary>
Public Sub RestoreCustomFieldFromProperty(ByRef app As MSProject.Application, ByVal fieldName As String)
    On Error GoTo ErrorHandler

    Dim proj As MSProject.Project
    Set proj = app.ActiveProject
    
    Dim propName As String
    propName = PROP_PREFIX & fieldName

    ' プロパティの存在確認
    Dim propValue As String
    On Error Resume Next
    propValue = proj.CustomDocumentProperties(propName).Value
    If Err.Number <> 0 Then
        MsgBox "No saved state found for " & fieldName, vbExclamation
        Exit Sub
    End If
    On Error GoTo ErrorHandler

    ' 1. データのデシリアライズ (Deserialization Phase)
    Dim pairs() As String
    pairs = Split(propValue, "|")

    Dim pair As Variant
    Dim elements() As String
    Dim targetID As Long
    Dim targetVal As String
    Dim targetTask As MSProject.Task

    ' 2. プロジェクトへの反映 (Application Phase)
    For Each pair In pairs
        If pair <> "" Then
            elements = Split(pair, ":")
            If UBound(elements) = 1 Then
                targetID = CLng(elements(0))
                targetVal = elements(1)
                
                ' タスクの取得と値のセット
                Set targetTask = proj.Tasks(targetID)
                If Not targetTask Is Nothing Then
                    targetTask.Text1 = targetVal
                End If
                Set targetTask = Nothing ' ループ内でのオブジェクト解放
            End If
        End If
    Next pair

    Debug.Print "Successfully restored " & fieldName
    
CleanUp:
    Set proj = Nothing
    Exit Sub

ErrorHandler:
    Debug.Print ERR_PREFIX & "RestoreCustomFieldFromProperty: " & Err.Description
    Resume CleanUp
End Sub

3. アーキテクトの視点:パフォーマンスと堅牢性を支える知見

このコードは単なる「動くコード」ではない。エンタープライズ・レジリエンス(企業の回復力)を考慮した設計となっている。

メモリ管理の厳格化

VBAにおけるCOM(Component Object Model)操作において、最も忌避すべきは「参照カウントの放置」である。特に `For Each t In proj.Tasks` のような巨大なコレクションを回す際、ループ内で取得した `Task` オブジェクトを `Set targetTask = Nothing` で明示的に解放しなければ、メモリ使用量は指数関数的に増大し、MS Projectのクラッシュを招く。

データのシリアライズ戦略

本実装では、`ID:Value|` という簡易的なデリミタ形式を採用している。

  • なぜJSONではないのか?: Windows APIやレガシーなVBA環境において、外部ライブラリ(JSON Parser等)の導入は、配布の容易性を著しく損なう。
  • なぜIDを使うのか?: Taskの「名前」は重複しうるし、変更されうる。しかし、`ID` はプロジェクト内での一意性を保証する(※ただし、タスクの削除・挿入には注意が必要である。より厳格なシステムでは、内部的な `Unique ID` を使用すべきである)。

エラーハンドリングの階層化

`On Error GoTo ErrorHandler` は、単にエラーを無視するためではなく、「不完全な状態のままプロセスを続行させない」ために存在する。特に、プロパティの書き込み失敗時に、中途半端なデータがプロジェクトに残ることを防ぐための `CleanUp` への強制遷移は、データ整合性を守るための鉄則である。

結論

カスタムフィールドを「計算の作業場」として使い、カスタムドキュメントプロパティを「情報の金庫」として使う。この分離こそが、MS Projectという複雑なシステムを制御下に置くための、エンジニアリングの第一歩である。

次なるステップは、このシリアライズされたデータを、外部のSQL ServerやJSONファイルへとエクスポートし、プロジェクト間の差分分析(Differential Analysis)を行う高度な自動化へと進むことだ。

「コードを書くのではない。システムを設計せよ。」

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