Recently, the Duet Client Support Tool was released, a tool which allows you to easily and quickly verify parts of the Duet landscape and troubleshoot problems that occur on PCs or laptops running Duet. This blog walks you through the features of this tool.
Installing the tool
The installation of the tool is very easy, after you have downloaded it from here, you need to extract the .zip file and then run setup.exe from the PC or laptop on which your Duet client is installed (or, on which you plan to install the Duet client). The result will be a new icon in the task tray, looking like this:
Using the tool
Run Landscape Diagnostics Wizard
The Landscape Diagnostics Wizard executes calls to basic platform components to ensure they are working properly. To be precise, the wizard will go ahead and read the URLs from the DuetMetadata share on your Duet server (duetserverhostDuetMetadataDuetMetadata.xml) and then call the Service Mapper and Ticket Issuer component on the Duet Server, as well as the Service Provider (aka MetadataPublisher) on the Duet AddOn Server. So this wizard replaces the corresponding manual checks of Ticket Issuer, Service Mapper and Service Provider from my previous blog Checklist of activities for the Duet client installation. All you have to do is enter the hostname of your Duet server and press the “Test” button; the wizard will go and fetch the URLs and call them one by one.
In the screenshots above everything works fine and the Duet landscape is good to go in terms of those 3 components. In case something is not wokring properly, you will get a red alert icon next to the component which could not be tested successfully; clicking on “Details” gives you hints where to check what actually went wrong. In this case I changed the port of the Ticket Issuer URL from 50300 to 50301 in the metadata xml file. If you really want to see what is going on, use a network sniffer like YATT .
Another constellation could be that the tests for the Service Mapper and the Ticket Issuer are green, but the test of the Service Provider (Metadata Publisher) fails:
In this case, the most probable reason (apart from the AddOn server being down) is that the trust relationship between the Duet Server and the AddOn has not been configured properly. A look into the default trace file of the AddOn’s J2EE engine should give clarity.
Client Data Cache Viewer
The Data Cache Viewer provides a way to look into the content of the cached Web Service calls and the ability to purge the cached data, if needed.
The Duet client periodically calls a couple of Web Services in order to retrieve business data from the SAP backend system. This could be project codes for the Time Management scenario to track time on, or absence types for the Leave Management scenario, or… The following screenshot shows the response of the cached Web Service call for Leave Management which contains the the possible states a leave request can be in (Awaiting Approval, Rejected,…).
So if you are wondering why your Duet client does not show the desired data in the UI, you can use the Client Data Cache Viewer to see what the response of the respective call was.
Enable or disable logging
The next two entries in the tool’s context menu are Enable Logging and Disable logging. From Duet SP01 onwards, the log file for Duet is not automatically created in the Event viewer. By choosing “Enable logging”, a new entry for Duet will be created. Guess what happens if you choose “Disable logging”…
Kill ’em all
The Duet Client Support Tool also allows you to terminate processes; those are Outlook.exe, Winword.exe and the Microsoft.Duet.SystemTray.exe (aka the Duet Utility). Choosing “Kill All Duet Related Processes” will terminate all of them.
Clean Data Cache
The entry “Clean Data Cache” will delete all entries in the local data cache. The local data cache holds the list of of Web Service responses per scenario (see chapter “Client Data Cache Viewer”). By cleaning the data cache and then restarting the Duet Utility, you can force the Duet client to perform all of the cached Web Service calls again. So, let’s say you want to retrieve the project codes for time tracking again or the absence types for Leave Management, you should clean the data cache and restart the Duet Utility. This is a very handy feature, especially when you want to switch between time tracking profiles in the backend, or, in general, you change some customizing and want to see the effect immediately, and not wait until the Duet client performs the next cached call for the desitred Duet scenario.
Delete Deployment Key
This option deletes a registry key which controls the refreshing of metadata and the file cache. Choosing this option and restarting the Duet Utility, the client will update the metadata cache by performing the corresponding Web Service calls, as well as loading the metadata from the Duet Read Service and files from your duetserverhostDuetCode share. You should use this option if you regenerated and republished Duet metadata on the Duet Server.
Important: Due to a clientside bug, it can happen that after deleting the Deployment Key and restarting the Duet Utility, your Duet client becomes a so called “Secondary Client”. Although you can install the Duet client components on multiple computers, only one Duet client computer can synchronize with the SAP system. The components on this computer can process control messages and submit updates to the SAP system when connectivity to the system is available. On this computer, relevant information from the client database is also backed up to the currently logged on user’s Exchange mailbox. This computer is identified as the primary client computer. Typically, the first computer on which you install and configure the Duet client components becomes the primary client computer. Once a computer is configured as the primary client computer for a user, all subsequent installations of the Duet client components by the same user are treated as secondary; during the deployment process, these computers are automatically configured to function as the secondary client computers.
So, if you choose the option “Delete Deployment Key” and afterwards find yourself in this situation when right-clicking the Duet Utility tray icon:
you need to first shut down the Duet Utility, then run the “Promote Client Computer Tool” from the Duet Installation CD. Copy all the files and folders from the directory “CDMicrosoftIT Administrator FilesPromote Client Computer Tool” to your Duet client directory “C:Program FilesMicrosoft Information Bridge1.6Framework”. Then, on the command line, run the tool:
Now, when restarting the Duet Utility, your computer should be primary client again.
Clicking Exit in the menu will close the support tool. In order to start it again, you will need to run setup.exe.