モバイルモジュール更新ツール このマニュアルは、モバイルモジュール更新 ツールを利用してモジュール更新システムを 構築し、また構築したシステムの運用などを 行う 開発者向け及び業務管理者向けソフト ウェア解説書 です。 Ver. 1.
変更履歴 バージョン 1.00 1.01 ↑ ↑ ↑ 日付 2006.11 2007.08 ↑ ↑ ↑ ↑ 1.02 1.03 ↑ 2009.06 2010.01 1.04 1.05 1.06 1.07 1.09 1.10 2010.02 2010.02 2010.03 2011.01 2011.12 2012.01 ページ 14 32 45 52∼53 77 1 1 11 1 1 1 1 1 1 説明 新規作成 スペックバージョンブロックを追加 起動引数に[/B]を追加 インストール/アンインストールを追加 関数と対応する更新設定ファイルのタグに関する表を追 加 MoUpReadLocalConfig 関数を追加 対象を修正 対象を修正 2.3.
目次 1. 概要···················································································································································································1 1.1 対象 ···········································································································································································1 1.
.8 エラー時のリトライ処理···································································································································· 42 4.8.1 エラーリトライ処理······································································································································ 44 4.8.2 インストール/アンインストール処理 ·································································································· 45 4.9 抑止処理(OSパッチ CAB/Setup.
.1.38 5.1.39 5.1.40 5.1.41 5.1.42 5.1.43 5.1.44 5.1.45 5.1.46 5.1.47 5.1.48 5.1.49 5.1.50 5.1.51 5.1.52 5.1.
1. 概要 本アプリケーションを利用することで、モバイルネットワーク環境において端末側のデータを自動更新する ことができます。 • ユーザーアプリケーションおよびデータを、簡単にかつ効率的に更新 • 端末上でのアプリケーションおよびデータバージョンの一元管理が可能 1.1 対象 本アプリケーションの対象を以下に示します。 端末ハードウェア HT:DT-5100/5200/DT-X7/DT-5300(CE)/DT-5300(WM)/DT-X8/IT-300/IT-9000 PC:IBM PC/AT 互換機 ※ WindowsMobile では、実行モジュール(CAB,EXE,DLL 等)に適切な署名が付与されている必要があり ます。) OS HT:Windows CE.NET 4.
1.
1.3 提供機能一覧 本ツールで提供する機能を以下に示します。 1.3.
1.3.
1.4 処理フロー概要 更新処理スタート ① 更新設定同期処理 ② カタログ情報更新処理 ③ モジュール更新処理 スタートアップ内容退避(※) ソフトリセット/再起動 -A オプション ④ 動作中モジュール更新処理 スタートアップ内容復元(※) -S オプション 通常起動、 -B オプション MoGetNeedUpdate API 本ツールの処理概要フローを以下に示します。 ⑤ 更新完了処理 更新ログ送信 ソフトリセット/再起動 更新処理終了 ※ スタートアップ内容退避/復元は HT のみ行います。 番号 ① 機能項目 更新設定同期処理 ② カタログ更新処理 ③ モジュール更新処理 ④ 動作中モジュール更新処理 ⑤ 更新完了処理 機能概要 更新設定ファイルのサーバ/端末間同期 詳細は「4.3更新設定同期」を参照 カタログファイルのサーバ/端末間同期 詳細は「4.4カタログファイル更新」を参照 モジュールダウンロードおよび配置 詳細は「4.5モジュール更新」を参照 動作中モジュール更新の配置 詳細は「4.
2. フォルダ構成 2.1 端末フォルダ構成 本ツールの端末フォルダ構成を以下に示します。 %System Drive% My Documents(HT) / Documents and Settings¥All Users¥Application Data (PC) CASIO MoUpdate Download ① Startup ② ・MoConfig.xml ・MoConfig.log ③ ④ 作業フォルダ プログラムフォルダ Windows スタートアップ MoUpdate.exe /s へのショートカット(必要時) ⑦ ・MoUpdate.exe ⑤ ・MoUpCommon.dll ⑥ 番号 ① 項目 Download フォルダ ② Startup フォルダ(HT) ③ MoConfig.xml ④ MoConfig.log ⑤ ⑥ ⑦ MoUpdate.exe MoUpCommon.dll MoUpdate.
2.2 サーバフォルダ構成 本ツールのサーバフォルダ構成を以下に示します。 2.2.1 伝送経路に FTP を使用する場合 インターネットインフォメーションサービス(規定のFTPサイト) Download 用ルートフォルダ ・MoConfig.xml ① ② ・カタログファイル(パターンA).xml ③ ・カタログファイル(パターンB).xml ● ● ● モジュール(パターンA)格納フォルダ ④ モジュール(パターンB)格納フォルダ ● ● ● Upload 用ルートフォルダ ⑤ 番号 ① 項目 Download 用ルートフ ォルダ ② MoConfig.xml ③ ④ カタログファイル.xml モジュール格納フォル ダ Upload 用ルートフォル ダ ⑤ 内容 モジュール更新システム Download 用に公開するフォルダ モジュール更新システム構築時に最初に参照する更新設定ファイ ルや、更新対象となるカタログファイルを格納 更新先への接続方法/更新すべきカタログ名等、モジュール更新 システムの設定情報を格納するファイル MoConfig.
2.2.2 伝送経路に HTTP を使用する場合 インターネットインフォメーションサービス(規定のWebサイト) Download 用公開ルートフォルダ ・MoConfig.xml ① ② ・カタログファイル(パターンA).xml ③ ・カタログファイル(パターンB).xml ● ● ● モジュール(パターンA)格納フォルダ ④ モジュール(パターンB)格納フォルダ ● ● ● 番号 ① ② ③ ④ 項目 Download 用ルートフ ォルダ MoConfig.xml カタログファイル.xml モジュール格納フォル ダ ※ HTTP による UPLOAD は不可 内容 モジュール更新システム Download 用に公開するフォルダ モジュール更新システム構築時に最初に参照する更新設定ファイ ルや、更新対象となるカタログファイルを格納 更新先への接続方法/更新すべきカタログ名等、モジュール更新 システムの設定情報を格納するファイル MoConfig.
2.2.3 伝送経路に LMWIN を使用する場合 サーバ Download 用フォルダ ・MoConfig.xml ① ② ・カタログファイル(パターンA).xml ③ ・カタログファイル(パターンB).xml ● ● ● モジュール(パターンA)格納フォルダ ④ モジュール(パターンB)格納フォルダ ● ● ● Upload 用フォルダ ⑤ 番号 ① 項目 Download 用フォルダ ② MoConfig.xml ③ ④ カタログファイル.xml モジュール格納フォル ダ Upload 用フォルダ ⑤ 内容 モジュール更新システム Download 用に公開するフォルダ モジュール更新システム構築時に最初に参照する更新設定ファイル や、更新対象となるカタログファイルを格納 更新先への接続方法/更新すべきカタログ名等、モジュール更新シ ステムの設定情報を格納するファイル MoConfig.
2.2.4 伝送経路にフォルダ共有を使用する場合 サーバ Download 用共有フォルダ ・MoConfig.xml ① ② ・カタログファイル(パターンA).xml ③ ・カタログファイル(パターンB).xml ● ● ● モジュール(パターンA)格納フォルダ ④ モジュール(パターンB)格納フォルダ ● ● ● Upload 用共有フォルダ ⑤ 番号 ① 項目 Download 共有フォル ダ ② MoConfig.xml ③ ④ カタログファイル.xml モジュール格納フォル ダ Upload 用共有フォル ダ ⑤ 内容 モジュール更新システム Download 用に公開するフォルダ モジュール更新システム構築時に最初に参照する更新設定ファイル や、更新対象となるカタログファイルを格納 更新先への接続方法/更新すべきカタログ名等、モジュール更新シ ステムの設定情報を格納するファイル MoConfig.
2.3 サーバ設定 本ツールのサーバ設定手順を以下に示します。 2.3.1 伝送経路に HTTP/FTP を使用する場合 1. 初期インストール用フォルダを作成し、プログラムアップデートシステムの一式をコピーします。 2. スペックファイルを運用する環境に合わせて編集し、同フォルダへ配置します。 この際、初期インストール以降はアップデート用の別フォルダへ接続することになるので、FTP の場合 は、FtpServerAddress、FtpLoginUser、FtpLoginPassword をそれに応じた設定に編集します。 3. HTTP の場合は、HttpServerAddress、をそれに応じた設定に編集します。 Windows Server 2003 の場合、以下の手順で IIS 動作の追加設定を行う必要があります。 4. インターネットインフォメーションサービスマネージャーで、Web サービス拡張を選択し、ActiveServer Pages に許可を与えます。 5.
3. スペックファイル ツールで使用するスペックファイルを以下に示します。 なお、注釈がない限り記載内容の大文字/小文字は区別しません。 3.1 更新設定ファイル(MoConfig.xml) 更新設定ファイルとは、サーバへの接続方法/更新すべきカタログ名等、本ツールの設定情報を格納す る XML ファイルです。 エンコードは ShiftJIS を基本とするが、XML ヘッダ情報に適切に記載することで、以下のエンコードも読 み込みを可能です。 ShiftJIS UTF-8 UTF-16
警告ダイアログの表示/非表示 電池残量表示フラグ 電池残量確認ダイアログの表示/非表示を以下のパラメータで指定してください。 “yes” :電池残量確認ダイアログを表示 “no” :電池残量確認ダイアログを非表示 本指定を省略した場合は、“yes”を指定したものとして扱います。 電池残量 電池残量確認ダイアログを表示する電池レベルを以下のパラメータで指定してください。 【電池残量を%で取得可能な機種】 “1” :0%≦ 電池残量 <25% “2” :25%≦ 電池残量 <50% “3” :50%≦ 電池残量 <75% “4” :75%≦ 電池残量 ≦100% 【電池残量を%で取得不可能な機種】 “1” :残りわずか “2” :低 “3” :OK “4” :本指定を省略した場合は、“2”を指定したものとして扱います。 電池残量表示が”yes”設定の場合に、この情報を使用します。 無線強度表示フラグ 無線強度確認ダイアログの表示/非表示を以下のパラメータで指定してください。 “yes” :無線強度確認ダイアログを表示 “no” :無線強度確認ダイアログを非表示 本指定を省略した場合は、“yes”を指定したものとし
確認ダイアログの自動クローズ 更新不要時自動クローズフラグ 更新不要時の確認ダイアログの自動クローズを以下のパラメータで指定してください。 “yes” :ダイアログを 1 秒後に自動クローズ “no” :ダイアログを自動クローズしません 本指定を省略した場合は、“no”を指定したものとして扱います。 動作完了時自動クローズフラグ 動作完了時の確認ダイアログの自動クローズを以下のパラメータで指定してください。 “yes” :ダイアログを 1 秒後に自動クローズ “no” :ダイアログを自動クローズしません 本指定を省略した場合は、“no”を指定したものとして扱います。 3.1.
3.1.2 識別情報ブロック 識別情報ブロックとは、端末個体を識別する情報を格納するブロックです。 識別情報ブロックの書式を以下に示します。 会社コード 店舗コード 端末番号 システムバージョン 会社コード 会社コードをフリーフォーマットで記載してください(省略可)。 本ツールでは、この情報を使用しません。 店舗コード 店舗コードをフリーフォーマットで記載してください(必須)。 本ツールでは、この情報を更新ログファイルのプレフィックスとして使用します。 端末番号 端末番号をフリーフォーマットで記載してください(必須)。 本ツールでは、この情報を更新ログファイルのプレフィックスとして使用します。 店舗コード、端末番号は必須項目ですが、設定しない場合も本ツールは正常動作します。 ただし、この情報を更新ログファイル名称に使用しているため(「3.4.
3.1.3 ダウンロード伝送情報ブロック ダウンロード伝送情報ブロックとは、更新設定情報ファイル/カタログファイル/対象モジュールをサーバ からダウンロードする際に使用する伝送経路情報を格納するブロックです。 識別情報ブロックの書式を以下に示します。 経路種類 FTP 経路詳細情報 HTTP 経路詳細情報 LMWIN 経路詳細情報 共有フォルダ経路詳細情報 1.
2.
3.
4.
上記設定の場合、識別情報ブロックは以下のとおり記載してください。 LAN updatesvr c:\data\ 20
5.
3.1.4 アップロード伝送情報ブロック アップロード伝送情報ブロックとは、更新結果ログファイルをサーバにアップロードする際に使用する伝送 経路情報を格納するブロックです。 識別情報ブロックの書式を以下に示します。 経路種類 FTP 経路詳細情報 HTTP 経路詳細情報 LMWIN 経路詳細情報 共有フォルダ経路詳細情報 記載内容は、「3.1.
3.1.5 カタログ情報ブロック カタログ情報ブロックとは、更新対象モジュールの情報を記載したカタログファイルの名称情報を格納す るブロックです。 カタログファイルを複数記載して、順次モジュール更新を実行することを可能になります。 カタログ情報ブロックの書式を以下に示します。 カタログファイル名 カタログファイル名 カタログファイル名 : : カタログファイル名 更新対象モジュールの情報を記載したカタログファイルの名称を記載します。 例) SYSTEM.xml • カタログファイルに相対パス/絶対パスを記載しないでください • 複数のカタログファイルを記載する場合には、名称が重複しないように指定してください • 複数のカタログファイルを記載した場合には、記載順に上からモジュール更新処理を実行します 3.1.
3.2 カタログファイル(*.xml) カタログファイルとは、更新対象モジュールの名称/バージョン/更新比較条件/更新時動作を格納す る XML ファイルです。 エンコードは ShiftJIS を基本とするが、XML ヘッダ情報に適切に記載することで、以下のエンコードも読 み込み可能です。 ShiftJIS UTF-8 UTF-16 カタログファイルは、以下の 2 ブロックから構成されています。 “identities” 識別情報ブロック “release” モジュール情報ブロック
3.2.1 識別情報ブロック 識別情報ブロックとは、カタログファイルを識別する情報を格納するブロックです。 識別情報ブロックの書式を以下に示します。 表示名 バージョン 最終更新日付 ダウンロードフォルダ相対パス 表示名 カタログファイルの表示名を記載してください(必須)。 画面に表示可能な最大文字数は半角 24 文字(全角 13 文字)です。 本ツールでは、この情報を更新処理実行時の更新状況表示に使用します。 バージョン カタログファイルのバージョンを”99.9999.
3.2.
3.2.
最終更新日付 更新対象モジュールの最終更新日付を”YYYYMMDD”の形式で記載します(省略可)。 本ツールでは、この情報を使用しません。 バージョン 更新対象モジュールのバージョンを”99.9999.99”の形式で記載してください(省略可)。 本ツールでは、この情報を更新要/不要の判断基準として使用します。 ”00.0000.01”以上を指定してください。 更新比較方法 更新対象モジュールの更新要/不要判定方法を以下のパラメータの中から記載してください(省略可)。 本指定を省略した場合は、” versionup”を指定したものとして扱います。 “versionup” カタログファイルに記載のモジュールバージョンが、端末のモジュールバージョ ンを上回った場合に更新処理実行 “versiondown” カタログファイルに記載のモジュールバージョンが、端末のモジュールバージョ ンを下回った場合に更新処理実行 モジュール種別 更新対象ファイルの拡張子を記述してください(省略可)。 本ツールでは、この情報をモジュール更新後の実行処理の判別にのみ使用します。 “cab” 実行モジュールを winceload.
モジュール実行フラグ 更新対象モジュールを配置フォルダに配置した後に実行するかどうか、以下のパラメータで指定してくだ さい。(省略可) “yes” :配置後に ShellExecuteEx() API を用いてモジュールを実行し、完了を待機 “no” :何もしません 本指定を省略した場合は、“no”を指定したものとして扱います。 モジュール実行パラメータ モジュール実行フラグに”yes”を指定した場合に、モジュール実行の引数を記載してください。 本指定を省略した場合は、引数なしでモジュールを実行します。 モジュール実行フラグに”No”を指定した場合、あるいは、モジュール実行フラグを省略した場合には、本 指定は無視します。 モジュール削除フラグ 更新対象モジュールを配置フォルダに配置した後に削除するかどうか、以下のパラメータで指定してくだ さい。(省略可) “yes” :配置後に DeleteFile() API を用いてモジュールを削除 “no” :何もしません 本指定を省略した場合は、“no”を指定したものとして扱います。 MD5 チェックサム 更新対象モジュールの MD5 チェックサム文字列を記載してくだ
3.3 更新済みモジュール情報格納ファイル(MoConfig.log) 更新済みモジュール情報格納ファイルとは、更新済みモジュールの名称/バージョン/最終更新日付を 格納する XML ファイルです。 本ファイルは、端末 1 台につき 1 ファイルのみ存在し、複数のカタログファイルによる更新処理が実行され たとしても、すべての情報をマージして格納します。 記載内容は、「3.2カタログファイル(*.
3.4 更新結果ログファイル 更新結果ログファイルとは、更新済みモジュールの名称/バージョン/最終更新日付を格納する CSV ファイ ルです。 3.4.1 ログファイル名称 更新結果ログファイルの名称を以下に示します。 “店舗コード”-“端末番号”MoConfig.log 更新設定情報ファイル(MoConfig.xml)の識別情報ブロックに記載の「店舗コード」、「端末番号」をプレフ ィックスとして使用します。 例) 店舗コード=”1”、端末番号=”2”の場合の更新結果ログファイル名称 → “1-2MoConfig.
4. 機能 4.1 起動引数 モジュール更新ツールの起動引数を以下に示します。 Moupdate.exe 引数 なし /A /B /S [/A | /B | /S] 動作 起動画面を表示し、モジュール更新の指示待機を行います 「4.3更新設定同期」「4.4カタログファイル更新」「4.5モジュール更新」「4.6動作中モジュール更 新」「4.7更新完了処理」処理を行います 判定済みのモジュール更新対象情報にもとづき、「4.5モジュール更新」「4.6動作中モジュール 更新」「4.7更新完了処理」処理を行います 起動画面を表示し、モジュール更新の指示待機を行わず自動的に以下の処理を行います 「4.3更新設定同期」「4.4カタログファイル更新」「4.5モジュール更新」「4.6動作中モジュール更 新」「4.7更新完了処理」処理を行います 「4.6動作中モジュール更新」「4.
4.2 画面構成 本ツールの画面構成を以下に示します。 4.2.
⑥ 更新状況表示領域 更新開始 モジュールの更新に要求される処理の一覧と、その実行状況を表示 します 完了した処理には、各処理の先頭に アイコンを表示します 更新に不要な処理はグレーアウトします 更新設定同期処理を開始します ただし、前回の処理が無線強度不足等で中止していた場合には、以 下のダイアログを表示して、その時点のカタログファイルに対する処理 を再開することが可能です はい(Y) 前回中断したカタログ ファイルに対する更新 から再開します いいえ(N) 閉じる 更新設定情報同期から 処理をやり直します モジュール更新処理を行わずに、本画面を閉じます 更新開始 ボタン、および 閉じる ボタンは、 [/A | /B] 起動引数を付加して起動した場合には、表示 しません。 また、更新設定同期処理を開始した以降は操作不能(disable 状態)になります。 34
4.2.
4.2.
4.3 更新設定同期 更新対象カタログファイルの増減にリアルタイムに追従するため、端末/サーバのそれぞれで保持する 更新設定ファイル(MoConfig.
4.
4.
4.
4.
4.
エラー発生工程 エラーの発生した工程を警告ダイアログのタイトルとして表示します。 エラー内容 エラーの内容を警告ダイアログのメッセージとして表示します。 • • はい(Y) ボタンを押下した場合、後述するエラーリトライ処理を実行します いいえ(N) ボタンを押下した場合、モジュール更新処理を中止します(ソフトリセットは行いません) 43
4.8.
4.8.2 インストール/アンインストール処理 モジュール更新ツールをインストール時のインストール判断処理を以下に示す。 開始 \windows\MoUpdate.
4.9 抑止処理(OSパッチ CAB/Setup.exe) モジュール更新中は以下の処理を抑止する。更新開始時に抑止し、更新処理完了後に抑止を解除しま す。 本機能は HT のみです。 • OS パッチ CAB ファイルの自動リセット 本ツールで OS パッチ CAB ファイルを更新し、実行後の自動リセットを抑止します。 実行後のリセットは本ツールで一括して行います。 実行後にリセットする場合は、「カタログファイル」-「モジュール情報ブロック」-「リセット実行フラグ」を 設定します。 • リセット時の Setup.exe/Restore.exe 実行 モジュール更新中のリセット時に Setup.exe/Restore.exe の実行を抑止します。 更新終了後のリセットで Setup.exe/Restore.
4.10 初回ダウンロード設定 初回のモジュール更新時や、更新設定ファイルの解析異常時など、端末の更新設定情報が取得できな い場合には、「設定ファイルのダウンロード」指示画面を表示して、その場で更新設定情報ファイルをダウ ンロードすることが可能です。 4.10.
4.10.2 HTTP によるダウンロード 「3.1.3 ダウンロード伝送情報ブロック」 <HTTP 経路詳細情報>に相当する情報を入力し、 開始 ボタ ン押下で、更新設定情報ファイルをダウンロードします。 4.10.3 FTP によるダウンロード 「3.1.
4.10.4 フォルダ共有によるダウンロード 「3.1.
4.10.5 LMWIN によるダウンロード 「3.1.
5. モジュール更新制御 API 他のアプリケーションからモジュール更新ツールを制御する関数を提供します。 ヘッダ :MoUpdateLib.h ライブラリ :MoUpCommon.lib/MoUpCommon.dll 5.
関数名 MoUpGetFtpLoginPasswordEx MoUpSetFtpLoginPasswordEx MoUpGetHTTPServerURLEx MoUpSetHTTPServerURLEx MoUpGetSharedServerAddressEx MoUpSetSharedServerAddressEx MoUpGetSharedLoginUserEx MoUpSetSharedLoginUserEx MoUpGetSharedLoginPasswordEx MoUpSetSharedLoginPasswordEx MoUpGetLMWinDeviceEx MoUpSetLMWinDeviceEx MoUpGetLMWinServerAddressEx MoUpSetLMWinServerAddressEx MoUpGetLMWinComSettingEx MoUpSetLMWinComSettingEx MoUpGetLMWinRoutePathEx MoUpSetLMWinRoutePathEx 機能 FTP パスワードの取得 FTP パスワードの設定 HTTP URL の取得 HTTP
MoUpGetCommunicationRouteEx MoUpSetCommunicationRouteEx MoUpGetFtpServerAddressEx ダウンロード伝送情報 アップロード伝送情報 ↑ ↑ MoUpSetFtpServerAddressEx ↑ MoUpGetFtpLoginUserEx ↑ MoUpSetFtpLoginUserEx ↑ MoUpGetFtpLoginPasswordEx MoUpSetFtpLoginPasswordEx MoUpGetHTTPServerURLEx ↑ ↑ ↑ MoUpSetHTTPServerURLEx ↑ MoUpGetSharedServerAddressEx ↑ MoUpSetSharedServerAddressEx ↑ MoUpGetSharedLoginUserEx ↑ MoUpSetSharedLoginUserEx ↑ MoUpGetSharedLoginPasswordEx ↑ MoUpSetSharedLoginPasswordEx ↑ MoUpGetLMWinDeviceEx
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
5.1.
ご注意 ● このソフトウェアおよびマニュアルの、一部または全部を無断で使用、複製することはできません。 ● このソフトウェアおよびマニュアルは、本製品の使用許諾契約書のもとでのみ使用することができます。 ● このソフトウェアおよびマニュアルを運用した結果の影響については、一切の責任を負いかねますのでご了 承ください。 ● このソフトウェアの仕様、およびマニュアルに記載されている事柄は、将来予告なしに変更することがありま す。 ● このマニュアルの著作権はカシオ計算機株式会社に帰属します。 ● 本書中に含まれている画面表示は、実際の画面とは若干異なる場合があります。予めご了承ください。 © 2012 カシオ計算機株式会社 Microsoft, MS, ActiveSync, Active Desktop, Outlook, Windows, Windows NT, および Windows ロゴは、米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です。Microsoft 社の製品は、OEM 各社に、Microsoft Corporation の 100%出資子会