ispa validator manual

7/21/2019 Ispa Validator Manual

1/24

This manual decribes the installation, the handling and the error analysis for validation of theDMS integration with ISPA Next ISPA Mobile

ISPA Next / ISPA MobileValidator

Installation and UserManual


2/24

!M" #rou$ Page %

ISPA Next & ISPA Mobile 'alidator ( Installation and )ser Manual of %*

List of contents

1. Introduction 4

++ Pur$ose of This Document *

+% Target #rou$ for this Document *

+ Structure of This Document *2. Installation and Uninstallation 5

%+ System re-uirements .

%% /xecution of the 'alidator .

% Installation .

%* )ninstallation .

. Usa!e "

+ Prere-uisites 0

% Starting the ISPA Next & ISPA Mobile 'alidator 0

DMS 1on2guration 3

* Test 1ase /xecution +4*+ /x$lanation of the Test 1ase )I +4

*% /xecuting the 5irst Test 1ase ++

* /xecuting DMS Test 1ases +%

** /xecuting 1onnectivity Test 1ases +

*. Dealing with 5ailed Test 1ases +.

. 6og 5ile Download +0

0 1reate and download Test 7e$ort +3

3 Pre81on2guring the ISPA Next & ISPA Mobile 'alidator +9

4. Lo! #ile $escri%tion 2&

*+ :rgani;ation of the log 2les %4

*++ :verall organi;ation within the log


3/24

!M" #rou$ Page


List of '!ures

5igure +> ISPA Next & ISPA Mobile 'alidator startu$ screen0

5igure %> DMS con2guration screen DMS and Dealer Data3

5igure > DMS connection error9

5igure *> Test case selected+45igure .> The ?5etch DMS 1on2guration? test case has been com$leted successfully++

5igure 0> The ?)$date 1ustomer Data? test case has been executed sucessfully+

5igure 3> Dealer $ortal test case+*

5igure @> /rror when executing the ?1reate 'ehicle? test case+.

5igure 9> Test results and log 2les view+0

5igure +4> 1reate test re$ort view+3

5igure ++> log 2les /xam$le of resultstxt 2le+@

5igure +> Is$a'alidator$ro$erties 2le+9

5igure +*> :verall log 2les organi;ation%45igure +.> 6og 2le organi;ation within a test grou$ with all test cases successful%4

5igure +3> /xam$le of 2le dmscleanu$txt%+

5igure +@> Test case log 2le header%%

5igure +9> 7e-uest & res$onse log structure%%

5igure %4> 7e-uest & res$onse log exam$le%

5igure %+> DMS communication error exam$le%

5igure %%> 6og event structure%*

5igure %> A short extract from the overall log 2le %*

7elease +.4 1o$yright = !M" A#


4/24

!M" #rou$ Page *


1. Introduction

1.1 Pur%ose of ()is $ocu*ent

The ISPA Next & ISPA Mobile 'alidator is a tool that allows to verify that the re-uirements foro$erating ISPA Next and ISPA Mobile are met The 'alidator visually guides through test casesthat checB the availability of the im$lemented DMS interface and central !M" services Themain focus of the 'alidator is to test if the DMS has correctly im$lemented the ISPA interfacethat is re-uired by the ISPA a$$lications ISPA Next and ISPA Mobile

The $ur$ose of this document is to $rovide users of the ISPA Next & ISPA Mobile 'alidator withthe means to eCectively use the 'alidator This document describes how to install, uninstall anduse the ISPA Next & ISPA Mobile 'alidator

1.2 (ar!et +rou% for t)is $ocu*ent

The target grou$ for this document are IT administrators with good Bnowledge of the ISPA

interfaces and the DMS used

1. Structure of ()is $ocu*ent

1ha$ter + $rovides a general overview over this document

1ha$ter % describes the installation, uninstallation and system re-uirements of the ISPANext & ISPA Mobile 'alidator

1ha$ter $rovides a descri$tion of how to use the ISPA Next & ISPA Mobile 'alidatorandhow to create and download the Test 7e$ort

1ha$ter * $rovides a descri$tion of how to read and inter$ret the ISPA Next & ISPA Mobile'alidator log 2lesincluding the list of test entries created in your DMS

1ha$ter . lists !M" su$$ort contacts



5/24

!M" #rou$ Page .


2. Installation and Uninstallation

2.1 S,ste* re-uire*ents

The following system re-uirements must be met for an installation of the ISPA Next & ISPAMobile 'alidator>

"indows 3 or @+, "indows Server %4+% 7% both x@0 E x0* systems are su$$ortedF

.+%M! 7AM exclusively for the ISPA Next & ISPA Mobile 'alidatorF

.44M! free hard disB s$ace for the a$$lication and the logs

2.2 xecution of t)e Validator

It is recommended to $erform the 'alidator test cases for DMS integration outsideof normal business hoursG

/xecuting the test cases may considerably reduce the overall $erformance of all

your connected systems and a$$lications

2. Installation

)n;i$ the is$a8validator8+44;i$2le anywhere on your com$uter This will create a is$a8validator8+44folder

Switch to this folder and execute the is$a8validator8+44exe 2le to start the ISPA Next &ISPA Mobile 'alidator

2.4 Uninstallation

1lose the ISPA Next & ISPA Mobile 'alidator if it is running

Delete the is$a8validator8+44folder



6/24

!M" #rou$ Page 0


. Usa!e

.1 Prere-uisites

Please maBe sure that

the device the 'alidator is installed on, has access to the DMS and the internet

you Bnow your $roxy server )76 and credentials, if you use a $roxy server

you have your DMS )76 and credentials as well as your dealer $ortal S8#ate orDealerS$eedF credentials at hand

.2 Startin! t)e ISPA Next / ISPA Mobile Validator

Switch to the is$a8validator8+44folder created during installation and execute the is$a8validator8+44exe 2le to start the ISPA Next & ISPA Mobile 'alidator

The ISPA Next & ISPA Mobile 'alidator startu$ screen is dis$layed>

Figure 1: ISPA Next / ISPA Mobile Validator startup screen

Select your language and clicB on HStart ISPA 'alidator to start the 'alidator

If you want to start the validation of your DMS interface im$lemented, continue withcha$ter

:therwise, if you only want to test the connectivity of Hother systems sBi$ the HDMSand Dealer Data con2guration and select HTest #rou$ 3> 1onnection to other systemsdescribed in cha$ter **



7/24

!M" #rou$ Page 3


. $MS on'!uration

The following5igure %shows the DMS and Dealer Data con2guration screen>

Figure 2: DMS confguration screen DMS and Dealer Data

/nter the )76 of your DMS 5or exam$le> htt$s>&&some8dms8host&dmsF

If your DMS re-uires authentication information, $rovide the access data The access

data are not mandatory and s$eci2c for each DMS )ser ID

1om$any

!ranch & :utlet

"orB$lace ID

Password

Provide the language your DMS uses for exam$le> en8#! or de8D/F

Provide your !M" dealer data>

"arranty Dealer Number !uNo, . digitsF

Distribution Partner Number . digitsF

:utlet Number % digitsF If your com$any uses a $roxy, $rovide the $roxy server credentials The $roxy server

credentials are not mandatory

https://some-dms-host/dmshttps://some-dms-host/dms


8/24

!M" #rou$ Page @


Jost for exam$le> htt$s>&&$roxy8server8host& F

Port

)ser ID

Password

1onnect to DMS via $roxy Now clicB on button H1hecB DMS 1onnection to veri2y that the DMS con2guration is

correct and to start the Test case execution If the 'alidator is not able to connect to youDMS you will see an error message see 5igure F Please double checB that thecon2guration data you have entered is correct If the 'alidator is still note able toconnect you can download the test logs and analyse the $roblem see cha$ters 0F

Figure : DMS connection error

"hen you close the a$$lication the DMS and dealer data are saved in acon2guration 2le on harddisB

The next time you start the ISPA Next & ISPA Mobile 'alidator the con2gurationvalues are read from this 2le so that you do not have to reenter all data

The 2le can also be used to $recon2gure the ISPA Next & ISPA Mobile 'alidatorbefore $roviding it to a dealershi$ see cha$ter 3F

https://proxy-server-host/https://proxy-server-host/


9/24

!M" #rou$ Page 9


.4 (est ase xecution

.4.1 x%lanation of t)e (est ase UI

The following5igure *shows the test case view with the test case of the 2rst test grou$selected

Figure !: "est case selected#

:n the left hand side, you can see the list of available test grou$s :n the right hand side, youcan see the content of the currently selected test case

Kou can navigate arbitrarily between test grou$s by clicBing on the test grou$ titles> The test grou$ that contains the currently selected test case will stay o$en

If you clicB on another test case, this test case will become active and itLs contents willbe dis$layed on the right hand side

At the bottom of the window there are two buttons HPrevious and HNext which you canuse to navigate between test cases

HPrevious will select the test case that comes before the currently selected test caseand HNext will select the next one

The last entry in the test grou$ list is HTest results This entry $rovides an overviewover the status of the test cases and a convenient way to save the test logs andgenerate a test re$ort See cha$ter F



10/24

!M" #rou$ Page+4


.4.2 xecutin! t)e #irst (est ase

The 2rst test case, H5etch DMS con2guration, is re-uired for executing the DMStest cases

1licB on HNext to start the test case execution

A success message should a$$ear 1licB on HNext to successfully com$lete this testcase and $roceed to the next test case See 5igure .F

If an error occurs, a message ex$laining the cause of the error will be dis$layed Seecha$ter F

Kou can clicB on HPrevious to re8do the failed test case or on HNext to marB the currenttest case as failed and $roceed to the next one

Figure $: "%e &Fetc% DMS 'onfguration& test case %as been co(pleted success)ull*

.4. xecutin! $MS (est ases

The DMS test cases will create and read data such as customer , vehicle or order data from andto your DMS

5irst and foremost $lease note that some test cases de$end on others

/xam$le>

In the HManage 1ustomers test grou$, the H1reate customer test case should beexecuted before the HSearch 1ustomer test cases so the newly created testcustomer can be searched for Most test cases such as the HSearch 1ustomer testcases can be sim$ly ste$$ed over if failed or if you do not want to execute them



11/24

!M" #rou$ Page++


Kou will always being noti2ed, if a another test grou$ has to be excuted $rior to theexecution of a subse-uent test caseG

Some test cases will dis$lay data fetched from the DMS and asB you whether the data returnedby the DMS is correct see 5igure 0F

1licB on HKes to con2rm and the test case is marBed Hsuccessful

:therweise clicB on HNo to marB the test case Hnot successful

Therefore always checB your DMS whether the data dis$layed by the 'alidatorcorres$onts to the data stored in your DMS

:herwise there might be a mismatch in the ma$$ing of your DMS interfaceim$lementationG

Figure +: "%e &,pdate 'usto(er Data& test case %as been executed sucess)ull*

.4.4 xecutin! onnecti0it, (est ases

The test grou$ H1onnection to :ther Systems contains test cases that checB connectivity tosystems such as !M" 1oSy for vehicle images or to your dealer $ortal S8#ate andDealerS$eed

These tests re-uire Internet or !M" 1or$orate NetworBF connectivity and do not interact withthe DMS

5igure 3shows the dealer $ortal test case with S8#ate selected 5or the dealer $ortal test case,you need to $rovide valid credentials for your dealer $ortal



12/24

!M" #rou$ Page+%


Figure -: Dealer portal test case



13/24

!M" #rou$ Page+


.4.5 $ealin! it) #ailed (est ases

If a test case fails, an error message will be dis$layed that indicates the cause of the error see5igure @F Kou have the following o$tions to deal with a failed test case>

1licB on HPrevious to re8run the test case, $ossibly while su$$lying corrected data 1licB on HNext to marB the current test case as failed and continue with the next test

case

Download the test logs and analyse the $roblem see cha$ters 0and *F

Figure .: rror 0%en executing t%e &'reate Ve%icle& test case



14/24

!M" #rou$ Page+*


.5 Lo! #ile $onload

1licB on HTest 7esults title at the end of the test case list

The HTest 7esults and 6og 5iles view will o$en, $roviding you with an overview of the ofthe test status See 5igure 9FIf you walB through the test suite in order, this screen will be dis$layed automaticallyafter com$leting the last test case

Figure : "est results and log fles ie0

At the bottom right you can 2nd the button HSave log 2les 1licB on that button

A folder selector o$ens Select the folder where you want to store the log 2les

A


15/24

!M" #rou$ Page+.


Figure 13: 'reate test report ie0

Provide your dealer name and your city

To save the test re$ort clicB on the HSave button at the bottom right

A folder selector o$ens Select the folder where you want to store the test re$ort

A

The log 2les for each test case executed for details $lease refer to cha$ter *F

Figure 11: log fles 4IP created

A 2le named Hresultstxt containing name and city you $rovided before and anoverview of all test cases and whether they have been executed or not>



16/24

!M" #rou$ Page+0


Figure 12: xa(ple o) results#txt fle



17/24

!M" #rou$ Page+3


.3 Preon'!urin! t)e ISPA Next / ISPA Mobile Validator

The ISPA Next & ISPA Mobile 'alidator saves its con2guration in a 2le named

HIs$a'alidator$ro$erties in the is$a8validator8+44folder This 2le can be used to $re8con2gure the ISPA Next & ISPA Mobile 'alidator before $roviding it to a dealershi$

To generate the HIs$a'alidator$ro$erties 2le you have to start the ISPA Next & ISPAMobile 'alidator, enter the DMS and dealer data see cha$ter F and $ress H1hecBDMS 1onnection

"hen you close the a$$lication the ISPA Next & ISPA Mobile 'alidator creates theHIs$a'alidator$ro$erties 2le This 2le contains all the DMS and dealer data that youyou have entered

Kou can now add the HIs$a'alidator$ro$erties2le to the is$a8validator8+44;i$2lebefore you $rovide the ;i$82le to the dealershi$

5igure +shows an exam$le of the content of the HIs$a'alidator$ro$erties 2le Kou cano$en the 2le with any text editor to verify that the content is correct

Figure 1: IspaValidator#properties fle



18/24

!M" #rou$ Page+@


4. Lo! #ile $escri%tion

4.1 r!ani6ation of t)e lo! 'les

4.1.1 0erall or!ani6ation it)in t)e lo! 7IP 'le

5igure +*shows the overall log 2les organi;ation within the log


19/24

!M" #rou$ Page+9


4.1. List of test data created in $MS

5igure +3shows an exam$le of the content of the 2le Odmscleanu$txt>

Figure 1-: xa(ple o) fle d(s8cleanup#txt



20/24

!M" #rou$ Page%4


4.2 (est case lo! 'le structure

/ach log 2le is $re2xed with a header that ex$lains See 5igure +@F

"hich test case this log 2le belongs to "hich test grou$ the test case belongs to

"hat the outcome of the test case was

Figure 1.: "est case log fle %eader

5ollowing the header, all communications between the 'alidator, D1:M and the DMS is logged/ach re-uest & res$onse is logged as shown in 5igure +9

8888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888

Timestam$> TIM/STAMPQQR Direction> DI7/1TI:NQQR :$eration> :P/7ATI:NQQR Time ela$sed>/6APS/DQQ

8888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888

7/)/ST & 7/SP:NS/ QQ

Figure 1: 9euest / response log structure

The header $rovides general information about the re-uest or res$onse>

IS: @04+ timestam$ local timeF

7e-uest & res$onse direction The $ossible values are>o 7e-uest from the 'alidator to D1:M> Validator ;< D'5M

o D1:M re-uest to the DMS> D'5M ;< DMS


#rou$> %manage1ustomers#rou$

Ste$> )$date1ustomerTest

7esult> S)11/SS


21/24

!M" #rou$ Page%+


o DMS res$onse to D1:M DMS ;< D'5M

o D1:M res$onse to the 'alidator D'5M ;< Validator

Name of the interface o$eration that is invoBed

:nly for res$onses> The time ela$sed between re-uest and res$onse

5igure %4$rovides an exam$le of an actual re-uest>

8888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888

Timestam$> %4+. 4%8+9 +4>+4>.3@3. R Direction> ISPA A$$lication 8Q D1:M R :$eration> get1ustomerData

8888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888

Uxml version?+4? encoding?)T58+0?UQ

get1ustomerData7e-uest xmlns?htt$>&&wwwbmwgrou$com&dms1ommunications&v+&ty$es?Q

technicalJeader a$$lication?ISPA 'alidator?

interactionId?34a0be9.@4+f*4@f@9daa%%0.+*%b0?

schemaName?!mwDcom? schema'ersion?+++?&Q

businessJeaderQ

dealerTy$e bmw:utletNumber?4+? businessNumber?+%*.? distributionPartnerNumber?.*%+?&Q

&businessJeaderQ

userInformationQ

userID&Q

2rm&Q

localeQde8D/&localeQ

&userInformationQ

dms1ustomerIdQ1)+44&dms1ustomerIdQ

&get1ustomerData7e-uestQ

Figure 23: 9euest / response log exa(ple

If an error occurs, the log 2le will $rovide warning and error messages that allow to analy;e the

cause of the error 5igure %+FV%4+. 4%8+9 +4>.9>**4W /77:7 Abstract/xce$tionStrategy> Dcom/xce$tion thrown in route Xroute%X and$rocessed by handler Xcombmwdcomdcomserviceexce$tionSearch1ustomers/xce$tionStrategyX

Transaction ID> de3@0*c8c+ce8*%f@8@9e084aea9a990ee0

Including errors>

Dcom/rror No+

Message> The target system has sent an invalid res$onse

/rror 1ode> AAD1:M+04+

Yavaxxmlwssoa$S:AP5ault/xce$tion> 7es$onse was of unex$ected text&html 1ontentTy$e Incoming $ortion ofJTM6 stream> htmlQbodyQ$QThere are currently 4 running Soa$)IMocBServices&$QulQ&ulQ&$Q&bodyQ&htmlQ

Figure 21: DMS co((unication error exa(ple



22/24

!M" #rou$ Page%%




23/24

!M" #rou$ Page%


4. 0erall lo! 'le structure

The overall log 2le contains all events in order of their occurrence The log entries are

structured according to common logging conventions 5igure %%FV/'/NT TIM/STAMPQQW /'/NT 6/'/6QQ 1:MP:N/NTQQ>6:# M/SSA#/QQ

Figure 22: 7og eent structure

5igure %shows a short extract from an actual run of the a$$lication

V%4+. 4%8+9 +4>+%>%+..@W IN5: 1osyDownloadTasB> 1osK download was successful 1onnecting tooB +@*@99ms, downloaded 4 bytes in 3. ms

V%4+. 4%8+9 +4>+%>%%*4W IN5: DmsTesterA$$lication1ontroller> Test grou$ 3connectionTests#rou$ ste$1osyTest com$leted with result S)11/SS

V%4+. 4%8+9 +4>+%>%%*0W IN5: DmsTesterA$$lication1ontroller> Test grou$ 3connectionTests#rou$ ste$

DealerPortalTest startedV%4+. 4%8+9 +4>+%>.%@9@W IN5: Sgate6oginTasB> 1reating JTTP client, connection timeout .444 ms, socBettimeout +4444 ms

V%4+. 4%8+9 +4>+%>.%9.W IN5: Sgate6oginTasB> 5etching S#ate login info fromhtt$s>&&sgatebmwgrou$com&baansfr&Ys$&sgate&S#ateYs$

Figure 2: A s%ort extract )ro( t%e oerall log fle



24/24

!M" #rou$ Page%*


5. Su%%ort

NS1 onlyG

The 'alidator is a tool for the NS1 to su$$ort the introduction of ISPA Next and&or ISPA Mobileinto a marBet with regard to the DMS integration

"henever you need su$$ort regarding the 'alidator, $lease contact only your res$onsibleMarBet 1onsultant of the T7A1 team in Munich

ispa validator manual

Documents