この記事では、EloView® WebAppsおよびWebViewController (WVC) を使用して、Elo Android デバイス上に直接高度なブラウザおよびキオスク構成設定を適用する方法について説明します。
Local Configは、WVCが起動する際にElo Androidデバイス上にローカルに保存された構成設定を使用できるようにします。これらの設定は、EloViewポータルを通じて利用できるものを超えた追加の構成オプションを提供します。
⚠ 重要
EloViewでLocal Configを有効にすると、WebViewControllerはローカル構成ファイルを探すようになります。これにより、構成ファイルがデバイスに作成、ダウンロード、またはコピーされることはありません。顧客または管理者が構成ファイルを作成し、物理的なElo Androidデバイスのサポートされる場所に配置する必要があります。
概要
WebViewControllerは構成情報を2つの方法で受け取ることができます。
-
ローカル構成ファイル – WVCはデバイスのルート
/sdcard/ディレクトリに保存されたサポートされる構成ファイルを読み込みます。 - Android Intents – カスタムAndroidアプリケーションがプログラムでWVCを起動し、構成情報を提供できます。
readLocalConfigブールIntentエクストラは、WebViewControllerがlaunchContentSetting Intent設定の代わりにローカル構成ファイルを使用しようとするかどうかを決定します。
| readLocalConfig | 動作 |
|---|---|
true |
WVCにサポートされているローカル構成ファイルを使用し、launchContentSettingを無視するよう要求します。 |
false |
WVCはlaunchContentSettingを通じて起動構成を受け取ることができます。 |
始める前に
ℹ 始める前に
構成ファイルを作成する前に、あなたの展開に必要なWebViewControllerの設定を特定してください。
Eloは、意図的に変更する必要がある設定のみを含めることを推奨します。他の設定は既存のまたはデフォルトの動作のままにしてください。
EloViewでLocal Configを有効にする
EloViewでWebAppコンテンツを構成する際には、コンテンツプロパティからLocal Configを有効にします。
- EloViewポータルで、該当するWebAppコンテンツアイテムを開きます。
- コンテンツの詳細> コンテンツプロパティに移動します。
- ブラウザ設定の下で、Local Configを見つけます。
- Local Configを有効(アクティブ)に設定します。
- 構成を保存または適用します。
⚠ 重要
この設定を有効にしても構成ファイルは作成されず、展開されません。構成ファイルは依然として作成され、対象デバイスのサポートされる場所にコピーする必要があります。
ローカル構成ファイルの作成と配置
WebViewControllerは、JavaプロパティファイルおよびJSON構成ファイルをサポートします。構成ファイルは、以下のサポートされているファイル名のいずれかを使用して、ルート/sdcard/ディレクトリに直接配置してください。
| 優先度 | サポートされるファイルパス | 形式 |
|---|---|---|
| 1 – 最高 | /sdcard/wvc_config.properties |
Javaプロパティ |
| 2 | /sdcard/wvc_config.prop |
Javaプロパティ |
| 3 – 最低 | /sdcard/wvc_config.json |
JSON |
ℹ ファイルの優先度
デバイスに複数のサポートされる構成ファイルが存在する場合、WebViewControllerは最高優先度のファイルを使用します。例えば、wvc_config.propertiesはwvc_config.propやwvc_config.jsonよりも優先されます。
⚠ ストレージパスの要件
ファイルは必ず/sdcard/の直下に配置する必要があります。/sdcard/Download/のようなサブフォルダ内に保存されたファイルは、異なるパスとなり、Local Configに文書化されたサポート対象の場所のいずれかではありません。
WebViewController構成設定
Local Configは、さまざまなWebViewController設定をサポートしています。ブール値はtrueまたはfalseを使用します。文字列値はJSONで引用符で囲むか、Javaプロパティファイルでテキスト値として入力します。
ブラウザおよびセッション設定
| 設定 | タイプ | 説明 |
|---|---|---|
viewMode |
文字列 | 全画面の場合はFull Viewを使用します。他の値はフォームビューを使用します。 |
layerType |
文字列 |
HWはハードウェアアクセラレーションを有効にします。他の値はSWを使用します。ハードウェアアクセラレーションは、ビデオ再生のための開発者文書で推奨されています。 |
pinchZoom |
ブール | ピンチズームを有効にします。 |
homePageTimeout |
文字列 | ホームページに戻る前のアイドル時間の分数。0、never、または省略した値はタイムアウトがないことを意味します。 |
clearUserDataOnTimeout |
ブール | ホームページタイムアウトが発生したときにユーザーデータを消去します。 |
clearCookiesOnTimeout |
ブール | ホームページタイムアウトが発生したときにクッキーを消去します。 |
ssl |
ブール | SSLを有効にします。 |
userAgent |
文字列 | User-Agent文字列を設定します。 |
virtualKeyboard |
ブール | 仮想キーボードを無効にするためにfalseに設定します。 |
disableDownload |
ブール | ダウンロードを無効にするためにtrueに設定します。これによりPDFも無効になります。 |
showLoadingBar |
ブール | 画面の上部に読み込みバーを表示します。 |
ナビゲーションバー設定
| 設定 | タイプ | 説明 |
|---|---|---|
showNavBar |
ブール | 画面の下部にホーム、戻る、進むのナビゲーションバーを表示します。 |
navBarBackgroundColor |
文字列 | ナビゲーションバーの色を#RRGGBBまたは#AARRGGBB形式で指定します。 |
navBarAccentColor |
文字列 | ナビゲーションバーのアクセントカラー。 |
アクションバー設定
| 設定 | タイプ | 説明 |
|---|---|---|
showActionBar |
ブール | 画面の上部にアクションバーを表示します。 |
actionBarBackgroundColor |
文字列 | アクションバーの背景色。 |
actionBarBackgroundUrl |
文字列 | アクションバーの背景として使用される画像のURL。 |
actionBarAccentColor |
文字列 | アクションバーのアクセントカラー。 |
showActionBarLogo |
ブール | アクションバーの左側にロゴを表示します。 |
actionBarLogoIconUrl |
文字列* | アクションバーのアイコンとして使用される画像のURL。 |
showActionBarTitle |
ブール | アクションバーにウェブページのタイトルを表示します。 |
showActionBarSubtitle |
ブール | アクションバーにウェブページのサブタイトルを表示します。 |
showActionBarPrintBtn |
ブール | 印刷ボタンを表示します。 |
showActionBarShareBtn |
ブール | 共有ボタンを表示します。 |
showActionBarInfoBtn |
ブール | 情報ボタンを表示します。 |
ℹ ドキュメントノート
ソース開発者文書ではactionBarLogoIconUrlをURLとして説明していますが、ソーステーブルではこのキーをブールとします。設定がURLを表すため、このセクションでは文字列として表示されています。対象デバイスで使用されているWebViewControllerパッケージに対して動作を確認してください。
PDF設定
| 設定 | タイプ | 説明 |
|---|---|---|
pdfSupport |
ブール | PDFビューイングを有効にします。 |
pdfHyperlinkSupport |
ブール | PDF内のハイパーリンクを有効にします。 |
pdfSwipeHorizontal |
ブール | trueに設定するとPDFの横スクロールを有効にします。 |
pdfShowScrollHandle |
ブール | PDFをスクロールするときにスクロールハンドルを表示します。 |
pdfFitToHeight |
ブール | PDFを幅ではなく表示高にフィットさせます。 |
JSON構成の例
以下の簡略化された例は、wvc_config.jsonファイルの構造を示しています。展開に適した設定と値のみを選択してください。
{
"contentpath": "https://example.com",
"viewMode": "Full View",
"layerType": "HW",
"pinchZoom": true,
"homePageTimeout": "0",
"showNavBar": true,
"pdfSupport": true
}ファイルをサポートされているファイル名のいずれかを使用して、直接/sdcard/の下に保存してください。ローカル構成ファイルを使用している場合、readLocalConfigをtrueに設定してWebViewControllerを起動します。
Android Intentsを使用してWebViewControllerを構成する
WebViewControllerは、Android Intentsを介してプログラムで起動および構成することもできます。これは、デバイスに保存された構成ファイルを使用する代替手段を提供します。
例えば、WebViewControllerがインストールされた後、カスタムデバイスエージェントアプリケーションがデバイスワークフローの一部としてWVCを制御するために適切なIntentsを送信できます。
| Intentエクストラ | タイプ | 目的 |
|---|---|---|
contentPath |
文字列 | http://、https://、またはfile://で始まるホームページのURL。 |
readLocalConfig |
ブール | trueの場合、WVCにlaunchContentSettingを無視し、サポートされているローカル構成ファイルを使用するよう要求します。 |
launchContentSetting |
文字列 | ビュー設定、ナビゲーションバー、タイムアウト動作、PDF動作、および他のサポートされている設定を含むJSONオブジェクト。 |
⚠ 重要 – Intentパラメータ名
開発者文書ではIntentエクストラをcontentPathとして特定していますが、そのサンプルコマンドでは小文字のcontentpathを使用しています。
統合者は、インストールされているWebViewControllerバージョンおよび該当する開発者パッケージに付属するサンプルファイルに対して正確なIntentエクストラ名および値エンコーディングを確認する必要があります。
トラブルシューティング
| 問題 | 確認すべきこと |
|---|---|
| ローカル構成が適用されない | Local Configが有効で、構成ファイルがサポートされているファイル名および場所を使用していることを確認してください。 |
| JSON構成が無視されているようだ | wvc_config.propertiesまたはwvc_config.propを確認します。どちらもwvc_config.jsonよりも優先されます。 |
| 構成ファイルが検出されない | ファイルが/sdcard/の直下にあることを確認します。/sdcard/Download/などの場所にあるファイルは、文書化されたLocal Configパスのいずれかではありません。 |
launchContentSetting設定が使用されない |
readLocalConfigを確認します。trueに設定されている場合、WVCはローカル構成ファイルを使用しようとします。 |
| ダウンロードまたはPDFが利用できない | disableDownloadがtrueに設定されているかどうかを確認します。このオプションを有効にすると、PDFも無効になります。 |
Local Configセットアップチェックリスト
- 展開に必要なWebViewController設定のみを特定します。
- 文書化された設定名と値タイプを使用して、有効なJSONまたはJavaプロパティ構成ファイルを作成します。
- サポートされているファイル名のいずれかを使用してファイルを保存します。
- ファイルを物理的なElo Androidデバイスの
/sdcard/のルートに直接コピーします。 - EloViewで該当するWebAppのためにLocal Configを有効にします。
- ローカル構成ファイルを使用してWVCを起動する際、
readLocalConfigをtrueに設定します。 - プログラムで制御するために、まずWebViewControllerをインストールし、その後デバイスエージェントアプリケーションに適切なAndroid Intentsを送信させます。
- ターゲットデバイス上で構成をテストし、WebViewControllerが期待通りに動作することを確認します。
💡 ヒント
WebViewControllerの動作および利用可能な設定は、WVCのバージョンによって異なる場合があります。自動展開を開発する際には、ターゲットデバイスにインストールされたWebViewControllerパッケージおよびサンプル構成ファイルに対して構成を確認してください。
Please report any broken links by emailing elo.support@zebra.com and include a link to the knowledge article