作ったマクロを配る仕組み——「メール添付」から卒業する配布設計
12月は1年で作ったマクロを整理する季節だ。そこで必ず出てくるのが「どの版が最新か分からない」問題。原因はほぼ1つ、メール添付で配っているからだ。作ったマクロをどう配り、どう更新するか。私たちが数百本規模の運用で固めた配布設計を、実装例付きで書く。
Photo: Unsplash「メール添付で配布」が生む事故
CATIAマクロの配布方法を聞くと、いまだに一番多い答えがメール添付だ。作った人が完成版をメールで送り、受け取った人が各自のデスクトップに保存する。この瞬間から、マクロは管理不能になる。誰がどの版を使っているか、作った本人にも分からなくなる。
実害は更新のときに出る。不具合を直して新版を送っても、全員が差し替えるとは限らない。半年前の版で作業した成果物が混ざり、しかもどの成果物が古い版によるものか特定できない。図面チェック系のマクロでこれが起きると、チェック済みのはずの図面を全部疑う羽目になる。
配布は開発の後始末ではない。配布の仕組みまで含めて1つのツールだと私たちは考えている。半分の完成度でも配布が固ければ現場は回るが、完璧なマクロでも配布が壊れていれば事故になる。
理想形は「置き場所は1つ、取りに行くのは自動」
私たちの配布設計の原則は単純だ。マクロの正本はファイルサーバーの1か所にだけ置く。利用者のPCにあるのは作業用のコピーで、起動のたびにサーバーの版と突き合わせ、違っていれば自動で最新化する。人間は何も覚えなくていい。
利用者に配るのはランチャーだけだ。ランチャーはバージョン照合と同期だけを行い、実行は最新化されたローカル側で行う。サーバーから直接実行しない理由は2つ。ネットワーク越しの実行は遅く、そしてサーバー障害時に全員が止まるからだ。
この方式なら更新作業は「サーバーのフォルダを差し替えて版番号を上げる」だけで終わる。利用者への周知メールも、差し替え依頼も要らない。翌朝には全員が新版で動いている。
導入は4ステップで終わる
手順を整理する。第1に、共有サーバーに配布フォルダを作り、マクロ本体と版番号を書いたテキストファイルを置く。版番号は日付形式が扱いやすい。第2に、バージョン照合と同期を行うランチャーを作る。後述のコードが最小構成だ。
第3に、利用者のCATIAにはランチャーだけを登録してもらう。ツールバーのボタンにするなら、割り当てるのはランチャー1つでいい。第4に、更新手順書を作る。といっても内容は、新しいフォルダをサーバーに置いて版番号ファイルを書き換える、の2行で済む。
ポイントは、利用者側の手順を初回の1回だけにすることだ。2回目以降の更新で利用者に何かをさせる設計は、必ずどこかで守られなくなる。人の記憶に頼る運用を最初から捨てる。これも自働化の一部だ。
完璧なマクロでも、
配布が壊れていれば事故になる。
メール添付とサーバー配布、何が違うか
両者の差は配布の手間ではなく、事故率に出る。メール添付では版の不一致が構造的に発生するのに対し、サーバー同期では起動のたびに照合されるため、古い版が使われ続ける経路が存在しない。事故対応で失う時間まで含めれば、比較にならない。
更新の所要時間も違う。メール添付では送信、受信者ごとの差し替え、未対応者への催促まで含めて数日がかりになる。サーバー配布ならフォルダ差し替えの5分で全員に行き渡る。配布頻度を上げられるので、小さな改善をためらわず出せるようになる。
唯一の弱点はサーバーに依存することだが、照合できないときはローカル版をそのまま使う設計にすれば、サーバー停止時も業務は止まらない。この逃げ道の設計まで含めて配布設計だ。
最小構成のランチャー実装
実装例を示す。サーバー側の版番号ファイルとローカルの版番号を比べ、違えばフォルダごと同期してから本体マクロを実行する。エラー時はローカル版で続行する。この30行弱が、メール添付の全事故を消してくれる。
実運用ではこれに実行ログの記録を足している。誰がいつどの版を実行したかをサーバー側に1行追記するだけで、不具合調査のときに「どの版で起きたか」が即座に特定できる。ログは配布設計の保険だ。
版番号の比較を等号で行っている点にも意図がある。大小比較にすると、検証のためにサーバーを一時的に旧版へ戻す運用ができなくなる。サーバーにある版が常に正、という単純なルールのほうが運用は壊れない。
運用前の最終チェック
最後に、運用開始前に確認すべき項目をチェックリストにまとめた。特に見落としやすいのは書き込み権限だ。配布フォルダは利用者に読み取り専用で公開する。書き込み可のまま公開すると、善意の手直しが正本を壊す事故がいつか起きる。
配布の仕組みは一度作れば全マクロで使い回せる。年内にこの土台を作っておけば、来年作るマクロは全部この上に載る。マクロ資産が増えるほど、この投資は効いてくる。
同じような自働化を検討中でしたら、一度話を聞かせてください。ヒアリングと自働化設計書の提案までは無料で行っています。使えるものが無ければ、無いとお伝えします。
' サーバーの版番号と照合し、違えば同期してから本体を実行する
Option Explicit
Const SERVER_DIR As String = "\\fileserver\cad_tools\release\"
Const LOCAL_DIR As String = "C:\CATTools\"
Const VER_FILE As String = "version.txt"
Sub CATMain()
Dim fso As Object, srvVer As String, locVer As String
Set fso = CreateObject("Scripting.FileSystemObject")
On Error Resume Next
srvVer = ReadText(fso, SERVER_DIR & VER_FILE) ' サーバー側の版
locVer = ReadText(fso, LOCAL_DIR & VER_FILE) ' ローカルの版
On Error GoTo 0
' 照合できて版が違うときだけフォルダごと同期する
If Len(srvVer) > 0 And srvVer <> locVer Then
If Not fso.FolderExists(LOCAL_DIR) Then fso.CreateFolder LOCAL_DIR
fso.CopyFolder SERVER_DIR & "*", LOCAL_DIR, True
End If
' サーバー不通時はローカル版のまま続行(業務を止めない)
' 最新化されたローカル側の本体マクロを実行する
CATIA.SystemService.ExecuteScript _
LOCAL_DIR, catScriptLibraryTypeDirectory, _
"MainTool.catvba", "CATMain", Array()
End Sub
Private Function ReadText(fso As Object, path As String) As String
ReadText = Trim$(fso.OpenTextFile(path, 1).ReadAll)
End Function