4.5 カスタムアクティビティの作成
4.5.2 カスタムアクティビティタイプファイル(.ini)
2008 Kiwi Enterprises
[Info Log]ペインでエラーを確認し、必要であれば作成した.txtファイルと.custom
ファイルを編集します。
詳細については「カスタムアクティビティのテスト」の項を参照してください。
カスタムアクティビティの作成方法の確認
• アクティビティタイプファイル(.ini)を作成する。
• アクティビティメインスクリプトファイル(.txt)を作成する。
• アクティビティクライアントスクリプトファイル(.txt)を作成する。
• アクティビティデバイススクリプトファイル(.custom)を作成する。
(*注記：.txt ファイルはメモ帳を使って開くこともできますが、構文がハイライ
ト表示されるようなスクリプトエディターを使ったほうが .txt ファイルの編集 作業が楽になります。)
2008 Kiwi Enterprises これは、その .ini ファイルがCatTools のファイルであることを示す必須項目で す。次のように記述します。
[info]
cookie=Kiwi CatTools version=3
author=Kiwi Enterprises [Activity]項目
CatTools のインターフェイス(アクティビティの[Type]ドロップダウンリストに
表示される名称等)やスクリプト内で使用される名前を定義するもので、必須項 目です。また、CatToolsのデータベース内で使用するデバイスタイプの固有キー (ID)もここで定義します。次のように記述します。
[Activity]
name=Custom.Activity.Template
script_main=Main.Custom.Activity.Template.txt script_client=Client.Custom.Activity.Template.txt
description=Collects information from devices and creates a custom report report_file=%AppPath%Reports¥Master Custom Activity Template.txt report_overwrite=1
client_threads=0 id=3999
[Activity]項目には .ini ファイルの名前と似ている(あるいは同じ)名前を定義でき
ますが、ここで定義する名前はユーザーインターフェイス内で使用されるデバイ ス名に反映され .iniファイルの名前が変更されるわけではありません。
CatToolsでは予め定義しているアクティビティタイプ用に0〜3999までのIDを
予約しています。作成するカスタムのアクティビティタイプに設定できる番号は
4000〜4999までです。IDを定義する際は、使用しようとしている番号が重複し
ない固有の番号であることを確認してください。
[item]項目(アクティビティの[Option]タブに表示される項目)
[item_xxx]の各項目では、CatToolsのアクティビティの設定画面のユーザーイン
ターフェイスで使用される入力フィールドについて定義します。次のように記述 します。
例:
2008 Kiwi Enterprises [item_value1]
name=Use alternate command type=string
checkbox_show=1 checkbox_default=0 value_default=
required=0
info="Alternative command to capture data from device."
アクティビティの[Options]タブにユーザーインターフェイスとして表示される 入力フィールドごとに[item_xxx]という項目を作成し、個別に定義します。
nameでは、入力フィールドや選択フィールドの横に表示されるテキスト(または ラベル)を定義します。
typeでは、nameで指定したテキストまたはラベルの横に表示される入力フィー ルドや選択フィールドのタイプを定義します。
checkbox_showおよびcheckbox_defaultでは、チェックボックスを表示するか どうか、およびデフォルト値としてチェック有りにするか無しにするかを定義し ます。
value_defaultでは、新しいアクティビティをデータベースに追加する際に使用さ
れるデフォルト値を定義します。
required では、そのフィールドに有効なデータを入力すること(予め定義されて
いるリストから選択するかユーザー自身で値を入力するといった操作)が必須で あるか必須でないかを定義します。必須でない場合は0、必須である場合は1を 指定します。
infoでは、このフィールドに関連する説明を定義します。ここで定義したテキス トはフィールド内にカーソルを置いたときにユーザーインターフェイスのス テータスバーに表示されます。
上記の[item_value1]はユーザーインターフェイス内で使用されているチェック ボックス付きの標準的なテキストボックス入力フィールドの例です。
オプションフィールドに入力可能な数値の範囲を制限する必要がある場合は、
typeまたはrangeを追加してください。
以下のrangeオプションの例は、チェックボックス付きの入力フィールドで入力
可能な値として 1〜2000 までの数値に限定する場合の定義方法を記載していま す。
2008 Kiwi Enterprises [item_value2]
name=Days until entries expire type=range
checkbox_show=1 checkbox_default=0 value_default=30 range_min=1 range_max=2000 required=1
info="Remove entries older than X days from the Master report"
入力フィールドがチェックボックスである場合は、0または 1 を指定します。1 以外の値はすべて0とみなされます。チェックボックスの記述例については以下 を参照してください。この例では、チェックボックスのデフォルト値として1が 指定されています(デフォルトでチェックが入っている状態で表示されます)。
[item_value3]
name=Resolve IP addresses to hostnames type=checkbox
checkbox_show=1 checkbox_default=1
info="Resolve all IP addresses found to hostnames via reverse DNS lookup"
各フィールドのサイズ(入力可能なデータの長さ)は CatTools データベースの設 計によって異なります。CatToolsユーザーインターフェイスを介して入力される データはすべて、設定対象のフィールドに対して長すぎる場合は適宜切り詰めら れて表示されます。
カスタムアクティビティタイプファイル(.ini)のテンプレート
CatToolsにはカスタムアクティビティタイプを新しく作成する際に、作成元とし
て活用できるテンプレートファイルが付属しています。
テンプレートファイルの名前は Custom.Activity.Template.iniで、¥Templates と いうフォルダの中にあります。
このテンプレートファイルは、CatToolsで予め定義されているアクティビティタ イプの一部として含まれています。CatToolsのすべての定義済みアクティビティ のアクティビティタイプファイルは、CatTools製品の新バージョンが発行される
2008 Kiwi Enterprises 際に随時(必要であれば)更新されます。
そのため、新しくカスタムアクティビティタイプを作成する目的でテンプレート ファイル自体を変更することは絶対にしないでください。テンプレートを元に新 しいカスタムデバイスタイプを作成する必要がある場合は、テンプレートファイ ルをコピーして¥Activitiesフォルダに別の名前を付けて保存するようにしてくだ さい。
カスタムアクティビティタイプファイル(.ini)の作成
CatToolsにカスタムアクティビティタイプを新しく追加するとき、最初にするこ
と は ¥Templates フ ォ ル ダ の 下 に あ る テ ン プ レ ー ト フ ァ イ ル Custom.Activity.Template.ini をコピーして¥Activities フォルダの下に別の名前を 付けて保存することです。
このファイルを作成元として新しいアクティビティタイプファイルを定義しま す。ファイル名を付ける際には、なるべく次の命名規則に従ってください。
Custom.Type.Name
Custom "Custom"というテキストは CatTools の定義済みデバイスタ イプと識別するために使用します。ここで指定した名前はア クティビティの[Type]ドロップダウンリスト内にグループ化 されて表示されます。
Type アクティビティのタイプ(Report, CLI, Connectivity, Update 等)を指定します。
Name アクティビティの名前(ARPTable, SendCommands, PingTest, BannerText等)を指定します。
.iniファイルの編集
次に、カスタムアクティビティの.ini ファイルを開き、必要であれば各項目の値 を変更します。
下記のコード例は .iniファイルの例ですが、いくつかの項目の値を別色で表示し ています。
最も大事な項目の値で変更しなければならないものは赤で表示しています。これ らの項目には重複しない固有の値を指定する必要があります。固有の値を設定し なかった場合、作成したアクティビティタイプが CatTools のアクティビティの
2008 Kiwi Enterprises [Type]ドロップダウンリストに表示されません。
必要時に変更される可能性のある項目の値は緑で表示しています。コメントは青 で表示しています(注意：実際の .iniファイルではコメントは削除してください)。
黒文字で表示している部分はすべて元の設定のままにしておくことをお勧めし ます。ただし、nameやinfoなど一部の項目については作成したアクティビティ に関係の深い値に変更しても構いません。
nameに指定するテキスト値はフォーム内に表示されるフィールドラベルとなり ます。infoに指定するテキスト値はフォーム内のフィールドを選択したとき(つま り、カーソルを置いたとき)にステータスバーに表示されるテキストとなります。
.ini ファイルの変更が終わったら、必ず¥Activities フォルダの下に保存してくだ さい。新しいカスタムアクティビティタイプがアクティビティの[Type]ドロップ ダウンリストに表示されるようにするためには、CatToolsを再起動する必要があ ります。
[info]
cookie=Kiwi CatTools version=3
author=Kiwi Enterprisses 自分の名前を入力するかデフォルトのままにしてお
いてください。
[Activity]
name=Custom.Activity.Template 重 複 し な い 固 有 の 名 前 ( 例 ： Custom.Report.PortStatus)に変更してください。注記:各項目の区切りには空白 を入れず、ピリオド(.)を入力してください。
script_main=Main.Custom.Activity.Template.txt 関連付けられているメインスク リプトの名前(Main.アクティビティ名の形式で固有の名前)に変更してください。
script_client=Client.Custom.Activity.Template.txt 関連付けられているクライアン トスクリプトの名前(Client.アクティビティ名の形式で固有の名前)に変更してく ださい。
description=Collects information from devices and creates a custom report 必要 であれば変更してください。
report_file=%AppPath%Reports¥Master Custom Activity Template.txt 固有のレ ポート名に変更してください。
report_overwrite=1 client_threads=0
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個まで指定できます)