KeyAdvantage DMS Integration Software
User Manual
Adding, Modifying, and Deleting tasks
The DMS tool makes changes from your DMS to KeyAdvantage by user-defined tasks. Once you create a task, it will work continuously as designed unless you stop the service or you modify or delete the task.
Adding a Task
Complete the following steps to add a new task to the KeyAdvantage DMS integration tool.
1. From the KeyAdvantage DMS Integration window, do one of the following:
• Select Add from the Tasks menu.
• Click the
Add button.
• Right-click and select Add from the popup menu.
The Add New Task window displays (“Figure 3”).
6
Figure 3. Add New Task Window
2. Type a descriptive name for the new task in the Description text box.
3. From the DMS Type dropdown, select the system that your dealership uses.
4. To define the file path where the tool should look for the CSV file generated by your DMS, click Browse.
5. Navigate to the location of the CSV file and click Save.
Note: KeyAdvantage does not automatically delete vehicles that you have deleted from your DMS. However, the Automatically Mark All Missing Vehicles in KeyAdvantage checkbox does designate as Inactive all vehicles that have been removed from the DMS. If a vehicle does not exist in the CSV file but still has a tag assigned to it, the DMS tool will list it in the log file.
6. In the Department field, which is automatically populated from your KeyAdvantage database, select the department for the task. You can only select one department for each task.
7. Click Add.
Adding a Web API Task
Complete the following steps to add a new web API task to the KeyAdvantage DMS integration tool.
1. From the KeyAdvantage DMS Integration window, do one of the following:
• Select Add from the Tasks menu.
• Click the Add button.
• Right-click and select Add from the popup menu. The Add New Task window displays (“Figure 4”).
Figure 4 Add New web API Task Window
7
2. Type a descriptive name for the new task in the Description text box.
3. From the DMS Type dropdown, select WebAPI.
4. Click
Browse and select the template for the DMS type.
5. Type in the API Url provided by Supra.
6. Type in the user name and password provided by Supra.
7. Select from the Extract type dropdown.
Note: Bulk query will get all data from the DMS. Delta query will get only the newly changed data from the
DMS.
• If your extract type is Bulk, use this parameter with your Dealer ID (provided by Supra) at the end: qu eryId=InventoryVehicles&dealerId=[Dealer Id] Example: queryId=InventoryVehicles&dealerId=3PAUX
CDEV1
• If your extract type is Delta, use this parameter with your Dealer ID (provided by Supra) at the end: queryId=InventoryVehicles_Delta&deltaDate=[DateTime]&dealerId=[Dealer Id] Example: queryId=InventoryVehicles_Delta&deltaDate=[DateTime]&dealerId=3PAUXCDEV1
KeyAdvantage DMS Integration Software
User Manual
8. Add the interval hours.
9. In the Department field, which is automatically populated from your KeyAdvantage database, select the dealership or department for the task.
Note: You can only select one dealership or department for each task. If dealership is selected the vehicles will move to particular departmented mapped in template file. If department is selected all vehicles from API will move to selected department irrespective of vehicle type.
10. Click Add.
8
Modifying a Task
To modify a task, do the following:
1. From the KeyAdvantage DMS Integration window, select the task you intend to modify and do one of the following:
• Select Modify from the Tasks menu.
• Click the Modify button.
• Right-click and select Modify from the popup menu.
The Modify Task window displays (“Figure 4”), with information filled in for the task you have selected
to modify.
Figure 4. Modify Task Window
2. The Modify Task window allows you to change any of the following:
• Description—You can alter the name of the task.
• DMS Type—If your company changes Dealer Management Systems, you can change this selection.
• Template— You can choose the template for the task.
• File Path—You can revise the location where the tool should look for the DMS data file.
• Automatically Mark All Missing Vehicles in KeyAdvantage—You can check or uncheck this option.
• Department Assignment—You can change the department that is selected for the task.
3. When you have completed your changes, click
Save.
Modifying a Web API Task
1. From the KeyAdvantage DMS Integration window, select the task you intend to modify and do one of the following:
• Select Modify from the Tasks menu.
• Click the Modify button.
• Right-click and select Modify from the popup menu.
Note: The Modify Task window displays (“Figure 6”), with information filled in for the task you have selected to modify.
Figure 6. Modify WebAPI Task Window
9
2. The Modify Task window allows you to change any of the following:
• Description—You can alter the name of the task.
• DMS Type—If your company changes Dealer Management Systems, you can change this selection.
• Template— You can choose the template for the task.
• API Url— You can revise the DMS API Url.
• User name and Password—You can change the user name and password.
• Extract type— You can revise DMSi extracts data to your system.
• Parameters— You can change the extract type parameters.
• Interval— You can change how often DMSi runs the task.
• Dealership / Department Assignment—You can change the dealership or department that is selected for the task.
3. When you have completed your changes, click Save.
KeyAdvantage DMS Integration Software
User Manual
Deleting a Task
To delete a task from the tool, do the following:
1. From the KeyAdvantage DMS Integration window, select the task you intend to delete and do one of the following:
• Select Delete from the Tasks menu.
• Click the Delete button.
• Right-click and select Delete from the popup menu.
2. A dialog will display asking if you are sure you want to delete the selected task. Click Yes.
10
