4.5 カスタムアクティビティの作成
4.5.4 カスタムアクティビティクライアントスクリプトファイル(.txt)
2008 Kiwi Enterprises ます。弊社Webサイトの製品サポートページにあるフォームを使用して弊社ま で添付ファイルにて送信してください。
提供していただいたアクティビティに対する需要、スクリプトの複雑性、利用可 能な技術情報源など検討項目は多岐にわたるため、そのアクティビティを
CatToolsの定義済みアクティビティタイプとして追加するかどうか、追加する場
合はその時期に関しては何の保証もいたしかねます。しかし、送信していただい たスクリプトはすべて将来の参考用として分類・保管させていただきます。
2008 Kiwi Enterprises 製品の新バージョンが発行される際に随時(必要であれば)更新されます。このた め、新しくカスタムアクティビティクライアントスクリプトを作成する目的でテ ンプレートファイル自体を変更することは絶対にしないでください。テンプレー トを元に新しいカスタムアクティビティクライアントスクリプトを作成する必 要がある場合は、テンプレートファイルをコピーして¥Scriptsフォルダに別の名 前を付けて保存するようにしてください。
カスタムアクティビティクライアントスクリプトファイル(.txt)の作成
CatTools にカスタムアクティビティクライアントスクリプトを新しく追加する
とき、最初にすることは¥Templates フォルダの下にあるテンプレートファイル Client.Custom.Activity.Template.txt をコピーして¥Scripts フォルダの下に別の名 前を付けて保存することです。このとき、アクティビティタイプ.ini ファイルの [Activity]項目でscript_clientに指定したものと同じ名前で保存してください。
このファイルを作成元として新しいデバイススクリプトファイルを定義します。
クライアントスクリプトファイル(.txt)の編集
次に、カスタムクライアントスクリプト.txt ファイルを開き、必要であればご使 用のデバイスに合わせてスクリプトが動作するよう、各項目の値を変更します。
.txt ファイルには、変更する際の手順やヒントなど多くのコメントが書かれてい ますが、注意しなければならない重要な項目はいくつかしかなく、それらはスク リプトファイルの冒頭に書かれています。
スクリプトの1行目に次のように記述されていることがあります。
Attribute VB_Name = "Act_Custom_Template"
これはVisual Basic(あるいは同等のスクリプト言語)開発環境で表示したときに、
そのカスタムアクティビティクライアントスクリプトファイルを示す Visual
Basicモジュール名となります。この行はVB開発環境でファイルの編集を行っ
ているときは表示されませんが、他のエディターでは表示される場合があります。
"Act_Custom_Template"はカスタムテンプレートファイルのモジュールに付 けられた名前です。カスタムアクティビティクライアントスクリプトファイルが たくさんある場合は、この名前を作成したカスタムアクティビティクライアント スクリプトのファイル名を反映した名前に変更するほうが良いこともあります。
そのようにすることによって、複数のカスタムアクティビティクライアントスク リプトファイルをご使用のVB開発環境で同時に(たとえば、1つのプロジェクト
2008 Kiwi Enterprises 内などで)開くことができるようになります。
スクリプトの編集にテキストベースのエディター(メモ帳など)を使用している場 合は、モジュール名の変更は任意で構いません。しかし、混乱を避けるには、こ の名前を変更しておいたほうが良いでしょう。
メモ:
--- SCRIPT NOTES ---
SCRIPT NOTESには、有用な情報とスクリプト作成の初期段階において実行す
べき作業について記載されています。ここに書かれている内容は必要に応じて適 宜書き換えて構いません。たとえば、スクリプト設定の初期に必要な作業を終え、
もう再びその作業をする必要がない場合、SCRIPT NOTESに記載されている、
それらに関するテキストを全部削除することができます。複雑なルーチンやスク リプト固有の振る舞いなど、デバイススクリプトの管理担当者にとって役立つ情 報はここに記載しておいてください。このような情報は完全なものである必要が あり、全文をここに記載するか、完全な情報が記載されている関連項目を参照先 として記載してください。
--- ACTIVITY NOTES ---
ACTIVITY NOTESには、デバイス固有の振る舞いや特殊な動作など、アクティ
ビティスクリプトの管理担当者にとって役立つ情報を記載します。
例: "The activity allows 3 Options:..." (続けて各オプションの意味と入力値の一覧 を記載)
必須関数:
CatToolsがアクティビティを実行するために、カスタムアクティビティクライア
ントスクリプト内で指定しなければならない必須関数は次の関数のみです。
Function Client()
アクティビティクライアントスクリプトに独自の関数やサブルーチンを定義す ることもできますが、それらはFunction Main()内から呼び出す必要があります。
独自の関数やサブルーチンにはコメントを必ず付けておき、後で自分自身や他の 開発者が見たときにその関数が何であるのか理解できるようにしておくことは 大切です。
2008 Kiwi Enterprises スクリプトファイルの保存
作成したスクリプトファイルに CatTools がアクセスできるようにするには、ス クリプトファイルを¥Scriptsフォルダに保存する必要があります。通常、スクリ プトファイルのコードを変更した際にその変更部分を読み込むために CatTools を停止させ再起動する必要はないのですが、テスト時に変更部分が認識されてい ないため余儀なく再起動しなければならないことも少なくありません。
カスタムアクティビティスクリプトのテスト
スクリプトの設定が終わったら、CatToolsで新しいアクティビティを既存のデバ イスを使って実行するよう設定し、正常に動作するかどうかをテストしてくださ い。
選択したデバイスには対応する.custom ファイルが作成されている必要があり、
アクティビティの実行に関係する必要なコードが記述されていなければなりま せん。必要なコードが含まれていないと、[Info Log]タブに次のようなエラーが表 示されます。
"Client script error: Type Mismatch: [activity name] on line: [line number]"
詳細については、「カスタムアクティビティのテスト」の項を参照してください。
有効なスクリプトのご提供のお願い
カスタムアクティビティを CatTools でサポート可能にできた場合、作成したカ スタムクライアントスクリプトファイル(.txt)とメインスクリプトファイル(.txt)、
カスタムアクティビティタイプファイル(.ini)、カスタムアクティビティを参照す るデバイスの.customファイルとともに弊社まで送ってください。今後、製品付 属の定義済みアクティビティタイプとして扱わせていただくことを検討いたし ます。弊社Webサイトの製品サポートページにあるフォームを使用して弊社ま で添付ファイルにて送信してください。
提供していただいたアクティビティに対する需要、スクリプトの複雑性、利用可 能な技術情報源など検討項目は多岐にわたるため、そのアクティビティを
CatToolsの定義済みアクティビティタイプとして追加するかどうか、追加する場
合はその時期に関しては何の保証もいたしかねます。しかし、送信していただい たスクリプトはすべて将来の参考用として分類・保管させていただきます。