カスタムアクティビティの作成方法

CatToolsでカスタムアクティビティを作成するための簡易ガイド

ここではCatToolsでカスタムアクティビティを作成する手順を説明します。

CatTools のGUIにカスタムアクティビティタイプが表示されるようになるまで

の手順とカスタムメインスクリプトファイルおよびカスタムクライアントスク リプとアクティビティファイルの作成方法およびカスタムアクティビティをデ バイスタイプに適用可能にする方法についても、その概要を説明します。

2008  Kiwi Enterprises

CatToolsにはカスタムアクティビティのテンプレートファイルが付属しており、

本書でも使用されています。このテンプレートはCisco製ルーターのシンプルな バージョンレポートを作成するためのものです。スクリプトファイル(.txt およ び.custom)を作成したら、特定のアクティビティやレポートに合わせてこれらを 修正する必要があります。

カスタムアクティビティタイプファイル(.ini)、カスタムアクティビティメインス クリプトファイル(.txt)、カスタムアクティビティクライアントスクリプトファイ ル(.txt)、カスタムアクティビティデバイススクリプトファイル(.custom)、

CatTools の内部関数やサブプロシージャを作成したアクティビティスクリプト

で使用するためのct.コードおよびcl.コード例等についての詳細は、本章に記載 されている関連ページを参照してください。

カスタムアクティビティの作成手順

1) カスタムアクティビティタイプファイル(.ini)を作成します。

CatTools の ル ー ト デ ィ レ ク ト リ の 下 の¥Templates フ ォ ル ダ 内 に あ る Custom.Activity.Template.ini というファイルをコピーし、¥Activities フォルダの 下に保存します。このとき次の形式で新しいファイル名を付けます。

Custom.Type.Name  (例 Custom.Report.Version) 2) .iniファイルを編集します。

メモ帳などのテキストファイルエディターで先ほど作成した.ini ファイルを開き ます。.ini ファイルに書かれているテンプレートのデフォルト値を以下のように 書き換えます。

[Activity]

name=Custom.Activity.Template

script_main=Main.Custom.Activity.Template.txt script_client=Client.Custom.Activity.Template.txt

report_file=%AppPath%Reports¥Master Custom Activity Template.txt id=3999

name の 項 目 を 重 複 し な い 固 有 の ア ク テ ィ ビ テ ィ 名 に 変 更 し ま す 。 例:Custom.Report.PortStatus. 注意：スペースを入れず、ピリオド(.)で区切って ください。

script_main項目を関連付けられているメインスクリプトファイル名(「Main.」で

始まる重複しない固有のアクティビティ名)に変更します。

2008  Kiwi Enterprises

script_client の項目を関連付けられているクライアントスクリプトファイル名

(「Client.」で始まる重複しない固有のアクティビティ名)に変更します。

report_fileの項目を重複しない固有のレポート名に変更します。

idの項目を重複しない固有の番号(他のアクティビティの.iniファイルでも使用し ていない番号)に変更します。4000〜4999までの番号を使用してください。

3) 保存し、再起動します。

.ini ファイルの編集が終わったら、¥Activities フォルダに保存してファイルを閉 じます。CatToolsを再起動すると、アクティビティの設定画面の[Type]ドロップ ダウンリストに新しいカスタムアクティビティタイプが表示されます。

4) カスタムアクティビティメインスクリプトファイル(.txt)を作成します。

CatTools の ル ー ト デ ィ レ ク ト リ の 下 の¥Templates フ ォ ル ダ 内 に あ る Main.Custom.Activity.Template.txtというファイルをコピーし、¥Scriptsフォルダ の下に保存します。このとき、2)でアクティビティタイプ.iniファイルの[Activity]

のscript_mainに入力した値と同じ名前を付けてファイルを保存してください。

ファイルの拡張子は必ず.txtにしてください。

5) メインスクリプト.txtファイルを編集します。

テキストファイルエディター*を使って4)で作成した.txtファイルを開きます。開 いたファイルの「SCRIPT NOTES」の項に記載されている手順に従って、作成 したアクティビティに応じてスクリプトをカスタマイズしてください。

6) メインスクリプト.txtファイルを保存します。

メインスクリプト.txtファイルの編集が終わったら、¥Scriptフォルダに保存して ファイルを閉じます。

7) カスタムアクティビティクライアントスクリプトファイル(.txt)を作成します。

CatTools の ル ー ト デ ィ レ ク ト リ の 下 の¥Templates フ ォ ル ダ 内 に あ る Client.Custom.Activity.Template.txt というファイルをコピーし、¥Scripts フォル ダの下に保存します。このとき、2)でアクティビティタイプ.ini ファイルの [Activity]の script_client に入力した値と同じ名前を付けてファイルを保存してく ださい。ファイルの拡張子は必ず.txtにしてください。

8) クライアントスクリプト.txtファイルを編集します。

テキストファイルエディター*を使って7)で作成した.txtファイルを開きます。開 いたファイルの「SCRIPT NOTES」の項に記載されている手順に従って、作成 したアクティビティに応じてスクリプトをカスタマイズしてください。

2008  Kiwi Enterprises 9) クライアントスクリプト.txtファイルを保存します。

クライアントスクリプト.txtファイルの編集が終わったら、¥Scriptフォルダに保 存してファイルを閉じます。

10) カスタムアクティビティデバイススクリプトファイル(.custom)を作成しま す。

CatTools の ル ー ト デ ィ レ ク ト リ の 下 の¥Templates フ ォ ル ダ 内 に あ る Custom.Device.Template.txt.customというファイルをコピーし、¥Scriptsフォル ダの下に保存します。このとき、関連付けられている暗号化済みデバイススクリ プトファイル(またはカスタムデバイススクリプトファイル)と同じ名前を付け、

ファイル拡張子.txt とさらに.custom という拡張子を付けてファイルを保存する 必要があります。

例：(Cisco製ルーター用のカスタムアクティビティデバイススクリプトファイル

を作成する場合)

CatTools付属のCisco製ルーター用暗号化済みスクリプトファイル:

Cisco.Router.General.txt

作成するカスタムアクティビティデバイススクリプトファイルの名前:

Custom.Cisco.General.txt.custom

11) デバイススクリプト.customファイルを編集します。

テキストファイルエディター*を使って10)で作成した.customファイルを開きま す。開いたファイルの「SCRIPT NOTES」の項に記載されている手順に従って、

ご使用のデバイスに応じてスクリプトをカスタマイズしてください。カスタムア クティビティを.customデバイスファイルに追加する方法については「カスタム アクティビティデバイススクリプトファイル(.custom)」の項を参照してください。

12) デバイススクリプト.customファイルを保存します。

デバイススクリプト.customファイルの編集が終わったら、¥Scriptフォルダに保 存してファイルを閉じます。

13) 作成したカスタムアクティビティスクリプトをテストします。

全てのカスタムアクティビティスクリプトおよびデバイス.custom スクリプト ファイルの設定が終わったら、CatToolsで作成した.customファイルに関連付け られているデバイスを使って新しいアクティビティを実行し、正常に動作するか どうかを確認してください。カスタムアクティビティのテストは開始タイマーを 使って行うのではなく、[Run Now]ボタンを使って手動で行ってください。

2008  Kiwi Enterprises

[Info Log]ペインでエラーを確認し、必要であれば作成した.txtファイルと.custom

ファイルを編集します。

詳細については「カスタムアクティビティのテスト」の項を参照してください。

カスタムアクティビティの作成方法の確認

• アクティビティタイプファイル(.ini)を作成する。

• アクティビティメインスクリプトファイル(.txt)を作成する。

• アクティビティクライアントスクリプトファイル(.txt)を作成する。

• アクティビティデバイススクリプトファイル(.custom)を作成する。

(*注記：.txt ファイルはメモ帳を使って開くこともできますが、構文がハイライ

ト表示されるようなスクリプトエディターを使ったほうが .txt ファイルの編集 作業が楽になります。)