Integration Testing Kadoe Client

This FAQ is a step-by-step guide to integration testing a new installation of Kadoe Client.

Before you begin your day-to-day operations of Kadoe Client, we recommend you perform a thorough integration test. 

This will give you confidence that Kadoe Client is operating correctly, and that it can integrate with your business processes and computer systems.

Integration testing enables you to:

  • familiarise yourself with how the software works
  • validate the format and content of your import files
  • verify your connection to our service
  • ensure that your back-office systems can read Kadoe Client's export files
  • test that your back-office systems write import files to (and read export files from) the appropriate folder locations
  • check that your import and export schedulers are operating normally
  • confirm that your program configurations are imported correctly, if you are upgrading from VKI

Integration testing is especially important for customers:

  • who are upgrading from Kadoe Client's predecessor software, VKI
  • who have back-office computer systems that supply data to, or consume data from, Kadoe Client
  • who operate Kadoe Client in one of its automated modes.

On first install, Kadoe Client is initially configured to run in test mode, to assist you with your integration testing. 

In test mode, you may input or import as many vehicle enquiries as you wish, and send them to our service for processing.  Instead of forwarding the enquiries to the DVLA, our service will generate a dummy response for each enquiry and make this available to you.  After a short delay, you can receive your dummy data, view the responses, and export the response data to files. 

Once you are happy with your integration testing, you can switch off test mode and Kadoe Client will run normally.

 

 

Firstly, install Kadoe Client on your chosen computer and run the first-time setup wizard.  The Getting Started FAQ will show you how. Then perform the following steps in order:

  1. Test Kadoe Client in manual mode
  2. Configure your back-office systems to support Kadoe Client's file formats
  3. Test the import functionality
  4. Test the export functionality
  5. Test Kadoe Client in automatic mode

Then, once you are happy, switch off test mode and Kadoe Client is live.

  1. Log in to Kadoe Client using the default username and password.
  2. From the Main Menu, click the Vehicle Enquiries button.
  3. On the Vehicle Enquiries screen, click Add New Enquiry.  You may enter as many test vehicle enquiries as you wish.  Click Cancel Add when you are done.
  4. Click Close to return to the Main Menu.
  5. From the Main Menu, click the Send & Receive button.
  6. On the Connection to Kadoe Service screen, click the Send / Receive Now button.
  7. Your enquiries will be sent to the Kadoe service.  Kadoe service will detect that you are running in Test Mode, and will generate dummy responses for your enquiries.  There is a delay of around 20 minutes before your responses can be downloaded.
  8. After 20 minutes, click the Send / Receive Now button again.  Kadoe Client will download your dummy responses.
  9. From the Main Menu, click the DVLA Responses button to view your dummy response data.

To make use of Kadoe Client's automation functions and integrate it with your back-office systems, you will need to configure these systems to support Kadoe Client's file formats and file naming conventions.

A complete schema definition of the Import and Export file formats can be found in the Appendix to the User Guide.  Download it here.  You will also need to configure your systems to write Import files to, and read Export files from, the Import and Export folders you chose for each Enquirer during setup.

Users upgrading from VKI should note that the new file formats are similar to the old, but with additional data data fields appended to each row.  The import file now has data fields for the Enquirer Id, Enquiry Code and Intermediary Id.  The export file includes some additional response data that wasn't available in the old format, such as Date of Export (for vehicles that have been exported overseas) and Date of Scrapping (for vehicles that have been scrapped).  

Begin by invoking the import process manually, before you attempt to import data automatically.

Create one or more enquiry import files and save them to the appropriate import folder.

Log in to Kadoe Client, open the Vehicle Enquiries screen and click Import.  If you have more than one Enquirer, you will be prompted to choose the Enquirer you are importing the enquiry data for. 

Then choose the enquiry import file you wish to import and click Open.  Remember that Kadoe Client requires the filename to be in the format VQ3*.IMP (where * represents any character or set of characters).

Kadoe Client will process the import file row-by-row, validating the format of each row and the data contained within it. 

When it encounters a row containing invalid data, Kadoe Client will ask you what to do.   You can choose to:

  • Continue and include the invalid enquiry
  • Continue but skip the invalid enquiry
  • Cancel the whole import

If the import process succeeds, you will be informed of how many enquiries were imported.  The enquiry data is now ready to view.

First of all, visit the Vehicle Responses screen and make sure you have some vehicle response data to export.  (If you don't, invoke the Send & Receive process).

On the Vehicle Responses screen, click the Export button.  If you have more than one Enquirer, you will be prompted to choose the Enquirer you want to export data for.

In Windows Explorer, visit the Export folder for the appropriate Enquirer.  Verify that a file exists with a name such as VQ7*.EXP (where * is a date and timestamp).  You can examine the file by right-clicking on it, and choosing Open with -> Notepad.

Kadoe Client can run in one of two automatic modes, in order to integrate directly with your back-office systems:

  • Autoexecute mode - a fully automatic pass-through mode, where data files are imported and exported automatically on a schedule
  • AutomateImport mode - a semi-automatic mode, where data files are imported and exported whenever the Send & Receive process is invoked

If you are using Kadoe Client in either of these modes, you should test the end-to-end process fully.

First, make sure you have:

Next, make sure you have the correct setting in your Kadoe.ini file.  If you are upgrading from VKI, this will be done automatically for you.

  • Options=Autoexecute

You also need to ensure there is at least one import file in the appropriate import folder.

Log in to Kadoe.  Kadoe will launch in Autoexecute mode.  Click on the Kadoe icon in the Windows taskbar to view the Autoexecute scheduler.

Choose the run times for the first scheduler (the "Import and send enquiries..." scheduler) by clicking its Settings button.  If you are upgrading from VKI, your existing settings with be retained for you.

Set the scheduler to run at a time in the near future, then click OK.

The Next run time will be updated accordingly. 

Tick the box to start the scheduler.  When the scheduled time passes, the scheduler will run, and the following steps will take place:

  1. Any import files in your import folders are processed into enquiries (and the files are then deleted).
  2. All outstanding enquiries are sent onward processing. 
  3. All outstanding responses are received
  4. All outstanding response data is written to your export folders.

You can verify that these steps have taken place by examining the log data.

If there was any response data outstanding, one or more files will be written to your export folder(s). 

If not, set the scheduler to run again in 20 minutes time.  After 20 minutes, our service will have generated dummy response data for you which the scheduler will then download and export.

Before you do, note that AutomateImport mode is mutually exclusive with Autoexecute mode.  Ensure that you are not running in Autoexecute mode. You should also be sure that you have:

To run in AutomateImport mode, make the following setting in your Kadoe.ini file (this will be done automatically if you are upgrading from VKI):

  • AutomateImport=Yes

Ensure there is at least one import file in the appropriate import folder.

Log in to Kadoe and go to the Send & Receive screen.  Choose Scheduled connection to the service

You can choose run times for the first scheduler (the "Send enquiries..." scheduler) by clicking its Settings button.  If you are upgrading from VKI, your existing settings with be retained for you.

Set the scheduler to run at a time in the near future, then click OK. The Next run time will be updated accordingly. 

Tick the box to start the scheduler.  When the scheduled time passes, the scheduler will run, and the following steps will take place:

  1. Any import files in your import folders are processed into enquiries (and the files are then written to an Archive folder).
  2. All outstanding enquiries are sent onward processing. 
  3. All outstanding responses are received
  4. All outstanding response data is written to your export folders.

You can verify that these steps have taken place by viewing the Transmission Log from the Main Menu.

If there was any response data outstanding, one or more files will be written to your export folder(s).  If not, set the scheduler to run again in 20 minutes time.  After 20 minutes, our service will have generated dummy response data for you which the scheduler will then download and export.

If you are using our software for the first time, please follow the steps below to switch Kadoe Client out of test mode. 

However, if you are upgrading from VKI to Kadoe Client, the timing is important, and you must run Kadoe Client as AdministratorPlease see here.

Switch Kadoe Client out of test mode

  1. Log in to Kadoe Client
  2. Visit the Admin Functions screen, Kadoe Client tab
  3. Change the Run in TEST mode option to NO
  4. Click OK.  You will see a dialog advising you that you are switching off Test mode.
  5. Click OK again to exit Kadoe Client
  6. Restart Kadoe Client
  7. Navigate through the setup wizard as before
  8. Kadoe Client deletes all your test enquiry and test response data
  9. Kadoe Client is now live.  From now on, any enquiries you send will be communicated to the DVLA.