ユーザ環境でアプリが予期せぬエラーで終了したり、実行中に発生するエラーを分析するためにログファイルを作成することができます。

ログファイルの生成に関する設定

ログファイルを生成する機能は別途設定を行う必要があります。 nexacro studio上で設定する方法とconfigファイルで設定する方法があります。

アプリの実行時には、configファイルの設定内容が優先的に適用されます。configファイルがある場合はEnvironmentでの設定値は無視されます。

Environmentでのログファイル生成の設定

nexacro studio上でプロパティを設定することでログ機能を利用できます。該当のプロパティはnexacro studio上でのみ設定でき、アプリ実行中に変更することはできません。

ログファイルの作成有無の設定（tracemodeプロパティ）

nexacro studioのプロパティリストからEnvironmentのtracemodeプロパティを設定します。 デフォルト値の「none」の場合はログ機能を処理せず、「new」もしくは「append」に設定した場合にログファイルを生成します。

ログレベルと生成タイミングの設定

nexacro studio上のプロパティリストからEnvironmentのloglevel、tracedurationプロパティを設定します。loglevelプロパティではログで出力する情報の基準を設定し、tracedurationプロパティではログファイルを生成するタイミングを設定します。

configファイルの設定

Environmentのプロパティは設定せずに、設定したconfigファイルをユーザー実行環境にコピーするか、ビルド時に含めることができます。

-NCオプションの設定

Windowsでnexacro.exeファイルを実行する際に「-NC」オプションを指定することができます。実行するnexacro.exeファイルと同じ位置にあるconfigファイルを設定することができます。

例えば、nexacro.exeファイルの位置が下記のような警告-NCオプション値に「log_config.xml」ファイルを指定した場合、同じ位置に「log_config.xml」ファイルが必要です。

C:\Program Files\nexacro\17.1\TEST_LOG\nexacro.exe
C:\Program Files\nexacro\17.1\TEST_LOG\log_config.xml

-NCオプションを使用しない場合は、基本パスにあるnexacro_config.xmlファイルを探し出し、該当のファイルを参照します。

nexacro_config.xmlファイルの設定

-NCオプションの設定は、ファイル名を指定できますが、別途オプションを指定する必要があります。nexacro_config.xmlファイルは、指定したパスに決められた名前を持つファイルを置くと、アプリ実行時に自動的にこれを認識して処理します。

Windows

Windowsはnexacro_config.xmlファイルを含め、アプリを配布する機能が含まれていません。下記のパスにnexacro_config.xmlファイルを作成し、アプリ実行時に参照できます。

%USERAPP%\Config\[Key]\nexacro_config.xml

Android、macOS

Android StudioもしくはmacOSでプロジェクトビルド時にnexacro_config.xmlファイルを設定できます。下記の内容を参照してください。

アプリ開発と実行（Android）> Config設定
アプリ開発と実行（iOS/iPadOS）> Config設定

nexacro_config.xmlファイルの属性

設定ファイル（nexacro_config.xml）もしくは-NCオプションで指定するファイルは下記のような形式で作成します。

<?xml version="1.0" encoding="UTF-8"?>
<nexacro-config os="windows">
	<application
		file-logging="true"
		loglevel="debug"
		tracemode="new"
		traceduration="-1"/>
	<log
		filepath="%USERAPP%\Log\nre_log_test.log"
		filesize="408960"
		backupfilecount="5"/>
</nexacro-config>

nexacro_config.xmlファイルに指定する属性の中で、ログファイル作成に関する項目は下記の通りです。

属性別ファイル作成例

backupfilecount

生成されたログファイルのサイズがfilesize属性値より大きくなると、バックアップファイルを追加で生成します。

ファイル名の後に番号をつけてファイルを生成します。backupfilecount属性で指定した値に到達すると、最初に生成したファイルを削除して再びログを記録します。

1時間ごとにアプリが実行され、アプリ実行時に300KBのログを記録すると、ログファイルは下記のように生成されます。

<log filepath="%USERAPP%nrelog.log" filesize="200" backupfilecount="3"/>

traceduration

ログファイルが生成される日を基準に、traceduration属性値より以前に生成されたファイルは削除します。

ファイル名の後に日付（"_yyyymmdd"）をつけてファイルを生成します。日付比較はOSのシステム時間を基準に処理します。

一日一回アプリが実行され、週末には実行されない場合、ログファイルは下記のように生成・削除されます。 週末にはアプリが実行されないため、既に生成されたログファイルが削除されず、月曜日にアプリが実行されてtraceduration属性値の以前のログファイルを削除します。

<nexacro-config os="windows">
	<application file-logging="true" quiet="false" loglevel="debug" tracemode="new" traceduration="2"/>
	<log filepath="%USERAPP%nrelog.log" filesize="408960" backupfilecount="3"/>
</nexacro-config>

ログファイルの読み込み

該当OSのファイル探索プログラムを使用してログファイルを確認することができます。

アプリ内でログファイルを確認する機能を実装するには、ログファイルが保存されたパスを読み込んで、VirtualFileオブジェクトを使用してファイルを読み込むことができます。

ログファイルの読み込みスクリプト例題

ボタンをクリックすると、該当パスに保存された最初のファイルを取得してTextAreaコンポーネントに表示する例題です。

this.Button01_onclick = function(obj:Button,  e:nexacro.ClickEventInfo)
{
	var strLogpath = nexacro.getLogFilePath();
    this.VirtualFile00.getFileList( strLogpath, ".log", VirtualFile.findFileOnly );
}

this.VirtualFile00_onsuccess = function(obj:VirtualFile, e:nexacro.VirtualFileEventInfo)
{
	switch (e.reason)
	{
		case 1:	// open
			this.VirtualFile00.read();
			break;					
		case 3:	// read
			this.TextArea00.set_value(e.textdata);
			break;
		case 8:	// getFileList
			var logfilename = logpath + e.fileattributelist[0].filename;
			this.VirtualFile00.open(logfilename,  VirtualFile.openText);
			break;
	}
}

Windows OSの実行時の制約

Windows OSでログファイルにアクセスするには、Environment filesecurelevelプロパティ値を「all」に指定する必要があり、最初実行時にサンドボックスウィンドウが表示されます。

Android OSの実行時の制約

Android OSでログファイルにアクセスするには、ファイルアクセス権限を設定する必要があります。

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
...
<provider			
    android:name="android.support.v4.content.FileProvider"			
    android:authorities="nexacro.launcher.fileprovider"			
    android:exported="false"			
    android:grantUriPermissions="true">			
    <meta-data			
        android:name="android.support.FILE_PROVIDER_PATHS"			
        android:resource="@xml/file_paths"/>			
</provider>

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <external-cache-path name="cache" path="."/>
    <external-files-path name="files" path="./"/>
</paths>