カスタムアクティビティメインスクリプトファイル(.txt)

2008  Kiwi Enterprises

id=3999   4000〜49999 までの番号を入力してください。ここで入力する番号

は重複しない固有の番号でなければなりません。

# Activity options [item_value1]

name=Use alternate command type=string

checkbox_show=1 checkbox_default=0 edit_button=0 value_default=

required=0

info="Alternative command to capture data from device."

[item_value2]

必要に応じてオプションを追加してください(最大10個まで指定できます)

2008  Kiwi Enterprises

CatToolsにはカスタムアクティビティメインスクリプトを新しく作成する際に、

作成元として活用できるテンプレートファイルが付属しています。

テンプレートファイルの名前は Main.Custom.Activity.Template.txt で、CatTools のルートディレクトリの下の¥Templatesというフォルダの中にあります。

このテンプレートファイルは、CatToolsで予め定義されているアクティビティス クリプトの一部として付属しているものですが、暗号化はされていません。

CatTools のすべての定義済みアクティビティスクリプトファイルは、CatTools

製品の新バージョンが発行される際に随時(必要であれば)更新されます。このた め、新しくカスタムアクティビティメインスクリプトを作成する目的でテンプ レートファイル自体を変更することは絶対にしないでください。テンプレートを 元に新しいカスタムアクティビティメインスクリプトを作成する必要がある場 合は、テンプレートファイルをコピーして¥Scriptsフォルダに別の名前を付けて 保存するようにしてください。

カスタムアクティビティメインスクリプトファイル(.txt)の作成

CatToolsにカスタムアクティビティメインスクリプトを新しく追加するとき、最

初 に す る こ と は¥Templates フ ォ ル ダ の 下 に あ る テ ン プ レ ー ト フ ァ イ ル Main.Custom.Activity.Template.txt をコピーして¥Scripts フォルダの下に別の名 前を付けて保存することです。このとき、アクティビティタイプ.ini ファイルの [Activity]項目でscript_mainに指定したものと同じ名前で保存してください。

このファイルを作成元として新しいデバイススクリプトファイルを定義します。

メインスクリプトファイル(.txt)の編集

次に、カスタムメインスクリプト.txt ファイルを開き、必要であればご使用のデ バイスに合わせてスクリプトが動作するよう、各項目の値を変更します。

.txt ファイルには、変更する際の手順やヒントなど多くのコメントが書かれてい ますが、注意しなければならない重要な項目はいくつかしかなく、それらはスク リプトファイルの冒頭に書かれています。

スクリプトの1行目に次のように記述されていることがあります。

Attribute VB_Name = "Custom_Activity_Template"

これはVisual Basic(あるいは同等のスクリプト言語)開発環境で表示したときに、

そのカスタムアクティビティメインスクリプトファイルを示す Visual Basic モ

2008  Kiwi Enterprises ジュール名となります。この行はVB開発環境でファイルの編集を行っていると きは表示されませんが、他のエディターでは表示される場合があります。

"Custom_Activity_Template"はカスタムテンプレートファイルのモジュールに付 けられた名前です。カスタムアクティビティメインスクリプトファイルがたくさ んある場合は、この名前を作成したカスタムアクティビティメインスクリプトの ファイル名を反映した名前に変更するほうが良いこともあります。そのようにす ることによって、複数のカスタムアクティビティメインスクリプトファイルをご 使用の VB 開発環境で同時に(たとえば、1 つのプロジェクト内などで)開くこと ができるようになります。

スクリプトの編集にテキストベースのエディター(メモ帳など)を使用している場 合は、モジュール名の変更は任意で構いません。しかし、混乱を避けるには、こ の名前を変更しておいたほうが良いでしょう。

メモ:

--- SCRIPT NOTES ---

SCRIPT NOTESには、有用な情報とスクリプト作成の初期段階において実行す

べき作業について記載されています。ここに書かれている内容は必要に応じて適 宜書き換えて構いません。たとえば、スクリプト設定の初期に必要な作業を終え、

もう再びその作業をする必要がない場合、SCRIPT NOTESに記載されている、

それらに関するテキストを全部削除することができます。複雑なルーチンやスク リプト固有の振る舞いなど、デバイススクリプトの管理担当者にとって役立つ情 報はここに記載しておいてください。このような情報は完全なものである必要が あり、全文をここに記載するか、完全な情報が記載されている関連項目を参照先 として記載してください。

--- ACTIVITY NOTES ---

ACTIVITY NOTESには、デバイス固有の振る舞いや特殊な動作など、アクティ

ビティスクリプトの管理担当者にとって役立つ情報を記載します。

例: "The activity only works for Cisco IOS devices".

必須関数:

CatToolsがアクティビティを実行するために、カスタムアクティビティメインス

クリプト内で指定しなければならない必須関数は次の関数のみです。

2008  Kiwi Enterprises Function Main()

アクティビティメインスクリプトに独自の関数やサブルーチンを定義すること もできますが、それらはFunction Main()内から呼び出す必要があります。独自の 関数やサブルーチンにはコメントを必ず付けておき、後で自分自身や他の開発者 が見たときにその関数が何であるのか理解できるようにしておくことは大切で す。

スクリプトファイルの保存

作成したスクリプトファイルに CatTools がアクセスできるようにするには、ス クリプトファイルを¥Scriptsフォルダに保存する必要があります。

通常、スクリプトファイルのコードを変更した際にその変更部分を読み込むため

に CatTools を停止させ再起動する必要はないのですが、テスト時に変更部分が

認識されていないため余儀なく再起動しなければならないことも少なくありま せん。

カスタムアクティビティスクリプトのテスト

スクリプトの設定が終わったら、CatToolsで新しいアクティビティを既存のデバ イスを使って実行するよう設定し、正常に動作するかどうかをテストしてくださ い。

選択したデバイスには対応する.custom ファイルが作成されている必要があり、

アクティビティの実行に関係する必要なコードが記述されていなければなりま せん。必要なコードが含まれていないと、[Info Log]タブに次のようなエラーが表 示されます。

"Client script error: Type Mismatch: [activity name] on line:

[line number]"

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

有効なスクリプトのご提供のお願い

カスタムアクティビティを CatTools でサポート可能にできた場合、作成したカ スタムクライアントスクリプトファイル(.txt)とメインスクリプトファイル(.txt)、

カスタムアクティビティタイプファイル(.ini)、カスタムアクティビティを参照す るデバイスの.customファイルとともに弊社まで送ってください。今後、製品付 属の定義済みアクティビティタイプとして扱わせていただくことを検討いたし

2008  Kiwi Enterprises ます。弊社Webサイトの製品サポートページにあるフォームを使用して弊社ま で添付ファイルにて送信してください。

提供していただいたアクティビティに対する需要、スクリプトの複雑性、利用可 能な技術情報源など検討項目は多岐にわたるため、そのアクティビティを

CatToolsの定義済みアクティビティタイプとして追加するかどうか、追加する場

合はその時期に関しては何の保証もいたしかねます。しかし、送信していただい たスクリプトはすべて将来の参考用として分類・保管させていただきます。