JP1/NETM/DM 運用ガイド1 (Windows(R)用)
JP1/NETM/DMのインストールスクリプトおよびコレクトスクリプトで使用できる関数について説明します。これらの関数を使用すると,プログラムのバージョンを取得したり,プログラムマネージャに新しくアイコンを追加したりできます。
スクリプト関数の一覧を次の表に示します。
表D-2 スクリプト関数の一覧
スクリプト関数 | 使用種別 | 説明 |
---|---|---|
Backup | I | 稼働中のバージョンのソフトウェアのバックアップを取得する |
Collection | C | ディレクトリまたはファイルをリモートコレクトする |
CreateIcon | I | 指定したプログラムグループに,指定したプログラムのアイコンを追加する |
CreateProgramGroup | I | プログラムマネージャに,指定したプログラムグループ名でグループを作成する |
CreateShortCut | I | リモートインストール先にショートカットを作成する |
DelBackup | I | リモートインストール先のバックアップを削除する |
DmSetStatus | I,C | エラーステータスコードを設定する |
GetBackupStatus | I | バックアップを取得したかどうかを返す |
GetErrorStatus | I,C | スクリプト処理のどこでエラーが発生したかを調べる |
GetResourceName | I | インストールをするソフトウェアのパッケージ識別IDを調べる |
GetResourceVersion | I | インストールをするソフトウェアのバージョン,世代番号を調べる |
GetSoftwareName | I | インストールするソフトウェアのパッケージ名を取得する |
GetStatus | I,C | SetStatus()で設定したステータスの現在の値を取得する |
Install | I | ファイルを指定のディレクトリへ復元する |
LogFile | I,C | 任意のメッセージをログファイルへ出力する |
MsgBox | I | ダイアログボックスでメッセージを表示する |
Restore | I | バックアップを取得したソフトウェアを復元する |
SetStatus | I,C | 任意の処理状態をステータスとして設定する |
Setup | I | Install関数で復元したファイル群を使ってセットアップをするプログラムを起動する |
Shell | I,C | 外部プログラムの起動 |
SysInfoCoProcessor | I | コプロセッサの有無を調べる |
SysInfoCpuType | I | CPU種別を調べる |
SysInfoHDEmpty | I | ハードディスクの空き容量を調べる |
SysInfoMemory | I | 各種メモリ容量を取得する |
SysInfoOSVersion | I | 使用中のオペレーティングシステム(OS)のバージョンを調べる |
VerInfo | I | 指定したソフトウェアのバージョンを調べる |
VerInfoEx | I | パッケージ名またはパッケージ識別IDからインストール済みのソフトウェアのバージョンを調べる |
各スクリプト関数は,次のように記述してください。関数名の直後,および関数の引数の前後には,0文字以上の半角スペース,TABコード,または改行コードを使用してください。
関数名(関数の引数1[,関数の引数2])
各関数名の英大文字と小文字は,区別されるので注意が必要です。各関数の引数の数は固定で,関数ごとに異なっています。引数は,直接値で指定しても,変数で指定してもかまいません。ただし,システム変数は直接値で指定してください。
リモートインストール先で,インストール対象のパッケージがインストール済みの場合,稼働しているバージョンのソフトウェアのバックアップを取得します。
Backup()
なし
なし
指定したディレクトリまたはファイルをリモートコレクトします。
Collection関数は,コレクトファイルで最低3回呼び出さなければなりません。まず,引数にCOLLECTION_STARTを指定してCollection関数を呼び出し,リモートコレクトに関する設定を初期化します。そして,リモートコレクトするファイルまたはディレクトリを設定するため,引数にファイルかディレクトリを指定してCollection関数を呼び出します(100回まで複数回可)。最後に,引数にCOLLECTION_ENDを指定してCollection関数を呼び出し,収集を実行します。
Collection(COLLECTION_START) Collection(String リモートコレクトするディレクトリ名またはファイル名) Collection(COLLECTION_END)
なし
プログラムマネージャにアイコンを追加します。追加先のプログラムグループ,追加したい実行ファイル,およびアイコンのタイトルを指定してください。
この関数は,バックグラウンドインストールモードでは使用できません。
CreateIcon(String プログラムグループ名, String 実行ファイルのパス名, String アイコンのタイトル)
なし
他社ソフトウェアや日立プログラムプロダクトのインストールには,この関数を使用できません。
プログラムマネージャにグループを作成します。プログラムグループ名を指定してください。
この関数は,バックグラウンドインストールモードでは使用できません。
CreateProgramGroup(String プログラムグループ名)
なし
他社ソフトウェアや日立プログラムプロダクトのインストールをする場合は,この関数を使用できません。
リモートインストール先にショートカットを作成します。この関数は,リモートインストール先が,Windows Me,Windows 98,またはWindows 95のときだけ使用できます。
この関数は,バックグラウンドインストールモードでは使用できません。
CreateShortCut(String ショートカット作成先のパス名, String ショートカットのリンク先パス名, String ショートカットのタイトル)
なし
Backup関数で取得したバックアップを削除します。バックアップが取得されていない場合は,この関数を呼び出しても無視されます(エラーにはなりません)。
DelBackup()
なし
なし
指定したエラーステータスコード(UNIX NETM/DMシステムではエンドステータス)を設定できます。条件不一致でスクリプトを終了する場合に,設定してください。設定したエラーステータスコードは,インストール処理またはコレクト処理の終了コードとして,上位システムに通知されます。
DmSetStatus(System エラーステータスコード)
表D-3 システム変数
システム変数 | 説明 |
---|---|
INSTALL_CAPAERROR | ハードディスク容量チェック時の条件不一致 (エンドステータス1=0x92) (エンドステータス2=0x03) |
INSTALL_HENVERROR | ハードウェア環境チェック時の条件不一致 (エンドステータス1=0x9d) (エンドステータス2=0x02) |
INSTALL_SENVERROR | MS-DOS,Windowsバージョンチェック時の条件不一致 (エンドステータス1=0x9d) (エンドステータス2=0x03) |
INSTALL_PSVRERROR | 前提ソフトウェアバージョンチェック時の条件不一致 (エンドステータス1=0x9d) (エンドステータス2=0x04) |
なし
今回のリモートインストールで,バックアップを取得したかどうかを返します。
System GetBackupStatus()
なし
スクリプトのどの個所でエラーが発生したかを調べます。On InstallErrorステートメントとOn CollectionErrorステートメントの中でだけ使用できます。
System GetErrorStatus()
なし
表D-4 エラー発生個所一覧
システム変数 | 説明 |
---|---|
BACKUP_PROCESS | Backup関数処理中にエラー |
COLLECTION_PROCESS | Collection関数処理中にエラー |
CREATEICON_PROCESS | CreateIcon関数処理中にエラー |
CREATEPROGRAMGROUP_PROCESS | CreateProgramGroup関数処理中にエラー |
CREATESHORTCUT_PROCESS | CreateShortCut関数処理中にエラー |
GETBACKUPSTATUS_PROCESS | GetBackupStatus関数処理中にエラー |
INSTALL_PROCESS | Install関数処理中にエラー |
MISC_PROCESS | その他のスクリプト処理でエラー |
MSGBOX_PROCESS | MsgBox関数処理中にエラー |
NO_ERROR | エラーは発生していない |
RESTORE_PROCESS | Restore関数処理中にエラー |
SETSTATUS_PROCESS | SetStatus関数処理中にエラー |
SETUP_PROCESS | Setup関数処理中にエラー |
SHELL_PROCESS | Shell関数で起動したユーザプログラムでエラーまたはShell関数の実行時にエラー |
SYSINFOCOPROCESSOR_PROCESS | SysInfoCoProcessor関数処理中にエラー |
SYSINFOCPUTYPE_PROCESS | SysInfoCpuType関数処理中にエラー |
SYSINFOHDEMPTY_PROCESS | SysInfoHDEmpty関数処理中にエラー |
SYSINFOMEMORY_GDIMEMORY_PROCESS | SysInfoMemory関数のGDI_MEMORY(システム情報タイプ)処理中にエラー |
SYSINFOMEMORY_REALMEMORY_PROCESS | SysInfoMemory関数のREAL_MEMORY(システム情報タイプ)処理中にエラー |
SYSINFOMEMORY_USERMEMORY_PROCESS | SysInfoMemory関数のUSER_MEMORY(システム情報タイプ)処理中にエラー |
SYSINFOOSVERSION_MSDOS_PROCESS | SysInfoOSVersion関数のMSDOS(システム情報タイプ)処理中にエラー |
SYSINFOOSVERSION_WINDOWS_PROCESS | SysInfoOSVersion関数のWINDOWS(システム情報タイプ)処理中にエラー |
VERINFO_PROCESS | VerInfo関数処理中にエラー |
VERINFOEX_PROCESS | VerInfoEx関数処理中にエラー |
インストールをするソフトウェアのパッケージ識別IDを取得します。
String GetResourceName()
なし
インストールをするソフトウェアのバージョン,世代番号を取得します。
String GetResourceVersion()
なし
インストールするソフトウェアのパッケージ名を取得します。
String GetSoftwareName()
なし
SetStatus関数で設定したステータスの現在の値を取得します。
Integer GetStatus()
なし
SetStatus関数でステータスを設定していない場合,0が返されます。
配布されたソフトウェアをインストール(復元)します。
Install(String インストール先ディレクトリ名の文字列)
なし
: Install("1:\users\home\instdir") :
: Install(SETUP_DIRECTORY) : Setup() :
同じスクリプトにInstall関数を複数回記述することはできません。
任意のメッセージ文字列をログファイルに出力します。出力先は,クライアントのインストール先ディレクトリ下のLOG\MAIN.LOGとLOG\USER.LOGです。クライアントのメッセージログと関連づけてメッセージを確認したいときは,MAIN.LOGを利用してください。スクリプトの開発者が任意に出力したメッセージだけを確認する場合は,USER.LOGを利用してください。また,このログは,Windows NTのイベントログにも取得されます(イベントIDが60000以降)。
LogFile(String 任意のメッセージ文字列)
なし
この関数の使用は必要最小限にしてください。この関数を多く利用すると,ディスクの入出力が多くなり,性能が低下する原因になります。
任意のメッセージをメッセージボックスに表示します。メッセージボックスに表示されるボタンは,[OK]だけです。
この関数は,バックグラウンドインストールモードでは使用できません。
MsgBox(String メッセージ文字列, Integer 表示時間)
なし
リモートインストール実行前に取得したバックアップを復元して,旧バージョンに戻します。バックアップが取得されていない場合は,この関数を呼び出してもエラーにはならないで無視されます。この関数をOn InstallError Doステートメント内に記述した場合,リモートインストールでエラーが発生したときだけバックアップが復元されます。
Restore()
なし
なし
スクリプトの処理状態を,任意のステータスコードで保存できます。保存したステータスコードは,GetStatus関数で取得してください。
スクリプトが終了すると,最後に設定したステータスコードがインストール処理またはコレクト処理の終了コードとして上位のシステムに通知されます。
SetStatus(Integer ステータスコード)
なし
スクリプトで最初にSetStatus関数が実行されるまでは,ステータスコードとして0が仮定されます。
Install関数で復元したファイルを使って,セットアップをするプログラムを起動します。
Windowsアプリケーションのセットアッププログラムの多くは,GUI上で動作します。JP1/NETM/DMでは,このようなGUIのセットアッププログラムを使用できますが,その場合,AITファイルまたはレコーダファイル(Visual Testのスクリプト)を用意してください。画面に対してクライアントで自動的に応答するのに必要です。Automatic Installation Tool実行ライブラリがAITファイルを使って,またはVisual Test実行ライブラリがレコーダファイルを使って,GUIのセットアッププログラムに自動的に応答します。
AITファイルまたはレコーダファイルの作成方法については,マニュアル「Automatic Installation Toolガイド」を参照してください。
この関数は,バックグラウンドインストールモードでは使用できません。
Setup()
なし
なし
外部プログラムを起動します。
Shell(String 起動プログラムのフルパス名)
なし
Shell("c:\winnt\system32\notepad.exe")
Dim S As String S = "1:\users\home\prog01.exe file01.txt" Shell(S)
Shell("""c:\Program Files\prog2.exe""")
Shell("""c:\Program Files\Test\aaa.exe"" /f C:\temp\bbb.exe /I: /S ""ccc.txt""")
コプロセッサがあるかどうかを返します。
System SysInfoCoProcessor()
なし
Windowsにリモートインストールをする場合に,コプロセッサなしの条件にすると,スクリプトのシステム条件不一致でエラーになります。
CPU種別を取得します。
System SysInfoCpuType()
なし
CrusoeなどIntel互換CPUの場合は,I_PENTIUMが返されます。
指定したハードディスクドライブの,空き容量を取得します。
Integer SysInfoHDEmpty(System ドライブ名)
各種メモリ容量を取得します。
Integer SysInfoMemory(メモリ種別)
表D-5 メモリ種別
メモリ種別 | 説明 |
---|---|
REAL_MEMORY | 実メモリの容量を取得します。 |
USER_MEMORY | ユーザが利用可能なメモリ容量を取得します。この値は,起動しているアプリケーションの数によって変化します。 |
GDI_MEMORY | 利用可能なGDIシステムリソースの容量を取得します。この値は,最大64キロバイトです。 |
現在使用中の各種OSのバージョンを取得します。
String SysInfoOSVersion(OS種別)
パッケージ識別IDで指定したソフトウェアのバージョンを返します。引数の新旧タイプには,ACTIVE_VERSION(稼働中の新バージョン)を指定してください。
String VerInfo(新旧タイプ, String パッケージ識別ID)
この関数は,JP1/NETM/DMを使ってインストールしたソフトウェアのバージョンを取得するものです。直接FDなどからインストールしたソフトウェアについては,この関数ではバージョンを取得できません。
インストール済みのパッケージのバージョンを,パッケージ名またはパッケージ識別IDから取得します。
String VerInfoEx(PACKAGE_NAME, String パッケージ名) String VerInfoEx(PACKAGE_ID, String パッケージ識別ID)
この関数は,JP1/NETM/DMを使ってインストールしたソフトウェアのバージョンを取得するものです。直接FDなどからインストールしたソフトウェアについては,JP1/NETM/DMの「ソフトウェア検索機能」を使って検索できるソフトウェアのバージョンだけを取得できます。
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
Copyright, patent, trademark, and other intellectual property rights related to the "TMEng.dll" file are owned exclusively by Trend Micro Incorporated.