TEST FILES ............................................................................................................................ 8
5
FAILURE PROCESS .............................................................................................................. 8
Document Title: Dealer's Own Website User Guide Version: 1.0
Page 2 of 8 Last Saved: 21/01/2008
Dealer’s Own Website
1
User Guide
Introduction
The purpose of this document is to provide the technical information required by a publisher to retrieve a data extract from Dealer Exchange. Once a dealer has activated the “Dealer’s Own Website” publishing option in Dealer Exchange, HPI will create an FTP account for the dealer. This will enable the dealer’s website agent to retrieve a data file containing a nightly extract of the dealer’s selected stock. The topics covered in this document include: 1. Dealer activation process 2. Details of the record layout for the data feed to include: •
Field names
•
Field definition
•
Field format/length
•
Field examples
3.
Test files
4.
Failure Processes
Document Title: Dealer's Own Website User Guide Version: 1.0
Page 3 of 8 Last Saved: 21/01/2008
Dealer’s Own Website
2
User Guide
Dealer Activation Process
The dealer will activate the publishing option of “Dealer’s Own Website” within the Exchange system. Part of this process will include the input of an email address which will be used for communications relating to this publishing channel. This may be the email address of the agency managing the dealer’s own website. HPI will complete internal set up for the dealer, including the creation of an FTP account unique to them. The username and password will be sent to the email address input by the dealer within the activation process. Please allow 1 working week for HPI to complete internal set up before using the dealer’s FTP account. Generic test files will be available for use at all times – details are given later in this document.
Document Title: Dealer's Own Website User Guide Version: 1.0
Page 4 of 8 Last Saved: 21/01/2008
Dealer’s Own Website
3 3.1
User Guide
Details of Record Layout Data Extract Workflow From Monday to Friday (excluding bank holidays) a process will be put in place to extract all active stock records for the dealer which the dealer has flagged for inclusion. This process will run between 6pm and 8am. At the end of the process a single csv file containing this data will be saved to the FTP folder created for the dealer. The file will be a full refresh of the customer’s stock data every night. The server address to gain access to the file containing the stock extract is: ftp.hpiexchange.com The user name and password will be as notified during the FTP activation process, allocated by HPI to the dealer (or email contact provided) The file naming convention will be: HPIDOW.csv
Notes: •
The output file will be in .csv format o
CSV files are comma-delimited text files that can be imported directly to most spreadsheet packages and databases. Columns are separated by commas, and values, particularly those likely to contain commas, are included in double quotes.
•
Column headings will be provided.
•
The sequence of columns is fixed.
•
Image URLs will be included in the output but jpeg images will NOT be provided. Between 1 and 12 image URLs will be provided.
•
The extract file is a standard format and cannot be tailored to individual requirements.
Document Title: Dealer's Own Website User Guide Version: 1.0
Page 5 of 8 Last Saved: 21/01/2008
Dealer’s Own Website
3.2
User Guide
Stock Extract File Layout
All fields will be populated with data where HPI holds a value against the individual stock item Column Seq.
Field
Field Description
Field Type
Max Size
Example
01
Stock ID
Stock Vehicle Id
NUMERIC
7
1099450
02
VRM
The vehicle registration mark
CHAR
7
H331WYR
03 04
Manufacturer Model
Make Description Model Description
CHAR CHAR
30 30
Land Rover Freelander
05
Trim
Trim Description
CHAR
30
Td4 ES
06
Door
Door Plan Description
CHAR
10
5 Door
07
Body
Body Type Description
CHAR
50
Estate
08
Colour
Colour
VARCHAR
100
Red
09
Transmission Speed
Transmission Description
CHAR
20
5 speed
10
Transmission Type
Transmission Type
CHAR
20
Manual
11 12
Fuel Type Engine Size
Fuel Type Engine Size (Cubic Cms)
CHAR INT
20 4
Diesel 1951
13
Year of manufacture
The year the vehicle was made
CHAR
4
2002
14
Reg letter/number
The year indicator from the vrm
CHAR
2
52
15
No. of keepers
Total number of keepers including the current keeper
SMALLINT
2
2
16
Price
Retail Price
DECIMAL
15
16000
17
VAT qualifying indicator
Indicates whether VAT is applicable.
CHAR
1
N
18
Mileage
Stated Mileage
NUMERIC
6
24000
19
1st registration date
Date the vehicle was first registered
DATE
10
25/11/2002
20
Vehicle description
Full Vehicle Description
VARCHAR
150
Land Rover Freelander 2.0 Td4 ES 5 Door Estate
21
Narrative
Dealer defined description of vehicle. Enclosed in double quotes
CHAR
300
“This is a very clean vehicle, garaged with full Land Rover service history”
22
Standard Options
Standard manufacturer options
VARCHAR
100
“Deadlocks, Immobiliser, PowerAssisted Steering, Adjustable Steering Column, Side Protection Mouldings, Adjustable Lumbar Support, Leather Interior, Alloy Wheels, Driver's Air Bag, Centre Rear Seat Belt”
VARCHAR
100
“Satellite Navigation, Cup Holder”
Maximum size will be 100 char * no. of options, comma separated and enclosed in double quotes. 23
Additional Options
Any additional options that have been added to the vehicle Maximum size will be 100 char * no. of options, comma separated and enclosed in double quotes.
Document Title: Dealer's Own Website User Guide Version: 1.0
Document Title: Dealer's Own Website User Guide Version: 1.0
Page 7 of 8 Last Saved: 21/01/2008
Dealer’s Own Website
4
User Guide
Test Files
Generic test files are available for use at all times at the following location: www.hpi.co.uk/tw-static/exchange/dowtestfiles
Three test data files are provided with static content: HPIDOWtest1.csv HPIDOWtest2.csv HPIDOWtest3.csv They will be permanently available so that any agency wishing to start tests against files before the FTP account becomes live, or if they prefer not to use live data for testing, has access to a file of the correct format. The 3 files will differ in contents slightly to emulate the addition, amendment and deletion of vehicles in Exchange over time. No username or password is required to access these files
5
Failure Process
In case of any issues with the extract file, please contact the HPI Help Desk on 0870 8448440.
Document Title: Dealer's Own Website User Guide Version: 1.0
