Key Reader Integration

Check in and out vehicles to save you and your customer's time with ATMS GEN2.0's Key Reader integration. Retrieve a unit's fuel and mileage with a Key Reader in the following areas of the web application or mobile app:

  • adding a unit by key reader
  • editing a unit record
  • removing a unit from your fleet and returning a unit to the fleet
  • assigning a unit during the agreement process, and during unit exchanges
  • closing or close pending an agreement

ATMS GEN2.0 supports the KAI Key Reader service, which uses the unit's VIN, as well as the legacy Key Reader, which uses a .BIN file.

See "KAI Key Reader Implementation" for more information on getting started with and using the KAI Key Reader.

Setup Requirements for Key Reader

Note: Before performing these steps, verify that the KeyReader device has been configured to “write to the keypool.”

Before the KAI Key Reader can be fully integrated with the application, all locations at which the KAI Key Reader is to be used with ATMS GEN2.0 must be configured to interpret the information provided by the Key Reader.

  1. Verify that your KeyReader is connected to the KeyPool. The Key Reader at your loaner desk should already be connected to the KeyPool. To verify this, perform a KeyRead with any key using the Key Reader at your desk. Then, open ISPA Next on any PC in your dealership. The KeyRead should show up in the KeyPool. If not, please contact your ISPI Admin.
  2. Switch from the legacy GKI Key Reader to KAI WebService ATMS GEN2.0. In the ATMS GEN2.0 Management Hub (Admin Setup > Management tab), do the following:
    1. Find and edit () the management setting: BMW Key Reader Configuration. See "Management Hub" for more information about searching for and editing management settings.
    2. Select the KAI WebService option from the BMW Key Reader list. The DISTRIBUTION PRODUCT NUMBER and OUTLET NUMBER will have been filled in for you.
    3. If you want ATMS GEN2.0 to use the KAI Key Reader as the default provider of fuel and mileage data on agreements (as opposed to a Connected Car telematics device, for locations with Connected Car Integration), make sure the Prioritize Key Reader Data indicator () is turned on. ATMS GEN2.0 will only use data from the unit's Connected Car device if the KAI Key Reader fails to retrieve fuel and mileage data on agreements.
    4. If you want to lock the setting at a higher level (such as the dealer level), so it cannot be edited by a lower level (such as a dealer's locations), select the Locked toggle.
    5. Click SAVE.
    6. Fjnd and edit () the management setting: Allow Add Vehicle Manually. Make sure it is turned on (), as it is required to add new units with the KAI Key Reader. Click SAVE.

Key Reader Integration in ATMS GEN2.0

Note: ATMS GEN2.0 supports the KAI Key Reader service, which provides ATMS GEN2.0 with the latest physical Key Read for a specified VIN. While Key Reads are stored in the Key Pool for seven (7) days, ATMS GEN2.0 will only consider key reads within the last hour as valid. If a key read older than an hour, it will not be displayed and you have to read the key again.

When Key Reader integration is in use, the unit's current mileage and fuel is displayed when you add or edit a unit, assign a unit on an agreement or exchange, process a returning unit on an exchange, close an agreement, or close pend an agreement.

Navigation from your Home screen:   > New Unit by Key Reader

Note: KAI Key Reader: The ability to add a unit by Key Reader is only available for locations with Key Reader integration that can add units manually (Allow Add Vehicle Manually management setting is turned on).

  1. On the New Unit screen, enter a unique Unit Number, then type a VIN and press Tab to fill in some unit information, based on the VIN.1

  2. After you enter a VIN and leave the field, Key Reader data is retrieved for the unit's VIN. If key data is read successfully, a message is displayed with the current date and time as the Read Date. Click OK to return to the unit record with the mileage and fuel (if available) automatically filled in.2

    3. If key data was not retrieved or is invalid, a message is displayed with the option to TRY AGAIN or CANCEL (to return to the New Unit screen and enter a new VIN).

  3. Enter any remaining required information (*). Click CONTINUE, and do the same for local information.

    4. Note: The unit's Status is set to Ready and cannot be edited until the new unit is successfully added to the fleet.

  4. Enter required information about the unit's location and dates (*). Click CONTINUE.
  5. Click Save.
  6. For locations with rates set up, if a new unit's model is not yet associated with a Model Group, a brief message is displayed in the bottom-left corner of the screen: "You have X model(s) pending Model Group association." See "Model Groups (Rates setting)" for more information about associating models with Model Groups.

Navigation from your Home screen:   > EDIT.

  1. Find and view the unit record.
  2. On the Edit Unit screen, click REREAD KEY to retrieve the latest mileage and fuel (if available), provided by the KAI Key Reader service. If key data was not retrieved or is invalid, a message is displayed with the option to RETRY or manually enter the fuel and mileage (MANUAL ENTRY).
  3. Make your changes and click SAVE.

Navigation from your Home screen:   > EDIT > Remove From Fleet button

Note: Using the mobile app? See "Remove a unit from the fleet" in the Mobile Fleet Management topic.

  1. Find and view the unit record.
  2. Click Remove From Fleet on the side panel of the record. If the unit has already been removed from the fleet, click Return to Fleet to return the removed unit to the fleet.
  3. On the Edit Unit screen, the latest mileage and fuel (if available) is provided by the KAI Key Reader service. If key data was not retrieved or is invalid, a message is displayed with the option to TRY AGAIN or manually enter the fuel and mileage (MANUAL ENTRY). If you choose to manually enter the data, a REREAD KEY button becomes available under the fields.
  4. Verify the required information, marked with red asterisks (*), and click SUBMIT.
  1. When assigning a unit on an agreement or exchange:

    2. If you type the Unit Number of a unit that is assigned to another agreement at your location, you may be able to perform a Quick Return for that agreement, See "Perform a Quick Return" for more information.

    1. Click Select Unit to pull up a list of available units, sorted by Subsidy / Idle Days so you can prioritize usage.
    2. Type the full Unit Number, or enter part of the Unit Number and/or select a Model to filter and select from the list. You can sort the grid of units, as necessary.
    3. The latest mileage and fuel (if available) is provided by the KAI Key Reader service. If key data was not retrieved or is invalid, a message is displayed with the option to RETRY or manually enter the fuel and mileage (MANUAL ENTRY). If you choose to manually enter the data, a REREAD KEY button becomes available under the fields. See "Key Reader Integration" for more information.

    Note: If your location also uses TSD Telematics, data from the KAI Key Reader is used on the agreement instead of the Connected Car telematics device, as long as the Prioritize Key Reader Data option is selected in your BMW Key Reader Management setting in Admin Setup.

  2. Continue with the open agreement or exchange process, as applicable.

Troubleshooting the KAI Key Reader

If you receive the error message: "Key data was not retrieved or is invalid", do the following:

  1. Verify that you are using the correct VIN.
  2. Make sure that your KeyRead is not outdated. Remember that ATMS GEN2.0 only accepts KeyReads which are less than 1 hour old.
  3. Verify that you can see the KeyRead in ISPA Next. If the KeyRead does not show up in ISPA Next, please contact your ISPI Admin.
  4. If the KeyRead shows in ISPA Next, but not in ATMS GEN2.0, please contact your TSD support team at support@tsdweb.com.