SK - AutoTeilePilot PLUS - Schnittstellenselect.ag/fileadmin/Downloads/ATPPlus/AutoTeilePilotPLUS_Schnittst... · Catalog = Katalogartikel Custom = benutzerdefinierter Artikel

Schnittstellen

© Limex Computer GmbH. Alle Rechte vorbehalten.

Schnittstellen

___________________________________________________________________________________________________________________ © Limex Computer GmbH. Alle Rechte vorbehalten. Seite 2 • v. 1.2

Inhaltsverzeichnis Inhaltsverzeichnis ....................................................................................................................................... 2

Übersicht .................................................................................................................................................... 3

ATP Plus Windows-Client ........................................................................................................................... 4

Parameter von „ATP Plus.exe“ ............................................................................................................... 4

Warenkorb-Export im XML-Format ........................................................................................................ 5

Warenkorb-Import im XML-Format ..................................................................................................... 12

Historie ..................................................................................................................................................... 14

Schnittstellen


Übersicht Der AutoTeilePilot Plus Katalog ist ein elektronisches Online-Informationssystem, das umfangreiche

Information zu Artikel- und Fahrzeugdaten, Arbeits- und Einstellwerten, Inspektionsdaten und

Reparaturanleitungen umfasst.

Mit der eigenen Windows-Anwendung „ATP Plus Windows-Client“ bietet der AutoTeilePilot Plus

Katalog die Schnittstellen zu externen Programmen, wie z.B. Auftragsverarbeitungs- oder

Abrechnungssysteme.

Folgende Schnittstellen werden unterstützt:

• Der ATP Plus Windows-Client bietet Kommandozeilenparameter zum Export des

gewählten Warenkorbinhaltes im XML-Format.

• Außerdem kann der ATP Plus Windows-Client über Kommandozeilenparameter eine

„externe Warenkorbdatei“ im XML-Format importieren, um eine direkte Verarbeitung

der übergebenen Daten in dem Bestellmodul zu ermöglichen.

Auf den nächsten Seiten werden diese Verfahren näher beschrieben.

Schnittstellen


ATP Plus Windows-Client Unter folgendem Registrierungsschlüssel finden Sie den physischen Speicherort des ATP Plus

Windows-Clients sowie die Basis-URL zur AutoTeilePilot Plus Webseite. Diese Information benötigen

Sie, um den ATP Plus Windows-Clients aus einem externen Programm zu starten.

Der Pfad ist in der Registry im Schlüssel HKEY_CURRENT_USER\Software\Limex Computer

GmbH\ATP Plus\ExecutablePath eingetragen.

Parameter von „ATP Plus.exe“ Mit Hilfe von Kommandozeilenparametern kann auf das Standardverhalten der Anwendung Einfluss

genommen werden. Außerdem stellen Parameter den Zugriff auf die Schnittstelle der Website bereit.

Kommandozeilenparameter werden mit „-“ (Bindestrich) oder „/“ (Schrägstrich) und dem

Parameternamen angegeben. Parameterwerte folgen auf den Parameter und werden mit „ “

(Leerzeichen) oder „:“ (Doppelpunkt) von diesem getrennt. Die Groß-/Kleinschreibung der Parameter

ist beliebig.

Folgende Parameter werden bei dem Start vom ATP Plus Windows-Client ausgewertet:

Parameternamen Beschreibung

/FilterPage:[Start|Cars|

Trucks|Axles]

Legt fest, auf welcher Seite der Filter für die „Freie Suche“-Funktion

verwendet werden soll. Vorgabe: Cars

/Filter:“…“

Filter im angegebenen Bereich. Funktioniert identisch wie die Eingabe

des Filterwertes in der „Freie Suche“-Funktion des Katalogs. Fahrzeugidentifizierung über die KBA-Nummer erfolgt durch die Eingabe

der 4-stelligen HSN und 3-stelligen TSN (mit oder ohne Bindestrich).

/Read:{ImportFileName}

Automatisch beim Start die angegebene Warenkorb-Import-Datei im

XML-Format öffnen. Die angegebene Datei muss existieren und absolut

(d.h. mit vollständigem Dateinamen inkl. Laufwerksbuchstaben)

spezifiziert sein.

Die XML-basierte Warenkorb-Import-Datei wird in einem weiteren Abschnitt „Warenkorb-Export im XML-Format“ beschrieben.

/Write:{ExportFileName}

Wenn dieser Parameter angegeben ist, wird automatisch beim Programmende der aktuell gültige Warenkorb in das XML-Dokument mit

dem angegebenen Dateinamen gespeichert. Kann identisch sein mit dem

„/Read“-Dateinamen.

/Wait

Bewirkt, dass der Windows-Prozess, der beim Start des Kataloges initiiert

wird, erst beim Schließen der Oberfläche beendet wird. Mit diesem

Parameter lassen sich Aufrufe aus externen Programmen erzeugen, die

nach Beendigung des Katalog-Vorganges die Resultate auswerten

müssen.

Beispiel: Übergabe des Warenkorbes am Ende des Artikel-Auswahlvorganges mittels /Write-Parameters. Hier kann das aufrufende

Programm mit /Wait auf das Ende des gestarteten Windows-Prozesses

warten und anschließend die Rückgabedatei verarbeiten.

/WAPName:{Bezeichnung} Die hier angegebene Bezeichnung wird für die Beschriftung des

Datenübergabe-Buttons im Warenkorb verwendet.

Schnittstellen


Beispiel 1: Warenkorb mit 1 Artikel

Beispiel für einen einfachen Warenkorb mit einer Artikelposition.

<?xml version="1.0" encoding="utf-16"?>

<ShoppingCartExportData xmlns:xsd="http://www.w3.org/2001/XMLSchema"> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

<Version>1.1</Version>

< Currency>EUR</Currency> < TaxRate>19.0</TaxRate> < TaxRateForRemanufacturedParts>10.0</TaxRateForRemanufacturedParts> <Vehicle> <Id/>PT1870</Id>

<TypeNo/>PT1870</ TypeNo >

<Description>VW GOLF III (1H1) 1.6</Description>

<LicenseNumber>MM MM 111</LicenseNumber>

<YearOfConstruction>11.1992</YearOfConstruction> <KM>111111</KM>

</Vehicle>

<Address>

<Name1>Max</Name1>

<Name2>Mustermann</Name2>

<Name3/> <Street>Musterstrasse 1</Street>

<PostalCode>11111</PostalCode>

<City>Musterstadt</City>

</Address>

<Positions> <Article>

<PositionType>Catalog</PositionType>

<ManufacturerNo>1018</ManufacturerNo>

<ManufacturerDesignation>VALEO</ManufacturerDesignation>

<ManufacturerArticleNo>436718</ManufacturerArticleNo>

<Description>Generator</Description> <Quantity>1</Quantity>

<Unit>ST</Unit>

<IsRemanufacturedPart>true</IsRemanufacturedPart>

<DepositValue>50</DepositValue>

<ChargeDepositValue>true</ChargeDepositValue> <TaxCode>A</TaxCode>

<RecommendedRetailPrice>440.00</ RecommendedRetailPrice >

<Discount>0</Discount>

<UnitPrice>440.00</UnitPrice>

<UnitPurchasePrice>286.00</UnitPrice>

<TotalPurchasePrice>286.00</UnitPrice> </Article>

</Positions>

</ShoppingCartExportData >

Warenkorb-Export im XML-Format Die Warenkörbe in AutoTeilePilot Plus können im XML-Format exportiert und gespeichert werden.

Warenkorb-Dateien werden verwendet, indem sie direkt aus dem Dateisystem ausgelesen werden.

Geschrieben werden Warenkorb-Dateien in folgenden Fällen:

• durch Verwendung der „Warenkorbdaten in lokale Datei schreiben“-Funktion.

• durch die Verwendung entsprechende Schreib-Direktive beim Start des Kataloges über

entsprechende Kommandozeilen-Parameter (s. Abschnitt „Parameter von „ATP Plus.exe“).

Weiteres ausführliches Beispiel finden Sie am Ende des Abschnittes.

Schnittstellen


Element "ShoppingCartExportData"

Unterelement Beschreibung Mögliche Werte

Version

Die Versionsnummer der Exportdaten. (Aufbau = Hauptversion.Unterversion

(„1.0“)).

Zeichenkette

Currency

Das Währungsformat des Warenkorbes

nach ISO. (EUR, USD usw.). Derzeit wird

lediglich EUR unterstützt.

Zeichenkette

TaxRate Der im Warenkorb verwendete volle

Steuersatz. Decimal

TaxRateForRemanufacturedParts Der im Warenkorb verwendete Altteil-

Steuersatz. Decimal

Vehicle

Daten des dem Warenkorb zugrunde

liegenden Fahrzeuges. Die Daten

beziehen sich immer nur auf ein

„primäres“ Fahrzeug, selbst wenn im

Warenkorb Positionen zu verschiedenen

Fahrzeugen enthalten sind.

XML-Element

Address

Die Adressdaten, die in der

Dokumentansicht als Kundenadresse

erfasst wurde.

XML-Element

Positions Die Warenkorb -Positionen. XML-Element

Element "Vehicle"


VehicleId Die interne Nummer des Fahrzeuges. Zeichenkette

VehicleTypeId Die interne Nummer desFahrzeugtyps.

(Interner Prefix + TecDoc-Id) Zeichenkette

Description Die Bezeichnung des Fahrzeuges. Zeichenkette

LicenseNumber Das amtliche Kennzeichen des Fahrzeuges.

Zeichenkette

YearOfConstruction Das Baujahr im (Format mm.jjjj

(01.2001)). Zeichenkette

KM Der Kilometerstand des Fahrzeuges bzw.

leer, wenn keine Daten vorhanden sind. Int oder leer

Schnittstellen


Element "Address"


Name1 Erste Namenszeile Zeichenkette

Name2 Zweite Namenszeile Zeichenkette

Name3 Dritte Namenszeile Zeichenkette

Street Straße und Hausnummer Zeichenkette

PostalCode Postleitzahl Zeichenkette

City Ort Zeichenkette

Element "Positions"


Article Artikelposition XML-Element

RepairTime Arbeitswertposition XML-Element

Text Textposition XML-Element

Element "Article"


PositionType Type der Artikelposition

Zeichenkette

Catalog = Katalogartikel

Custom =

benutzerdefinierter Artikel

Unmapped = nicht

zugeordneter Artikel

ManufacturerNo Herstellernummer Zeichenkette

ManufacturerDesignation Herstellerbezeichnung Zeichenkette

ManufacturerArticleNo Hersteller-Artikelnummer Zeichenkette

Description Artikelbezeichnung Zeichenkette

Quantity Artikelmenge Decimal

Schnittstellen


Unit Mengeneinheit Zeichenkette

IsRemanufacturedPart

Gibt an, ob es sich um ein Austauschteil

handelt.

Falls „true“ Artikel ist ein Austauschteil,

sonst „false“.

Boolean

DepositValue Pfandwert Decimal

ChargeDepositValue

Gibt an, ob der Pfandwert in Rechnung

gestellt wird. Falls „true“ der Pfandwert wird in

Rechnung gestellt, sonst „false“.

Boolean

TaxCode Die Steuerart Zeichenkette V= volle Steuer

A= Altteilsteuer

RecommendedRetailPrice

Unverbindliche Preisempfehlung pro

Mengeneinheit. Ist kein Wert vorhanden, wird der Wert 0

geliefert.

Decimal

Discount Der gewährte Rabatt Decimal

UnitPrice

In der Dokumentansicht verwendete Preis

pro Mengeneinheit.

Ist kein Wert vorhanden, wird der Wert 0

geliefert.

Decimal

UnitPurchasePrice

EK-Preis pro Mengeneinheit.


geliefert. (Ab Version 1.1)

Decimal

TotalPurchasePrice

Gesamt-EK-Preis pro Position.


geliefert. (Ab Version 1.1)

Decimal

Element "RepairTime"


PositionType Type der Arbeitsposition

Zeichenkette

Catalog = Katalog-Arbeit

Custom = benutzerdefinierte Arbeit

VehicleId Die interne Nummer des

zugehörigen Fahrzeuges. Zeichenkette

Number Nummer der Arbeit Zeichenkette

Classification

Die Art bzw. Kategorie der

Arbeit. Diese Kategorie dient

der Zuordnung

verschiedener Abrechnungs-/Stundensätze.

Zeichenkette

Undefined= nicht zugeordnete Arbeit

Electric = Elektrik-Arbeiten

Electronic = Elektronik-Arbeiten

Body = Karosseriearbeiten Paint = Lackierarbeiten

Garage = Werkstattarbeiten

Accessory = Zubehörarbeiten

Schnittstellen


Description Bezeichnung der Arbeit Zeichenkette

ManufacturerBase Der Hersteller AW-Teiler Int

WorkUnit Arbeitseinheit

Zeichenkette

AW = Arbeitswert

Hour = Stunde

RepairTimeBase Der verwendete AW-Teiler Int

CatalogDurationInAW

Die vom Katalog vorgegebene Dauer der

Arbeit in AW (basierend auf

100 AW-Teiler)

Int

CatalogPricePerHour

Der vom Katalog

vorgegebene Stundensatz

der Arbeit

Decimal

Duration Dauer der Arbeit abhängig

vom verwendeten AW-Teiler Decimal

UnitPrice Preis pro Arbeitseinheit Decimal

PricePerHour Der verwendete Stundensatz Decimal

ContainingWorks

Auflistung der

Umfasstarbeiten der

Arbeitsposition

XML-Element „ContainingWork“

Element " ContainingWork"


Description Bezeichnung der Umfasstarbeit Zeichenkette

Element "Text"


Text Freier Text Zeichenkette

Schnittstellen


Beispiel 2: Warenkorb mit 2 Artikeln und 2 Arbeitswerten

Beispiel für eine Warenkorb-Export-Datei mit zwei Artikelpositionen und zwei Arbeitswertpositionen. Ein

Artikel ist ein Austauschartikel.


<ShoppingCartExportData xmlns:xsd="http://www.w3.org/2001/XMLSchema">

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

<Version>1.0</Version>

< Currency>EUR</Currency> < TaxRate>19.0</TaxRate> < TaxRateForRemanufacturedParts>10.0</TaxRateForRemanufacturedParts> <Vehicle>

<Id/>PT1870</Id>

<TypeNo/>PT1870</ TypeNo > <Description>VW GOLF III (1H1) 1.6</Description>

<LicenseNumber>MM MM 111</LicenseNumber>

<YearOfConstruction>11.1992</YearOfConstruction>

<KM>111111</KM>

</Vehicle> <Address>

<Name1>Max</Name1>

<Name2>Mustermann</Name2>

<Name3/>

<Street>Musterstrasse 1</Street>

<PostalCode>11111</PostalCode> <City>Musterstadt</City>

</Address>

<Positions>

<Article>

<PositionType>Catalog</PositionType> <ManufacturerNo>1018</ManufacturerNo>

<ManufacturerDesignation>VALEO</ManufacturerDesignation>

<ManufacturerArticleNo>436718</ManufacturerArticleNo>

<Description>Generator</Description>

<Quantity>1</Quantity>

<Unit>ST</Unit> <IsRemanufacturedPart>true</IsRemanufacturedPart>


<ChargeDepositValue>true</ChargeDepositValue>

<TaxCode>A</TaxCode>

<RecommendedRetailPrice>440.00</ RecommendedRetailPrice > <Discount>0</Discount>



<TotalPurchasePrice>286.00</UnitPrice>

</Article>

<Article> <PositionType>Catalog</PositionType>


<ManufacturerDesignation>JURID</ManufacturerDesignation>

<ManufacturerArticleNo>573128J-AS</ManufacturerArticleNo>

<Description>Bremsbelagsatz, Scheibenbremse</Description> <Quantity>2</Quantity>

<Unit>ST</Unit>

<IsRemanufacturedPart>false</IsRemanufacturedPart>


<ChargeDepositValue>false</ChargeDepositValue>

<TaxCode>V</TaxCode> <RecommendedRetailPrice>79.06</ RecommendedRetailPrice >

<Discount>0</Discount>



<TotalPurchasePrice>96.44</UnitPrice> </Article>

Schnittstellen


Die XSD-Datei (XML Schema Definition) finden Sie unter folgender URL:

http://www.autoteilepilotplus.de/etc/downloads/ShoppingCartExportData.xsd

<RepairTime> <PositionType>Catalog</PositionType>

<VehicleId>PT1870</VehicleId>

<Number>1E00002000</Number>

<Classification>Garage</Classification>

<Description>Vorglühanlage auf Funktion prüfen *</Description>

<ManufacturerBase>12</ManufacturerBase> <WorkUnit>Hour</WorkUnit>

<RepairTimeBase>1</RepairTimeBase>

<CatalogDurationInAW>33</CatalogDurationInAW>

<CatalogPricePerHour>70.00</CatalogPricePerHour>

<Duration>0.33</Duration> <UnitPrice>70.00</UnitPrice>

<PricePerHour>70.00</PricePerHour>

<ContainingWorks/>

</RepairTime>

<RepairTime>

<PositionType>Catalog</PositionType> <VehicleId>PT1870</VehicleId>

<Number>1E00002000</Number>

<Classification>Garage</Classification>

<Description>Vorglühanlage auf Funktion prüfen *</Description>

<ManufacturerBase>12</ManufacturerBase> <WorkUnit>Hour</WorkUnit>

<RepairTimeBase>1</RepairTimeBase>

<CatalogDurationInAW>33</CatalogDurationInAW>

<CatalogPricePerHour>70.00</CatalogPricePerHour>

<Duration>0.33</Duration>

<UnitPrice>70.00</UnitPrice> <PricePerHour>70.00</PricePerHour>

<ContainingWorks/>

<ContainingWork>

<Description>Kurztest durchführen</Description>

</ContainingWork> <ContainingWork>

<Description>Daten ausdrucken</Description>

</ContainingWork>

<ContainingWork>

<Description>Fehlerspeicher löschen</Description> </ContainingWork>

</ContainingWorks>

</RepairTime>

</Positions>

</ShoppingCartExportData >

Schnittstellen


Beispiel : Warenkorb mit 2 Artikeln

Beispiel für eine Warenkorb-Import-Datei mit zwei Artikelpositionen.


<ShoppingCartImportData xmlns:xsd="http://www.w3.org/2001/XMLSchema">

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <Version>1.0</Version>

<Positions>

<Article>

<ManufactureType>Select</ManufactureType>


<ManufacturerArticleNo>437618</ManufacturerArticleNo> <Description>Generator</Description>


</Article>

<Article>

<ManufactureType>TecDocDataSupplier</ManufactureType> <ManufacturerNo>BOSCH</ManufacturerNo>

<ManufacturerArticleNo>WB12</ManufacturerArticleNo>

<Description>Wischblatt</Description>


</Article>

<Article> <ManufactureType>OE</ManufactureType>

<ManufacturerNo>BOSCH</ManufacturerNo>

<ManufacturerArticleNo>W712</ManufacturerArticleNo>

<Description></Description>

<Quantity>10</Quantity> </Article>

</Positions>

</ShoppingCartImportData >

Warenkorb-Import im XML-Format Die Warenkörbe können im XML-Format in AutoTeilePilot Plus importiert werden.

Warenkorb-Dateien werden verwendet, indem sie direkt aus dem Dateisystem ausgelesen werden.

Importiert werden Warenkorb-Dateien im folgenden Fall:

• durch die Verwendung entsprechende Lese-Direktive beim Start des Kataloges über

entsprechende Kommandozeilen-Parameter (s. Abschnitt „Parameter von „ATP Plus.exe“).

Element "ShoppingCartImportData"


Version

Die Versionsnummer der Importdaten.

(Aufbau = Hauptversion.Unterversion

(„1.0“)).

Zeichenkette

Positions Die Warenkorb-Positionen Zeichenkette

Schnittstellen


Element "Article"


ManufacturerType Type, der verwendeten

Herstellernummer

Zeichenkette

Select = Herstellernummer von Select

TecDocDataSupplier =

TecDoc-

Dateneinspeisernummer

OE = OE-Hersteller

ManufacturerNo Herstellernummer Zeichenkette

ManufacturerArticleNo Hersteller-Artikelnummer Zeichenkette

Description

Eine optionale Artikelbezeichnung, die

verwendet wird, sollte der Artikel

nicht automatisch im Katalog

gefunden werden.

Zeichenkette

Quantity Artikelmenge Decimal

Die XSD-Datei (XML Schema Definition) finden Sie unter folgender URL:

http://www.autoteilepilotplus.de/etc/downloads/ShoppingCartImportData.xsd

Schnittstellen


Historie Datum Version Beschreibung

15.02.2013 1.0 Erste Version

17.04.2013 1.1 Neue Felder in der Warenkorb-Export im XML-Format:

EK-Preis pro Mengeneinheit:

ShoppingCartExportData/Positions /Article/UnitPurchasePrice

Gesamt-EK-Preis pro Position:

ShoppingCartExportData /Positions /Article/ TotalPurchasePrice

25.04.2013 1.2 Ergänzung der Beschreibung vom Filter-Parameter im Unterkapitel

„Parameter von „ATP Plus.exe““ um die Information zur

Fahrzeugidentifizierung über die KBA-Nummer.

Documents

SK - AutoTeilePilot PLUS - Schnittstellenselect.ag/fileadmin/Downloads/ATPPlus/AutoTeilePilotPLUS_Schnittst... · Catalog = Katalogartikel Custom = benutzerdefinierter Artikel