UniKey Assist Tool: Difference between revisions

Revision as of 14:05, 16 July 2012

UniKey Assist Tool

The UniKey Assist Tool allows users to easily view diagnostic information about a particular UniKey device, and is designed to aid the troubleshooting process on the end-user side. Output from the Assist tool can provide useful information and determine the functioning status of a connected UniKey device.

Note: If more than a single UniKey device is plugged in, the Assist tool will only query one of the devices. To ascertain accurate information, ensure only the concerned UniKey device is plugged in.

The Assist tool for UniKey STD, PRO and Time can be found within the UniKey SDK under the directory

UniKey SDK\Utilities\Assist\

The Assist tool for UniKey Drive can be found within the UniKey Drive SDK under the directory

UniKey Drive SDK\Utilities\Assist\

The Assist tool is split into two tabs, depending on the required scope of diagnostic tests to perform on a UniKey device:

Basic assist
Advanced assist

Basic Diagnostics

In the "Basic Info" tab, rudimentary information is returned, such as the Hardware ID (HID) and device type of the UniKey of a connected UniKey device.

To execute a basic diagnostic with a connected UniKey device, click [Check]. Below is an example screenshot of a successful basic diagnostic test.

Clicking [Copy] will copy the result contents to the clipboard. Any errors raised will be shown in the output.

Advanced Diagnostics

Detailed diagnostic information can be tested and returned in the "Advanced Info" tab. Including information from the basic diagnostic test, API functions within the UniKey device are tested.

Performing an advanced diagnostic test requires PW1 and PW2 to be entered, otherwise only basic diagnostic information is retured. Below is an example screenshot of a successful advanced diagnostic test.

Clicking [Copy] will copy the result contents to the clipboard. Any errors raised will be shown in the output.

Troubleshooting with UniKey Assist

see UniKey Hardware Troubleshooting#Troubleshoot UniKey with the UniKey Assist Tool

@@ Line 2: / Line 2: @@
 [[category:UniKey Tools]]
-This section contains UniKey Assist information including the following two parts:
+==UniKey Assist Tool==
-•	Basic assist
+The UniKey Assist Tool allows users to easily view diagnostic information about a particular UniKey device, and is designed to aid the troubleshooting process on the end-user side. Output from the Assist tool can provide useful information and determine the functioning status of a connected UniKey device.
-•	Advanced assist
+:Note: If more than a single UniKey device is plugged in, the Assist tool will only query one of the devices. To ascertain accurate information, ensure only the concerned UniKey device is plugged in.
-'''UniKey Assist''' is the testing tool that helps software vendors to trouble shoot issues at the end-user side.
+The Assist tool for UniKey STD, PRO and Time can be found within the UniKey SDK under the directory
-Pressing “Check” will start testing, and the result is shown in the Assist Information area.
+<code>UniKey SDK\Utilities\Assist\</code>
-“Copy” will copy all the result into clipboard.
-[[Image:UniKey_Assist_Tool_Pic01.jpg]]
+The Assist tool for UniKey Drive can be found within the UniKey Drive SDK under the directory
-'''Basic Assist''' is used to perform a basic/quick test. It will show if it can find a UniKey, and will display the manufacture date of the UniKey dongle.
+<code>UniKey Drive SDK\Utilities\Assist\</code>
-Basic Assist is made for a simple test, when end-users meet a “dongle not found” problem.
-Basic Assist also works with UniKey network functions.
-Apart from the basic assist, '''advanced assist''' can test UniKey APIs and show the version of the UniKey dongle. It will also show the type of UniKey.
+The Assist tool is split into two tabs, depending on the required scope of diagnostic tests to perform on a UniKey device:
-[[Image:UniKey_Assist_Tool_Pic02.jpg]]
+* Basic assist
+* Advanced assist
-In order to perform an advanced assist, password 1 and password 2 are needed.
+===Basic Diagnostics===
+In the "Basic Info" tab, rudimentary information is returned, such as the Hardware ID (HID) and device type of the UniKey of a connected UniKey device.
+To execute a basic diagnostic with a connected UniKey device, click [Check]. Below is an example screenshot of a successful basic diagnostic test.
+<!--Update-->[[Image:UniKey_Assist_Tool_Pic01.jpg|370px]]
+Clicking [Copy] will copy the result contents to the clipboard. Any errors raised will be shown in the output.
+===Advanced Diagnostics===
+Detailed diagnostic information can be tested and returned in the "Advanced Info" tab. Including information from the basic diagnostic test, API functions within the UniKey device are tested.
+Performing an advanced diagnostic test requires PW1 and PW2 to be entered, otherwise only basic diagnostic information is retured. Below is an example screenshot of a successful advanced diagnostic test.
+<!--Update-->[[Image:UniKey_Assist_Tool_Pic02.jpg|370px]]
+Clicking [Copy] will copy the result contents to the clipboard. Any errors raised will be shown in the output.
+== Troubleshooting with UniKey Assist ==
+:''see [[UniKey Hardware Troubleshooting#Troubleshoot UniKey with the UniKey Assist Tool]]''

UniKey Assist Tool: Difference between revisions

Joseph (talk | contribs)

Revision as of 14:05, 16 July 2012

Contents