Altium NEXUSでスクリプトを実行する方法

Altium NEXUS のスクリプト機能は、Altium NEXUS 向けに高度な自動化タスクを作成する手段を提供しますが、作成したスクリプトは設計プロセス中に簡単にアクセスできる必要もあります。たとえば、PCB 編集中に複雑な一連の操作を実行するために作成したスクリプトは、PCB エディタ自体からすぐに利用でき、マウスクリック 1～2 回で実行できるのが理想です。

Altium NEXUS では、スクリプトをプロセス ランチャーに割り当てることでこの要件に対応しており、結果としてメニュー、ツールバー、ショートカットに割り当て可能なコマンドとして扱えるようになります。

スクリプトの実行

簡単におさらいすると、スクリプト エディタで開いている場合、スクリプトはエディタの Run コマンドで実行できます。これはスクリプト プロジェクトを Altium NEXUS で開いている必要があり、たとえば PCB 設計プロセス中に必要なスクリプトへアクセスする方法としては便利とは言えません。代替として、Select Item To Run ダイアログ（File » Run Script）を使用すると、ローカル ハードドライブ上、または接続された Altium Server 上のスクリプトを参照して、目的のプロセスを実行できます。スクリプトは現在のセッションの間ロードされたままになります。

Select Item to Run ダイアログからスクリプト プロセス ランチャーを使用してスクリプトを実行。

頻繁に使用するスクリプトへアクセスするより適した方法は、Preferences dialog の Scripting System – Global Projects ページからプロジェクトを Global Project としてインストールすることです。この場合、Altium NEXUS の起動時にプロジェクトが自動的にロードされ、File » Run Script コマンドからいつでも実行できます。

ただし、スクリプトの機能へアクセスする理想的な方法は、メニューやツールバーのコマンドとして Altium NEXUS の GUI に統合することです。通常これは 2 段階の手順になります。まずスクリプトをコマンド（必要に応じてショートカット付き）として実装し、その後そのコマンドをメニュー（固定またはポップアップ）またはツールバーに割り当てます。

コマンドとしてのスクリプト

スクリプトは、Altium NEXUS に組み込まれているサーバー プロセス、より具体的には ScriptingSystem:RunScript プロセスを利用することで、アプリケーション コマンドとして実装できます。

コマンドは実行されるアクションを表し、パッケージ化されたプロセス ランチャーを介してプロセス文字列によってサポートされます。ScriptingSystem:RunScript プロセスの場合、特定のスクリプト プロジェクト ファイル、構成要素であるスクリプト ファイル（*.pas）、およびそのスクリプト内のプロセスを指し示すためのパラメータが含まれます。適切に構成すると、これらの要素がコマンド文字列を構成します。

この方法の利点は、スクリプトをプロセスとして実行することで、スクリプトを直接開いたり、Global Project としてロードしたりする必要がない点です。さらに重要な 2 つ目の利点は、プロセス方式でスクリプトを実行すると、アクセスしやすい Altium NEXUS のコマンドとして実装できる点です。これは Altium NEXUS のメニュー システムをカスタマイズすることで行い、スクリプトを、指定したサーバー（ファイル システムや設計ドキュメント エディタなどのサブアプリケーション）向けのコマンドに割り当てます。

コマンドの作成

たとえば HelloWorld スクリプトを PCB エディタ用のコマンドとして割り当てるには、まず PCB ドキュメント（つまりエディタ）を開き、メイン メニューから View » Tools » Customize を選択して Customizing PCB Editor dialog を開きます。このダイアログは、メニュー バーまたはツールバーを右クリックしてドロップダウン メニューから Customize を選ぶか、メニュー バーまたはツールバーの空白領域（コマンドから離れた場所）をダブルクリックしても開けます。

新しいコマンドを作成するには、ダイアログの New ボタンをクリックして Edit Command dialog を開き、サーバー プロセスとスクリプト パスの詳細を入力します。スクリプトからコマンドを作成する際は、[Scripts] カテゴリが選択されていないことを確認してください。ダイアログの Action の入力は次の形式になります。
Process: ScriptingSystem:RunScript
Parameters: ProjectName|ProcName>Process

スクリプトへのソース パスに応じて、Parameters 文字列は次のようになります。
ProjectName=C:\Users\Public\Documents\Altium\Delphiscript Scripts\General\HelloWorld.PRJSCR|ProcName=HelloWorld.pas>HelloWorld

このダイアログには、コマンドのキャプション、説明、ショートカット、関連付けるビットマップ画像（BMP/GIF/PNG、18 x 18 ピクセル）の入力欄もあります。これらの設定はコマンドとともに保存され、メニュー、ツールバー、ポップアップに挿入されるすべての箇所に適用されます。詳細は以下の Assigning Menu Commands セクションを参照してください。

詳細を入力して編集ダイアログを閉じる（）と、HelloWorld スクリプトは PCB エディタ用の Custom コマンド（[Custom] 配下）として利用可能になります。

外部アプリケーション コマンド

Microsoft Notepad のような外部アプリケーションは、ソフトウェア制御により Altium NEXUS から起動できます。この場合、コマンドの process と parameters の入力は次のようになります。

Process: ScriptingSystem:RunScriptText
Parameters: Text=Begin RunApplication('notepad.exe'); End;

この場合のソフトウェア プロセス ScriptingSystem:RunScriptText は、上で説明したように特定のスクリプト ファイルを開いて実行するのではなく、文字どおり一連のスクリプト文を実行します。

別の方法として、同等の数行のコードを持つスクリプトを作成し、通常の ScriptingSystem:RunScript コマンド エントリを作成することもできます。

Procedure RunNotepad;
Begin
    RunApplication('notepad.exe');
End;

外部 Notepad コマンドを実装するどちらの方法でも、RunApplication のパラメータとしては、アプリケーションのフルパスとファイル名を指定する代わりに 'notepad.exe を入力するだけで十分である点に注意してください。電卓や Notepad などの Windows アプリケーションは、OS によってパスがすでに指定されています。

Windows の既定パスを持たないアプリケーションを Altium NEXUS から起動するには、アプリケーションのフルパスとファイル名を指定する必要があります（パスに空白が含まれる可能性に備え、シングルクォートで囲みます）。たとえば Altium NEXUS の 2 つ目のコピーを起動する場合、RunApplication プロセスと parameters は次のようになります。

RunApplication('C:\Program Files\Altium\xx\X2.EXE')（xx は Altium NEXUS のバージョン フォルダ名を表します）。

メニュー コマンドの割り当て

上記で説明したように、Altium NEXUS の Customizing 機能（View » Toolbars » Customize）を通じてスクリプトをカスタム サーバー コマンドとして実装したら、簡単なドラッグ＆ドロップ操作でサーバー GUI に割り当てられます。

► 関連項目 Customizing the Design Space

ツールバー

たとえば PCB エディタのメイン メニューや Toolbar メニューにカスタム コマンドを割り当てるには、Customizing PCB Editor ダイアログを開き、カスタム コマンドを見つけて目的のメニュー位置へドラッグします。PCB エディタのメニューにアクセスするには PCB ドキュメントを開いている必要がある点に注意してください。カスタマイズ ダイアログを閉じると、新しいメニュー コマンドは PCB エディタでいつでも利用できます。

カスタム コマンドは、必要なメニュー位置へドラッグできます。

この例では新しいカスタム コマンドが PCB Active Bar に割り当てられているため、Customizing PCB Editor ダイアログの PCB Active Bar コマンド カテゴリ配下に表示されます。

メニューに割り当てると、カスタム スクリプト コマンドはカスタマイズ ダイアログ内でそのメニューのカテゴリ配下に表示されます。

メニューからコマンドを削除するには、カスタム ダイアログを開き、メニュー コマンドのアイコンをダイアログへドラッグして戻します。

ツールバーに割り当てられたコマンドの削除。

メニュー

カスタム コマンドは、上記で説明したのと同じドラッグ＆ドロップ操作で、任意のメニュー階層のメニューに割り当てられます。

サーバーがカスタマイズ モードの間、メニューはマウス ポインタに反応し続け、必要に応じて展開／折りたたみされます。たとえば PCB エディタの Reports メニューにコマンドを配置するには、コマンドをメニュー内へドラッグし、リストを下へたどって適切な位置にドロップします。カスタマイズ ダイアログを閉じると、新しいメニュー コマンド（ここでは Notepad）は Reports メニュー内からアクセスできます。

カスタマイズ中はメニューがアクティブになり、カスタム コマンドをドロップダウン メニューへドラッグして配置できます。

ポップアップ メニュー

コマンドは、上記と同様の方法で右クリックのポップアップ メニューにも割り当てられ、サブメニュー階層の深さによる制限はありません。

この例では、コマンドを PCB Popups » Right Mouse Click Free Space のメニュー パスに沿ってドラッグし、下図のようにサブメニューへドロップしています。割り当て後、カスタム Notepad スクリプト コマンドは、PCB エディタで空き領域を右クリックしたときに利用できるようになります。

右クリック サブメニューに割り当てられたカスタム コマンド

スクリプトの直接割り当て

スクリプトから再利用可能なカスタム コマンドを作成してメニューに割り当てる代わりに、簡易的な一回限りの方法として、スクリプトをメニューに直接適用することもできます。

この方法では、ロード済みのスクリプトをメニューに直接割り当てることで、カスタム コマンド作成の手順を省略します。複数のメニューに対して完全に構成されたコマンドとして適用できる、対応するカスタム コマンドが存在しないため、この直接方式はスクリプトのメニュー アクセスとして単発の解決策になります。そのため、Caption、Description、Image、Shortcuts などの各種コマンド設定は、割り当てたそのインスタンスにのみ適用されます。

スクリプトをメニューに直接割り当てるには、スクリプトプロジェクトを読み込み、サーバーのCustomizing ダイアログ（View » Toolbars » Customize）を開きます。Categories リストで [Scripts] を選択し、目的のスクリプトを見つけてメニュー上の配置したい位置へドラッグします。 をクリックして Edit Commandダイアログを閉じます。

コマンドではなくスクリプトを、メニューに直接割り当てることもできます。

他のメニュー配置と同様に、新しいメニュー項目がまだ既定の設定（キャプション名、ショートカットなど）のままの場合は、メニュー項目を右クリックしてサブメニューからEdit を選択し、修正できます。これによりEdit Commandダイアログが開き、適切な設定を入力できます。

カスタマイズモードでは、メニューを右クリックしてパラメータにアクセスします。

設定が完了すると、新しいメニューは設計時に利用可能になり、以後スクリプトプロジェクトを明示的に読み込んだり、Global Project としてインストールしたりする必要はありません。

この方法でスクリプトをメニューに適用すると、必要なコマンドが自動的に作成される点に注意してください。これは上記の方法で説明したような、再割り当て可能で完全に設定されたカスタムコマンドではなく、そのメニュー項目に直接紐づくために作成されるコマンドです。

これはCustomizing ダイアログ内の実際のメニューカテゴリ項目で確認できます。上記の例では、個別に設定されたコマンドはCustomizing PCB EditorダイアログのReportsカテゴリに表示されます。

スクリプトをメニューに直接適用する場合、対応するコマンドはそのメニュー項目のためだけに作成されます。