XML Upload
 

XML-Upload von Prozessen

Es besteht die Möglichkeit über einen XML-Upload Prozesse innerhalb der WiM zu starten. Hierzu wird an eine URL ein generisches XML Dokument geschickt, welches es ermöglicht jeden Prozess innerhalb der WiM zu starten. Dabei kann je nach Prozess bereits ein gewisser Satz an Stamm- und Prozessdaten übergeben werden. Die vorliegende Dokumentation spiegelt nur einen Bruchteil der Möglichkeiten wider und wird fortlaufend ergänzt. Sollten Sie Fragen haben, sprechen Sie uns an.

Bitte beachten Sie, dass die Reihenfolge der XML-Elemente innerhalb der XML irrelevant ist. Durch den Parser wird automatisch das richtige Feld innerhalb der WiM befüllt.

Vorraussetzungen

WiM Request Endpoint

Die XML-Datei wird an folgende URL per POST-Request gesendet: http://ip:port/fastlane-backend/dispatch/xmlUpload2. Mit dem Parameter autoStart=true, also http://ip:port/fastlane-backend/dispatch/xmlUpload2?autoStart=true, kann der Prozess, der innerhalb der übergebenen XML definiert sein muss, automatisch gestartet werden.

B2BbP Vorraussetzung

Je nach Szenario wird die initXML direkt oder über die B2BbP an die WiM übergeben. Das B2BbP Szenario hat unter anderem den UseCase, dass die initXML von Kunden oder Dienstleistern empfangen werden musss. In diesem Fall muss innerhalb der B2BbP die Formaterkennung angepasst werden. An dieser Stelle der entsprechende Verweis auf die B2BbP Dokumentation:

Es folgt ein Beispiel einer DIALECT Extension in der B2BbP. Bitte beachten Sie, dass Sie je nach Szenario den XPATH zu xml.INITXML.partner oder xml.INITXML.sender auch tauschen können, um das Monitoring für Ihre Bedürfnisse anzupassen. Für die RefenceNumber xml.INITXML.referenceNumber kann optional zum Beispiel die id innerhalb der initXml genutzt werden /BdewTemplateInit/WimProcessConfiguration/id.

xml.dialect=IDOCXML,INITXML
xml..useParser=CEP

xml.INITXML.type2="INITXML"
xml.dialect.INITXML.id=<BdewTemplateInit>
xml.dialect.INITXML.type="INITXML"

xml.INITXML.type='INITXML'
xml.INITXML.version='2.0'
#ref aus initXml #
# xml.INITXML.referenceNumber=/BdewTemplateInit/WimProcessConfiguration/id
#oder ref generiert #
xml.INITXML.referenceNumber="$GENERATE_RANDOM$"
xml.INITXML.partner=/BdewTemplateInit/WimProcessList/WimProcessData[1]/processOverview/ownILN
xml.INITXML.partnerName=''
xml.INITXML.sender=/BdewTemplateInit/WimProcessList/WimProcessData[1]/processOverview/partnerILN
xml.INITXML.senderName=''
xml.INITXML.alternativeId=''
xml.INITXML.additional=UtilRef;processPart
xml.INITXML.UtilRef=''
xml.INITXML.processPart=/BdewTemplateInit/WimProcessList/WimProcessData[1]/processOverview/processPart

...

XML Definition

Je nach Prozess müssen unterschiedliche Felder befüllt werden. Im Nachgang erhalten Sie einen Überblick der bestehenden Prozesse. Die Einhaltung einer Reihenfolge der Elemente ist nicht notwendig.

Minimal Beispiel

<?xml version="1.0" encoding="UTF-8"?>
<BdewTemplateInit>
	<WimProcessList>
		<WimProcessData>
			<processData>
				<processName>Name Prozess</processName>
				<processPart>ID des zu startenden Prozesses</processPart>
				<meteringPoint>DE0000000000000000000000000000000</meteringPoint>
			</processData>
			<processOverview>
				<group>GroupName</group>
				<processName>Name Prozess</processName>
				<processPart>ID des zu startenden Prozesses </processPart>
				<ownILN>99000000EIGEN</ownILN>
				<partnerILN>9900000000000</partnerILN>
				<meteringPoint>DE0000000000000000000000000000000</meteringPoint>			
			</processOverview>
		</WimProcessData>
	</WimProcessList>
</BdewTemplateInit>

Pflicht Felder

Parameter Beschreibung Beispiel
WimProcessList.processOverview.group Hier kann, wenn nicht anders vereinbart, zur besseren Übersicht ein beliebiger Name eingetragen werden, welcher eine Identifikation und Einordnung des Prozesses in der WiM-Übersicht ermöglicht. Rollout von BackendX
WimProcessList.[processOverview|processData].meteringPoint Die prozessual behandelte MeLo oder Malo. Dies ist abhängig vom Prozess. DE0000000000000000000000000000000
WimProcessList.processOverview.ownILN Hier ist die eigene ILN anzugeben, in welcher der Prozess ausgeführt werden soll. 9900000000VNB, 990000000wMSB, …
WimProcessList.processOverview.partnerILN Hier ist die Partner ILN anzugeben, mit welcher der Prozess beginnen soll. Bei Beginn MSB wäre dies aus Sicht des wMSB zum Beispiel der VNB 9900000000VNB
WimProcessList.[processOverview|processData].processName Name des Prozesses. Freivergebar. Sollte aber sich am Processpart Orientieren Rollout, Beginn MSB, …
WimProcessList.[processOverview|processData].processPart Technischer Name des Prozesses. In den Unterkapiteln dieser Dokumentation werden die Prozessparts näher beschrieben. NLIROL010, NLIROMMME, NLI010010…

WimProcessList.[processOverview|processData].processName, WimProcessList.[processOverview|processData].processPart und , WimProcessList.[processOverview|processData].meteringPoint sind Pflichtfelder. Die Angaben in processOverview und processData sind Pflicht.

Optionale und empfohlene Felder

Parameter Optional / Empfohlen Beschreibung Beispiel
WimProcessConfiguration.DatePattern Empfohlen Hier wird das Datumsformat beschrieben, welches in der XML in den Datumsfeldern immer verwendet wird. Dabei wird die Java Syntax verwendet. yyyy-MM-dd für 2020-02-09 Wenn Datepattern nicht gesetzt wird der Default dd.MM.yyyy verwendet.
WimProcessConfiguration.id Optional Eine Id die zum Beispiel für die Referenz in der B2BbP befüllt werden kann. Diese sollte eindeutig sein.  
processsOverview.externalId Optional Eine Id, die für verschiedene Anwendungsfälle mit einem beliebigen Wert befüllt werden kann.  
<?xml version="1.0" encoding="UTF-8"?>
<BdewTemplateInit>
	<WimProcessConfiguration>
		<DatePattern>yyyy-MM-dd</DatePattern>
		<id>uuid</id>
	</WimProcessConfiguration>
	<WimProcessList>
		<WimProcessData>
			<processData>
			...
			</processData>
			<processOverview>
			...
			</processOverview>
		</WimProcessData>
	</WimProcessList>
</BdewTemplateInit>

Optionale Felder für eine abweichende Kontaktperson

Beim Versand von EDIFACT-Nachrichten zum Beispiel bei der IFTSTAs kann ein anderer fachlicher Kontakt / Ansprechpartner als der, der im WiM-Backend hinterlegt ist, an den zu startenden Prozess mitgegeben werden.

Parameter Beschreibung Festwert oder Beispiel  
processData.contactPerson Optional Name oder Team des Ansprechpartners Max Mustermann
processData.contactText Optional Parameter des Kontaktmediums von addressTypeCode Die Telefonnummer, Email,
processData.contactType Optional Art des Kontaktmediums nach edi-energy.de: EM E-Mail | FX Telefax | TE Telefon | AJ weiteres Telefon | AL Handy
<?xml version="1.0" encoding="UTF-8"?>
<BdewTemplateInit>
	...
	<WimProcessList>
		<WimProcessData>
			<processData>
				...

				<contactPerson>Marita Muster</contactPerson>
				<contactText>muster@email.de</contactText>
				<contactType>EM</contactType>
				...
			</processData>
		</WimProcessData>
	</WimProcessList>
</BdewTemplateInit>