Log Files
Logging information is displayed in the Log area and can be sent by e-mail to your administrator.
Logging is enabled by default after installing CRM.Client, the log level is automatically
set to Warning
.
Log files can be viewed as follows:
- In the Log area of the control center. You can send the log file by e-mail, reset the log file or query the available databases (SQL statements).
- If login was not successful, by tapping on (Settings) and selecting View Logs.
The content of the log file is displayed:
The user can reset the logged information content (Reset Log File) or send it by e-mail (Send Log File).
You can define the following behaviour using the Web Configuration parameters:
- When an error occurs, a button is displayed in the pages with which the user can send the e-mail, see SendErrorReport.
- Additional information such as screenshots etc. is included in the sent data, see SendErrorContextInfo.
Overruling Default Log Settings in the CRM.Client
In addition to the Log area in the CRM.Client's control center, more logging options are available for CRM.Client users in iOS and Windows 10 devices. These options are available for each user and can help detect problems and troubleshoot issues. For example, the Support Center can ask the user experiencing problems to change the log level (for example, to track a specific error or when no access to the CRM.designer database is available) and then to e-mail the log file to the Support Center agent.
Only set these options for testing purposes or to locate the cause of errors, as each enabled item increases the data transfer and, therefore, can lead to performance problems.
The iOS device user must switch to the device settings () and tap on CRM.Client icon to enable these additional settings.
Windows Desktop and Mobile users can configure these settings in the
log-settings.json file located at <Drive
Name>:\Users\<user>\AppData\Local\Packages\
178E3AFA.AureaCRMClient_********\LocalState
. Where <user> is the name of
the user configured on the Windows 10 device, and <Drive Name> for example is
C
or D
.
-
Override Server Log Level: If set to
ON
, only options set toON
of the available log options are logged. (default:OFF
) -
Log Level: Defines which occurrences are written to the log
file. Takes the log levels values from
0
to3
, where:0
-None;1
-Error (Default);2
-Warning;3
-Info. Overrides the settings in the web configuration parameter Log.Level. -
SQL Log: SQL statements of the local database are logged.
(default:
OFF
) -
Request Log: Server requests (sent and received) are logged.
(default:
OFF
) -
Config Log: Configuration items (loaded or used) are logged.
(default:
OFF
) -
Network Log: General network communication is logged.
(default:
ON
) -
Result Log: Each result row is logged. (default:
OFF
) -
UpSync Log: UpSync requests are logged. (default:
OFF
)
The following sample shows the log-settings.json configuration settings for Windows 10.
{"OverrideServerSettings":false,"LogLevel":1,"LogClass":"","LogConfig":false,
"LogMethod":"","LogNetwork":true,"LogRequests":false,"LogResults":false,
"LogStatements":false,"LogUpSync":false}