Troubleshooting

View this page for | |

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

HID Approve SDK uses NLog to implement logging. As demonstrated in the sample application, logging can be configured by using a standard NLog configuration file to specify the logging parameters. Alternatively, you can also configure NLog programmatically using the NLog.Config.LoggingConfiguration API.

The configuration file can be stored in either:

• In the executable's working directory

• As an injected dependency where NLog will search for the file with the following naming rules:

  • A standard application configuration file (for example, <applicationname>.exe.config)

  • The <applicationname>.exe.nlog file in the application’s directory

  • The NLog.config file in the application’s directory

  • If NLog isn't installed in the .NET Global Assembly Cache (GAC), the NLog.dll.nlog file in the same directory location as NLog.dll

When configuring NLog, it is recommended setting the user's 'LocalApplicationData' directory dedicated to your application as the location for the application logs (where \78A93DD0-94DE-4CA0-8080-95746C379535\ApproveSDK\logs is the output variable defined by the application).

For example, C:\Users\%username%\AppData\Local\Packages\%application_pfn%\LocalCache\78A93DD0-94DE-4CA0-8080-95746C379535\ApproveSDK\logs

<?xml version="1.0" encoding="utf-8" ?>
<!-- XSD manual extracted from package NLog.Schema: https://www.nuget.org/packages/NLog.Schema--><nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    autoReload="true">  <!-- the targets to write to -->
  <targets>
    <!-- write logs to file -->
    <target xsi:type="File" name="logfile" fileName="${specialfolder:folder=LocalApplicationData:cached=true}\78A93DD0-94DE-4CA0-8080-95746C379535\ApproveSDK\logs\ApproveSdk.log"
            layout="${longdate}|${processname}|${threadid}|${level}|${logger}|${message}|${all-event-properties} ${exception:format=tostring}" />
    <target xsi:type="Console" name="logconsole"
            layout="${longdate}|${processname}|${threadid}|${level}|${logger}|${message} |${all-event-properties} ${exception:format=tostring}" />
    <target name="debugger" xsi:type="Debugger" 
            layout="${longdate}|${processname}|${threadid}|${level}|${logger}|${message} |${all-event-properties} ${exception:format=tostring}" />
  </targets>  <!-- rules to map from logger name to target -->
  <rules>
    <logger name="*" minlevel="Trace" writeTo="logfile,logconsole,debugger" />
  </rules>
</nlog>

Error Codes

The following error codes might be returned by the SDK.

Internal Errors

Credential Errors

Device Errors

Communication Errors

Transaction Errors