Ispa Validator Manual

ISPA Next / ISPA Mobile
Validator
Installation and User
Manual
This manual decribes the installation, the handling and the error analysis for validation of the
DMS integration with ISPA Next ISPA Mobile.
BMW Group
Page 2
ISPA Next / ISPA Mobile Validator Installation and User Manual
of
24
List of contents
1.
1.1
1.2
1.3
Introduction
Purpose of This Document
Target Group for this Document
Structure of This Document
4
4
4
4
2.
2.1
2.2
2.3
2.4
Installation and Uninstallation

System requirements
Execution of the Validator
Installation
Uninstallation
5
5
5
5
5
3.
3.1
3.2
3.3
3.4
3.4.1
3.4.2
3.4.3
3.4.4
3.4.5
3.5
3.6
3.7
Usage
Prerequisites
Starting the ISPA Next / ISPA Mobile Validator
DMS Configuration
Test Case Execution
Explanation of the Test Case UI
Executing the First Test Case
Executing DMS Test Cases
Executing Connectivity Test Cases
Dealing with Failed Test Cases
Log File Download
Create and download Test Report
Pre-Configuring the ISPA Next / ISPA Mobile Validator
6
6
6
7
10
10
11
12
13
15
16
17
19
4.
4.1
4.1.1
4.1.2
4.1.3
4.2
4.3
Log File Description

Organization of the log files
Overall organization within the log ZIP file
Test cases log files
List of test data created in DMS
Test case log file structure
Overall log file structure
20
20
20
20
21
22
24
5.
Support
25
Release 1503
Copyright BMW AG
BMW Group
Page 3
of
24
List of figures
Figure 1: ISPA Next / ISPA Mobile Validator startup screen...........................................................6
Figure 2: DMS configuration screen DMS and Dealer Data...........................................................7
Figure 3: DMS connection error.................................................................................................... 9
Figure 4: Test case selected....................................................................................................... 10
Figure 5: The "Fetch DMS Configuration" test case has been completed successfully...............11
Figure 6: The "Update Customer Data" test case has been executed sucessfully......................13
Figure 7: Dealer portal test case................................................................................................ 14
Figure 8: Error when executing the "Create Vehicle" test case..................................................15
Figure 9: Test results and log files view......................................................................................16
Figure 10: Create test report view............................................................................................. 17
Figure 11: log files ZIP created.................................................................................................. 17
Figure 12: Example of results.txt file......................................................................................... 18
Figure 13: IspaValidator.properties file.......................................................................................19
Figure 14: Overall log files organization.....................................................................................20
Figure 15: Log file organization within a test group with all test cases successful.....................20
Figure 17: Example of file dms_cleanup.txt...............................................................................21
Figure 18: Test case log file header............................................................................................ 22
Figure 19: Request / response log structure...............................................................................22
Figure 20: Request / response log example...............................................................................23
Figure 21: DMS communication error example..........................................................................23
Figure 22: Log event structure................................................................................................... 24
Figure 23: A short extract from the overall log file....................................................................24
Release 1503
Copyright BMW AG
BMW Group
Page 4
of
24
1. Introduction
1.1 Purpose of This Document
The ISPA Next / ISPA Mobile Validator is a tool that allows to verify that the requirements for
operating ISPA Next and ISPA Mobile are met. The Validator visually guides through test cases
that check the availability of the implemented DMS interface and central BMW services. The
main focus of the Validator is to test if the DMS has correctly implemented the ISPA interface
that is required by the ISPA applications ISPA Next and ISPA Mobile.
The purpose of this document is to provide users of the ISPA Next / ISPA Mobile Validator with
the means to effectively use the Validator. This document describes how to install, uninstall and
use the ISPA Next / ISPA Mobile Validator.
1.2 Target Group for this Document

The target group for this document are IT administrators with good knowledge of the ISPA
interfaces and the DMS used.
1.3 Structure of This Document

Chapter 1 provides a general overview over this document.
Chapter 2 describes the installation, uninstallation and system requirements of the ISPA
Next / ISPA Mobile Validator.
Chapter 3 provides a description of how to use the ISPA Next / ISPA Mobile Validator and
how to create and download the Test Report.
Chapter 4 provides a description of how to read and interpret the ISPA Next / ISPA Mobile
Validator log files including the list of test entries created in your DMS.
Chapter 5 lists BMW support contacts
Release 1503
Copyright BMW AG
BMW Group
Page 5
of
24
2. Installation and Uninstallation

2.1 System requirements
The following system requirements must be met for an installation of the ISPA Next / ISPA
Mobile Validator:
Windows 7 or 8.1, Windows Server 2012 R2 (both x86 & x64 systems are supported)
512MB RAM (exclusively for the ISPA Next / ISPA Mobile Validator)
500MB free hard disk space for the application and the logs
2.2 Execution of the Validator

It is recommended to perform the Validator test cases for DMS integration outside
of normal business hours!
Executing the test cases may considerably reduce the overall performance of all
your connected systems and applications.
2.3 Installation
Unzip the ispa-validator-1.0.0.zip file anywhere on your computer. This will create a ispavalidator-1.0.0 folder.
Switch to this folder and execute the ispa-validator-1.0.0.exe file to start the ISPA Next /
ISPA Mobile Validator.
2.4 Uninstallation
Close the ISPA Next / ISPA Mobile Validator if it is running.
Delete the ispa-validator-1.0.0 folder.
Release 1503
Copyright BMW AG
BMW Group
Page 6
of
24
3. Usage
3.1 Prerequisites
Please make sure that
the device the Validator is installed on, has access to the DMS and the internet.
you know your proxy server URL and credentials, if you use a proxy server.
you have your DMS URL and credentials as well as your dealer portal (S-Gate or
DealerSpeed) credentials at hand.
3.2 Starting the ISPA Next / ISPA Mobile Validator

Switch to the ispa-validator-1.0.0 folder created during installation and execute the ispavalidator-1.0.0.exe file to start the ISPA Next / ISPA Mobile Validator.
The ISPA Next / ISPA Mobile Validator startup screen is displayed:
Figure 1: ISPA Next / ISPA Mobile Validator startup screen
Select your language and click on Start ISPA Validator to start the Validator.
If you want to start the validation of your DMS interface implemented, continue with
chapter 3.3.
Otherwise, if you only want to test the connectivity of other systems skip the DMS
and Dealer Data configuration and select Test Group 7: Connection to other systems
described in chapter 3.4.4.
Release 1503
Copyright BMW AG
BMW Group
Page 7
of
24
3.3 DMS Configuration

The following Figure 2 shows the DMS and Dealer Data configuration screen:
Figure 2: DMS configuration screen DMS and Dealer Data
Enter the URL of your DMS (For example: https://some-dms-host/dms).

If your DMS requires authentication information, provide the access data. The access
data are not mandatory and specific for each DMS.
User ID
Company
Branch / Outlet
Workplace ID
Password
Provide the language your DMS uses (for example: en-GB or de-DE).
Provide your BMW dealer data:
Warranty Dealer Number (BuNo, 5 digits)
Distribution Partner Number (5 digits)
Outlet Number (2 digits)
If your company uses a proxy, provide the proxy server credentials. The proxy server
credentials are not mandatory.
Release 1503
Copyright BMW AG
BMW Group
Page 8
of
24
Host (for example: https://proxy-server-host/).

Port
User ID
Password
Connect to DMS via proxy.
Now click on button Check DMS Connection to verifiy that the DMS configuration is
correct and to start the Test case execution. If the Validator is not able to connect to you
DMS you will see an error message (see Figure 3). Please double check that the
configuration data you have entered is correct. If the Validator is still note able to
connect you can download the test logs and analyse the problem (see chapters 3.6).
Figure 3: DMS connection error
When you close the application the DMS and dealer data are saved in a
configuration file on harddisk.
The next time you start the ISPA Next / ISPA Mobile Validator the configuration
values are read from this file so that you do not have to reenter all data.
The file can also be used to preconfigure the ISPA Next / ISPA Mobile Validator
before providing it to a dealership (see chapter 3.7).
Release 1503
Copyright BMW AG
BMW Group
Page 9
of
24
3.4 Test Case Execution

3.4.1 Explanation of the Test Case UI
The following Figure 4 shows the test case view with the test case of the first test group
selected.
Figure 4: Test case selected.
On the left hand side, you can see the list of available test groups. On the right hand side, you
can see the content of the currently selected test case.
You can navigate arbitrarily between test groups by clicking on the test group titles:
The test group that contains the currently selected test case will stay open.
If you click on another test case, this test case will become active and its contents will
be displayed on the right hand side.
At the bottom of the window there are two buttons Previous and Next which you can
use to navigate between test cases.
Previous will select the test case that comes before the currently selected test case
and Next will select the next one.
The last entry in the test group list is Test results. This entry provides an overview
over the status of the test cases and a convenient way to save the test logs and
generate a test report (See chapter ).
Release 1503
Copyright BMW AG
BMW Group
Page
10
of
24
3.4.2 Executing the First Test Case

The first test case, Fetch DMS configuration, is required for executing the DMS
test cases.
Click on Next to start the test case execution.

A success message should appear. Click on Next to successfully complete this test
case and proceed to the next test case (See Figure 5).
If an error occurs, a message explaining the cause of the error will be displayed (See
chapter ).
You can click on Previous to re-do the failed test case or on Next to mark the current
test case as failed and proceed to the next one.
Figure 5: The "Fetch DMS Configuration" test case has been completed successfully
3.4.3 Executing DMS Test Cases

The DMS test cases will create and read data such as customer , vehicle or order data from and
to your DMS.
First and foremost please note that some test cases depend on others.
Example:
In the Manage Customers test group, the Create customer test case should be
executed before the Search Customer test cases so the newly created test
customer can be searched for. Most test cases such as the Search Customer test
cases can be simply stepped over if failed or if you do not want to execute them.
Release 1503
Copyright BMW AG
BMW Group
Page
11
of
24
You will always being notified, if a another test group has to be excuted prior to the
execution of a subsequent test case!
Some test cases will display data fetched from the DMS and ask you whether the data returned
by the DMS is correct (see Figure 6).
Click on Yes to confirm and the test case is marked successful.
Otherweise click on No to mark the test case not successful.
Therefore always check your DMS whether the data displayed by the Validator
corresponts to the data stored in your DMS.
Oherwise there might be a mismatch in the mapping of your DMS interface
implementation!
Figure 6: The "Update Customer Data" test case has been executed sucessfully
3.4.4 Executing Connectivity Test Cases

The test group Connection to Other Systems contains test cases that check connectivity to
systems such as BMW CoSy for vehicle images or to your dealer portal S-Gate and
DealerSpeed.
These tests require Internet (or BMW Corporate Network) connectivity and do not interact with
the DMS.
Figure 7 shows the dealer portal test case with S-Gate selected. For the dealer portal test case,
you need to provide valid credentials for your dealer portal.
Release 1503
Copyright BMW AG
BMW Group
Page
12
of
24
Figure 7: Dealer portal test case
Release 1503
Copyright BMW AG
BMW Group
Page
13
of
24
3.4.5 Dealing with Failed Test Cases

If a test case fails, an error message will be displayed that indicates the cause of the error (see
Figure 8). You have the following options to deal with a failed test case:
Click on Previous to re-run the test case, possibly while supplying corrected data.
Click on Next to mark the current test case as failed and continue with the next test
case.
Download the test logs and analyse the problem (see chapters 3.6 and 4).
Figure 8: Error when executing the "Create Vehicle" test case
Release 1503
Copyright BMW AG
BMW Group
Page
14
of
24
3.5 Log File Download

Click on Test Results title at the end of the test case list.
The Test Results and Log Files view will open, providing you with an overview of the of
the test status (See Figure 9).
If you walk through the test suite in order, this screen will be displayed automatically
after completing the last test case.
Figure 9: Test results and log files view
At the bottom right you can find the button Save log files. Click on that button.
A folder selector opens. Select the folder where you want to store the log files.
A ZIP file named Ispa-Validator-Logs- containing the logs of the most current
ISPA Next / ISPA Mobile Validator run will be created.
You can find the log files for all runs of the ISPA Next / ISPA Mobile Validator in the
logs sub-folder of the ISPA Next / ISPA Mobile Validator installation folder.
3.6 Create and download Test Report

Click on the Create test report button which is next to the Save log files button (see
Figure 9). A new window requesting further information opens (See Figure 10).
Release 1503
Copyright BMW AG
BMW Group
Page
15
of
24
Figure 10: Create test report view
Provide your dealer name and your city.

To save the test report click on the Save button at the bottom right.
A folder selector opens. Select the folder where you want to store the test report.
A ZIP file named Validator-Results- with the following files of the most current ISPA
Next / ISPA Mobile Validator run will be created:
The log files for each test case executed (for details please refer to chapter 4).
Figure 11: log files ZIP created
A file named results.txt containing name and city you provided before and an
overview of all test cases and whether they have been executed or not:
Release 1503
Copyright BMW AG
BMW Group
Page
16
of
24
Figure 12: Example of results.txt file
Release 1503
Copyright BMW AG
BMW Group
Page
17
of
24
3.7 Pre-Configuring the ISPA Next / ISPA Mobile Validator

The ISPA Next / ISPA Mobile Validator saves its configuration in a file named
IspaValidator.properties in the ispa-validator-1.0.0 folder. This file can be used to preconfigure the ISPA Next / ISPA Mobile Validator before providing it to a dealership.
To generate the IspaValidator.properties file you have to start the ISPA Next / ISPA
Mobile Validator, enter the DMS and dealer data (see chapter 3.3) and press Check
DMS Connection.
When you close the application the ISPA Next / ISPA Mobile Validator creates the
IspaValidator.properties file. This file contains all the DMS and dealer data that you
you have entered.
You can now add the IspaValidator.properties file to the ispa-validator-1.0.0.zip file
before you provide the zip-file to the dealership.
Figure 13 shows an example of the content of the IspaValidator.properties file. You can
open the file with any text editor to verify that the content is correct.
Figure 13: IspaValidator.properties file
Release 1503
Copyright BMW AG
BMW Group
Page
18
of
24
4. Log File Description

4.1 Organization of the log files
4.1.1 Overall organization within the log ZIP file
Figure 14 shows the overall log files organization within the log ZIP file downloaded from the
applicationValidator.
Figure 14: Overall log files organization
The log files for each test case are put within their own folders.
The file dms_cleanup.txt contains the list of test entries created in your DMS and
helps you to find and remove them from your DMS. The list contains the customer
numbers, the vehicle VINs and the Order numbers that have been created in your DMS
by the Validator.
The file dms-tester.log contains all log entries of the Validator and is intended for
experts.
4.1.2 Test cases log files
Figure 15 shows the log file organization with in a test group. The log entries for each test case
will be written into dedicated log files.
You can immediately see which test case has been executed successfully or not by the suffix at
the end of the file name (see Figure 15 and Figure 16).
Log files of successful test cases:
Figure 15: Log file organization within a test group with all test cases successful
Log files of failed test cases:
Figure 16: Log file organization within a test group with a test case failed
Release 1503
Copyright BMW AG
BMW Group
Page
19
of
24
4.1.3 List of test data created in DMS

Figure 17 shows an example of the content of the file dms_cleanup.txt:
Figure 17: Example of file dms_cleanup.txt
Release 1503
Copyright BMW AG
BMW Group
Page
20
of
24
4.2 Test case log file structure

Each log file is prefixed with a header that explains (See Figure 18)
Which test case this log file belongs to.
Which test group the test case belongs to.
What the outcome of the test case was.
=====================================================================
=============================
Group: 2.manageCustomersGroup
Step: UpdateCustomerTest
Result: SUCCESS
=====================================================================
=============================
Figure 18: Test case log file header
Following the header, all communications between the Validator, DCOM and the DMS is logged.
Each request / response is logged as shown in Figure 19.
---------------------------------------------------------------------------------------------------------------------------------------------------------------Timestamp: <<TIMESTAMP>> | Direction: <<DIRECTION>> | Operation: <<OPERATION>> | Time elapsed:
<<ELAPSED>>
---------------------------------------------------------------------------------------------------------------------------------------------------------------<< REQUEST / RESPONSE >>
Figure 19: Request / response log structure
The header provides general information about the request or response:

ISO 8601 timestamp (local time)
Request / response direction. The possible values are:
o
Request from the Validator to DCOM: Validator -> DCOM
DCOM request to the DMS:
Release 1503
DCOM -> DMS
Copyright BMW AG
BMW Group
Page
21
of
DMS response to DCOM
DCOM response to the Validator
24
DMS -> DCOM

DCOM -> Validator
Name of the interface operation that is invoked.

Only for responses: The time elapsed between request and response.
Figure 20 provides an example of an actual request:

--------------------------------------------------------------------------------------------------------------------------------------------------------------Timestamp: 2015 02-19 10:10:57.875 | Direction: ISPA Application -> DCOM | Operation: getCustomerData
--------------------------------------------------------------------------------------------------------------------------------------------------------------<?xml version="1.0" encoding="UTF-16"?>
<getCustomerDataRequest xmlns="http://www.bmwgroup.com/dmsCommunications/v1/types">
<technicalHeader application="ISPA Validator"
interactionId="70a6be95801f408f8393daa2265142b6"
schemaName="BmwDcom" schemaVersion="1.1.1"/>
<businessHeader>
<dealerType bmwOutletNumber="01" businessNumber="12345" distributionPartnerNumber="54321"/>
</businessHeader>
<userInformation>
<userID/>
<firm/>
<locale>de-DE</locale>
</userInformation>
<dmsCustomerId>CU100</dmsCustomerId>
</getCustomerDataRequest>
Figure 20: Request / response log example
If an error occurs, the log file will provide warning and error messages that allow to analyze the
cause of the error (Figure 21).
[2015 02-19 10:59:44.303] ERROR AbstractExceptionStrategy: DcomException thrown in route 'route2' and
processed by handler 'com.bmw.dcom.dcomservice.exception.SearchCustomersExceptionStrategy'.
Transaction ID: de7864c3-c1ce-42f8-89e6-0aea9a996ee6
Including errors:
DcomError No.1
Message: The target system has sent an invalid response.
Error Code: AA_DCOM1601
javax.xml.ws.soap.SOAPFaultException: Response was of unexpected text/html ContentType. Incoming portion of
HTML stream: <html><body><p>There are currently 0 running SoapUI
MockServices</p><ul></ul></p></body></html>
Figure 21: DMS communication error example
Release 1503
Copyright BMW AG
BMW Group
Page
22
of
Release 1503
24
Copyright BMW AG
BMW Group
Page
23
of
24
4.3 Overall log file structure

The overall log file contains all events in order of their occurrence. The log entries are
structured according to common logging conventions (Figure 22).
[<<EVENT TIMESTAMP>>] <<EVENT LEVEL>> <<COMPONENT>>: <<LOG MESSAGE>>
Figure 22: Log event structure
Figure 23 shows a short extract from an actual run of the application.

[2015 02-19 10:12:21.558] INFO CosyDownloadTask: CosY download was successful. Connecting took 184899
ms, downloaded 0 bytes in 753 ms.
[2015 02-19 10:12:22.430] INFO DmsTesterApplicationController: Test group 7.connectionTestsGroup step
CosyTest completed with result SUCCESS.
[2015 02-19 10:12:22.436] INFO DmsTesterApplicationController: Test group 7.connectionTestsGroup step
DealerPortalTest started.
[2015 02-19 10:12:52.898] INFO SgateLoginTask: Creating HTTP client, connection timeout = 5000 ms, socket
timeout = 10000 ms.
[2015 02-19 10:12:52.935] INFO SgateLoginTask: Fetching SGate login info from
https://sgate.bmwgroup.com/baansfr/jsp/sgate/SGate.jsp.
Figure 23: A short extract from the overall log file
Release 1503
Copyright BMW AG
BMW Group
Page
24
of
24
5. Support
NSC only!
The Validator is a tool for the NSC to support the introduction of ISPA Next and/or ISPA Mobile
into a market with regard to the DMS integration.
Whenever you need support regarding the Validator, please contact only your responsible
Market Consultant of the TRAC team in Munich.
Release 1503
Copyright BMW AG

Ispa Validator Manual

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Ispa Validator Manual

Încărcat de

Drepturi de autor:

Formate disponibile

ISPA Next / ISPA Mobile

ISPA Next / ISPA Mobile Validator Installation and User Manual

Installation and Uninstallation

Log File Description

ISPA Next / ISPA Mobile Validator Installation and User Manual

ISPA Next / ISPA Mobile Validator Installation and User Manual

1.2 Target Group for this Document

1.3 Structure of This Document

ISPA Next / ISPA Mobile Validator Installation and User Manual

2. Installation and Uninstallation

2.2 Execution of the Validator

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.2 Starting the ISPA Next / ISPA Mobile Validator

Figure 1: ISPA Next / ISPA Mobile Validator startup screen

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.3 DMS Configuration

Figure 2: DMS configuration screen DMS and Dealer Data

Enter the URL of your DMS (For example: https://some-dms-host/dms).

ISPA Next / ISPA Mobile Validator Installation and User Manual

Host (for example: https://proxy-server-host/).

Figure 3: DMS connection error

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.4 Test Case Execution

Figure 4: Test case selected.

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.4.2 Executing the First Test Case

Click on Next to start the test case execution.

3.4.3 Executing DMS Test Cases

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.4.4 Executing Connectivity Test Cases

ISPA Next / ISPA Mobile Validator Installation and User Manual

Figure 7: Dealer portal test case

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.4.5 Dealing with Failed Test Cases

Figure 8: Error when executing the "Create Vehicle" test case

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.5 Log File Download

Figure 9: Test results and log files view

3.6 Create and download Test Report

ISPA Next / ISPA Mobile Validator Installation and User Manual

Figure 10: Create test report view

Provide your dealer name and your city.

Figure 11: log files ZIP created

ISPA Next / ISPA Mobile Validator Installation and User Manual

Figure 12: Example of results.txt file

ISPA Next / ISPA Mobile Validator Installation and User Manual

3.7 Pre-Configuring the ISPA Next / ISPA Mobile Validator

Figure 13: IspaValidator.properties file

ISPA Next / ISPA Mobile Validator Installation and User Manual

4. Log File Description

Figure 14: Overall log files organization

Log files of failed test cases:

ISPA Next / ISPA Mobile Validator Installation and User Manual

4.1.3 List of test data created in DMS

Figure 17: Example of file dms_cleanup.txt

ISPA Next / ISPA Mobile Validator Installation and User Manual

4.2 Test case log file structure

Figure 18: Test case log file header

Figure 19: Request / response log structure

The header provides general information about the request or response:

Request from the Validator to DCOM: Validator -> DCOM

DCOM request to the DMS:

DCOM -> DMS

ISPA Next / ISPA Mobile Validator Installation and User Manual