Troubleshooting

View this page for | |

To facilitate troubleshooting and debugging, you can activate the SDK logging feature.

The SDK logging feature is activated according to the configuration of the application preferences.

Optionally, you can define the following keys:

HIDGlobal.ActivIDMobileSDK.Logging.Enabled

• Set the boolean value to "Yes" to enable logging to a file
• Set the boolean value to "No" to disable logging (default)

HIDGlobal.ActivIDMobileSDK.Logging.Level

• String value defining the logging level of the application when logging is enabled

• The possible levels are (in descending order of severity):

  • ERROR (error events)

  • INFO (useful information)

  • VERBOSE (useful events during software debugging when more granular information is needed)

• If the key is missing, or not defined with one of above values, the default level is INFO

HIDGlobal.ActivIDMobileSDK.Logging.LogFile

• String value containing the logging filename using the relative path to the application sandbox directory
• The string value may contain NSSearchPathDirectory enum by using percent sign (for example, %NSCachesDirectory%/Logs.txt)
• The default value when logging is enabled is %NSApplicationSupportDirectory%/ActivIdLogs.txt

Sample iOS/macOS Log Configuration (Swift)

// Enable troubleshooting logs only in debug
do {
try FileManager.default.url(for: .applicationSupportDirectory, in: .userDomainMask, appropriateFor: nil, create: true)
} catch {
printf("Create dir failed")
}
UserDefaults.standard.set("%NSApplicationSupportDirectory%/Logs.txt", forKey:"HIDGlobal.ActivIDMobileSDK.Logging.LogFile")
#if DEBUG
UserDefaults.standard.set(true, forKey:"HIDGlobal.ActivIDMobileSDK.Logging.Enabled")
#else
UserDefaults.standard.set(false, forKey:"HIDGlobal.ActivIDMobileSDK.Logging.Enabled")
#endif
UserDefaults.standard.set("VERBOSE", forKey:"HIDGlobal.ActivIDMobileSDK.Logging.Level")

Error Codes

The following error codes might be returned by the SDK.

Internal Errors

Credential Errors

Device Errors

Communication Errors

Transaction Errors